New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
dynadv.F90 in NEMO/branches/2020/dev_r12527_Gurvan_ShallowWater/src/SWE – NEMO

source: NEMO/branches/2020/dev_r12527_Gurvan_ShallowWater/src/SWE/dynadv.F90 @ 13033

Last change on this file since 13033 was 13005, checked in by gm, 4 years ago

ADE and more options to AM98 config
  • Property svn:keywords set to Id
File size: 8.4 KB
Line 
1MODULE dynadv
2   !!==============================================================================
3   !!                       ***  MODULE  dynadv  ***
4   !! Ocean active tracers:  advection scheme control
5   !!==============================================================================
6   !! History :  1.0  !  2006-11  (G. Madec)  Original code
7   !!            3.3  !  2010-10  (C. Ethe, G. Madec)  reorganisation of initialisation phase
8   !!            3.6  !  2015-05  (N. Ducousso, G. Madec)  add Hollingsworth scheme as an option
9   !!            4.0  !  2017-07  (G. Madec)  add a linear dynamics option
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   dyn_adv      : compute the momentum advection trend
14   !!   dyn_adv_init : control the different options of advection scheme
15   !!----------------------------------------------------------------------
16   USE dom_oce         ! ocean space and time domain
17   USE dynadv_cen2     ! centred flux form advection      (dyn_adv_cen2 routine)
18   USE dynadv_ubs      ! UBS flux form advection          (dyn_adv_ubs  routine)
19   USE dynkeg          ! kinetic energy gradient          (dyn_keg      routine)
20   USE dynzad          ! vertical advection               (dyn_zad      routine)
21   !
22   USE in_out_manager  ! I/O manager
23   USE lib_mpp         ! MPP library
24   USE timing          ! Timing
25
26   IMPLICIT NONE
27   PRIVATE
28
29   PUBLIC dyn_adv       ! routine called by step module
30   PUBLIC dyn_adv_init  ! routine called by opa  module
31 
32   !                                   !!* namdyn_adv namelist *
33   LOGICAL, PUBLIC ::   ln_dynadv_OFF   !: linear dynamics (no momentum advection)
34   LOGICAL, PUBLIC ::   ln_dynadv_vec   !: vector form
35   INTEGER, PUBLIC ::      nn_dynkeg       !: scheme of grad(KE): =0 C2 ; =1 Hollingsworth
36   LOGICAL, PUBLIC ::   ln_dynadv_cen2  !: flux form - 2nd order centered scheme flag
37   LOGICAL, PUBLIC ::   ln_dynadv_ubs   !: flux form - 3rd order UBS scheme flag
38   
39   INTEGER, PUBLIC ::   n_dynadv   !: choice of the formulation and scheme for momentum advection
40   !                               !  associated indices:
41   INTEGER, PUBLIC, PARAMETER ::   np_LIN_dyn = 0   ! no advection: linear dynamics
42   INTEGER, PUBLIC, PARAMETER ::   np_VEC_c2  = 1   ! vector form : 2nd order centered scheme
43   INTEGER, PUBLIC, PARAMETER ::   np_FLX_c2  = 2   ! flux   form : 2nd order centered scheme
44   INTEGER, PUBLIC, PARAMETER ::   np_FLX_ubs = 3   ! flux   form : 3rd order Upstream Biased Scheme
45
46   !!----------------------------------------------------------------------
47   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
48   !! $Id$
49   !! Software governed by the CeCILL license (see ./LICENSE)
50   !!----------------------------------------------------------------------
51CONTAINS
52
53   SUBROUTINE dyn_adv( kt, Kbb, Kmm, puu, pvv, Krhs )
54      !!---------------------------------------------------------------------
55      !!                  ***  ROUTINE dyn_adv  ***
56      !!               
57      !! ** Purpose :   compute the ocean momentum advection trend.
58      !!
59      !! ** Method  : - Update (puu(:,:,:,Krhs),pvv(:,:,:,Krhs)) with the advection term following n_dynadv
60      !!
61      !!      NB: in flux form advection (ln_dynadv_cen2 or ln_dynadv_ubs=T)
62      !!      a metric term is add to the coriolis term while in vector form
63      !!      it is the relative vorticity which is added to coriolis term
64      !!      (see dynvor module).
65      !!----------------------------------------------------------------------
66      INTEGER                             , INTENT( in )  ::  kt               ! ocean time-step index
67      INTEGER                             , INTENT( in )  ::  Kbb, Kmm, Krhs   ! ocean time level indices
68      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::  puu, pvv         ! ocean velocities and RHS of momentum equation
69      !!----------------------------------------------------------------------
70      !
71      IF( ln_timing )   CALL timing_start( 'dyn_adv' )
72      !
73      SELECT CASE( n_dynadv )    !==  compute advection trend and add it to general trend  ==!
74      CASE( np_VEC_c2  )     
75         CALL dyn_keg     ( kt, nn_dynkeg,      Kmm, puu, pvv, Krhs )    ! vector form : horizontal gradient of kinetic energy
76!!an SWE : w = 0
77         CALL dyn_zad     ( kt,                 Kmm, puu, pvv, Krhs )    ! vector form : vertical advection
78      CASE( np_FLX_c2  ) 
79         CALL dyn_adv_cen2( kt,                 Kmm, puu, pvv, Krhs )    ! 2nd order centered scheme
80      CASE( np_FLX_ubs )   
81         CALL dyn_adv_ubs ( kt,            Kbb, Kmm, puu, pvv, Krhs )    ! 3rd order UBS      scheme (UP3)
82      END SELECT
83      !
84      IF( ln_timing )   CALL timing_stop( 'dyn_adv' )
85      !
86   END SUBROUTINE dyn_adv
87
88   
89   SUBROUTINE dyn_adv_init
90      !!---------------------------------------------------------------------
91      !!                  ***  ROUTINE dyn_adv_init  ***
92      !!               
93      !! ** Purpose :   Control the consistency between namelist options for
94      !!              momentum advection formulation & scheme and set n_dynadv
95      !!----------------------------------------------------------------------
96      INTEGER ::   ioptio, ios   ! Local integer
97      !
98      NAMELIST/namdyn_adv/ ln_dynadv_OFF, ln_dynadv_vec, nn_dynkeg, ln_dynadv_cen2, ln_dynadv_ubs
99      !!----------------------------------------------------------------------
100      !
101      IF(lwp) THEN
102         WRITE(numout,*)
103         WRITE(numout,*) 'dyn_adv_init : choice/control of the momentum advection scheme'
104         WRITE(numout,*) '~~~~~~~~~~~~'
105      ENDIF
106      !
107      READ  ( numnam_ref, namdyn_adv, IOSTAT = ios, ERR = 901)
108901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namdyn_adv in reference namelist' )
109      READ  ( numnam_cfg, namdyn_adv, IOSTAT = ios, ERR = 902 )
110902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namdyn_adv in configuration namelist' )
111      IF(lwm) WRITE ( numond, namdyn_adv )
112
113      IF(lwp) THEN                    ! Namelist print
114         WRITE(numout,*) '   Namelist namdyn_adv : chose a advection formulation & scheme for momentum'
115         WRITE(numout,*) '      linear dynamics : no momentum advection          ln_dynadv_OFF  = ', ln_dynadv_OFF
116         WRITE(numout,*) '      Vector form: 2nd order centered scheme           ln_dynadv_vec  = ', ln_dynadv_vec
117!!an45
118         WRITE(numout,*) '         with Hollingsworth scheme (=1) or not (=0,2)      nn_dynkeg  = ', nn_dynkeg
119!!an45
120         WRITE(numout,*) '      flux form: 2nd order centred scheme              ln_dynadv_cen2 = ', ln_dynadv_cen2
121         WRITE(numout,*) '                 3rd order UBS scheme                  ln_dynadv_ubs  = ', ln_dynadv_ubs
122      ENDIF
123
124      ioptio = 0                      ! parameter control and set n_dynadv
125      IF( ln_dynadv_OFF  ) THEN   ;   ioptio = ioptio + 1   ;   n_dynadv = np_LIN_dyn   ;   ENDIF
126      IF( ln_dynadv_vec  ) THEN   ;   ioptio = ioptio + 1   ;   n_dynadv = np_VEC_c2    ;   ENDIF
127      IF( ln_dynadv_cen2 ) THEN   ;   ioptio = ioptio + 1   ;   n_dynadv = np_FLX_c2    ;   ENDIF
128      IF( ln_dynadv_ubs  ) THEN   ;   ioptio = ioptio + 1   ;   n_dynadv = np_FLX_ubs   ;   ENDIF
129
130      IF( ioptio /= 1 )   CALL ctl_stop( 'choose ONE and only ONE advection scheme' )
131!!an45
132      IF( nn_dynkeg /= nkeg_C2 .AND. nn_dynkeg /= nkeg_C2_wpo .AND. nn_dynkeg /= nkeg_HW )   & 
133         &   CALL ctl_stop( 'KEG scheme wrong value of nn_dynkeg' )
134!!an45
135
136      IF(lwp) THEN                    ! Print the choice
137         WRITE(numout,*)
138         SELECT CASE( n_dynadv )
139         CASE( np_LIN_dyn )   ;   WRITE(numout,*) '   ==>>>   linear dynamics : no momentum advection used'
140         CASE( np_VEC_c2  )   ;   WRITE(numout,*) '   ==>>>   vector form : keg + zad + vor is used' 
141            IF( nn_dynkeg == nkeg_C2     )   WRITE(numout,*) '              with Centered standard keg scheme'
142!!an45
143            IF( nn_dynkeg == nkeg_C2_wpo )   WRITE(numout,*) '              with Centered standard keg scheme (wet point only)'
144!!an45
145            IF( nn_dynkeg == nkeg_HW     )   WRITE(numout,*) '              with Hollingsworth keg scheme'
146         CASE( np_FLX_c2  )   ;   WRITE(numout,*) '   ==>>>   flux form   : 2nd order scheme is used'
147         CASE( np_FLX_ubs )   ;   WRITE(numout,*) '   ==>>>   flux form   : UBS       scheme is used'
148         END SELECT
149      ENDIF
150      !
151   END SUBROUTINE dyn_adv_init
152
153  !!======================================================================
154END MODULE dynadv
Note: See TracBrowser for help on using the repository browser.