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 branches/2017/dev_merge_2017/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/2017/dev_merge_2017/NEMOGCM/NEMO/OPA_SRC/DYN/dynadv.F90 @ 9168

Last change on this file since 9168 was 9168, checked in by gm, 6 years ago

dev_merge_2017: OPA_SRC & CONFIG: remove useless warning when reading namelist_cfg

  • Property svn:keywords set to Id
File size: 8.0 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_NONE  !: 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   !! * Substitutions
47#  include "vectopt_loop_substitute.h90"
48   !!----------------------------------------------------------------------
49   !! NEMO/OPA 4.0 , NEMO Consortium (2017)
50   !! $Id$
51   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
52   !!----------------------------------------------------------------------
53CONTAINS
54
55   SUBROUTINE dyn_adv( kt )
56      !!---------------------------------------------------------------------
57      !!                  ***  ROUTINE dyn_adv  ***
58      !!               
59      !! ** Purpose :   compute the ocean momentum advection trend.
60      !!
61      !! ** Method  : - Update (ua,va) with the advection term following n_dynadv
62      !!
63      !!      NB: in flux form advection (ln_dynadv_cen2 or ln_dynadv_ubs=T)
64      !!      a metric term is add to the coriolis term while in vector form
65      !!      it is the relative vorticity which is added to coriolis term
66      !!      (see dynvor module).
67      !!----------------------------------------------------------------------
68      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
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 )    ! vector form : horizontal gradient of kinetic energy
76         CALL dyn_zad     ( kt )               ! vector form : vertical advection
77      CASE( np_FLX_c2  ) 
78         CALL dyn_adv_cen2( kt )               ! 2nd order centered scheme
79      CASE( np_FLX_ubs )   
80         CALL dyn_adv_ubs ( kt )               ! 3rd order UBS      scheme (UP3)
81      END SELECT
82      !
83      IF( ln_timing )   CALL timing_stop( 'dyn_adv' )
84      !
85   END SUBROUTINE dyn_adv
86
87   
88   SUBROUTINE dyn_adv_init
89      !!---------------------------------------------------------------------
90      !!                  ***  ROUTINE dyn_adv_init  ***
91      !!               
92      !! ** Purpose :   Control the consistency between namelist options for
93      !!              momentum advection formulation & scheme and set n_dynadv
94      !!----------------------------------------------------------------------
95      INTEGER ::   ioptio, ios   ! Local integer
96      !
97      NAMELIST/namdyn_adv/ ln_dynadv_NONE, ln_dynadv_vec, nn_dynkeg, ln_dynadv_cen2, ln_dynadv_ubs
98      !!----------------------------------------------------------------------
99      !
100      REWIND( numnam_ref )              ! Namelist namdyn_adv in reference namelist : Momentum advection scheme
101      READ  ( numnam_ref, namdyn_adv, IOSTAT = ios, ERR = 901)
102901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namdyn_adv in reference namelist', lwp )
103      REWIND( numnam_cfg )              ! Namelist namdyn_adv in configuration namelist : Momentum advection scheme
104      READ  ( numnam_cfg, namdyn_adv, IOSTAT = ios, ERR = 902 )
105902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namdyn_adv in configuration namelist', lwp )
106      IF(lwm) WRITE ( numond, namdyn_adv )
107
108      IF(lwp) THEN                    ! Namelist print
109         WRITE(numout,*)
110         WRITE(numout,*) 'dyn_adv_init : choice/control of the momentum advection scheme'
111         WRITE(numout,*) '~~~~~~~~~~~~'
112         WRITE(numout,*) '   Namelist namdyn_adv : chose a advection formulation & scheme for momentum'
113         WRITE(numout,*) '      linear dynamics : no momentum advection          ln_dynadv_NONE = ', ln_dynadv_NONE
114         WRITE(numout,*) '      Vector form: 2nd order centered scheme           ln_dynadv_vec  = ', ln_dynadv_vec
115         WRITE(numout,*) '         with Hollingsworth scheme (=1) or not (=0)       nn_dynkeg   = ', nn_dynkeg
116         WRITE(numout,*) '      flux form: 2nd order centred scheme              ln_dynadv_cen2 = ', ln_dynadv_cen2
117         WRITE(numout,*) '                 3rd order UBS scheme                  ln_dynadv_ubs  = ', ln_dynadv_ubs
118      ENDIF
119
120      ioptio = 0                      ! parameter control and set n_dynadv
121      IF( ln_dynadv_NONE ) THEN   ;   ioptio = ioptio + 1   ;   n_dynadv = np_LIN_dyn   ;   ENDIF
122      IF( ln_dynadv_vec  ) THEN   ;   ioptio = ioptio + 1   ;   n_dynadv = np_VEC_c2    ;   ENDIF
123      IF( ln_dynadv_cen2 ) THEN   ;   ioptio = ioptio + 1   ;   n_dynadv = np_FLX_c2    ;   ENDIF
124      IF( ln_dynadv_ubs  ) THEN   ;   ioptio = ioptio + 1   ;   n_dynadv = np_FLX_ubs   ;   ENDIF
125
126      IF( ioptio /= 1 )   CALL ctl_stop( 'choose ONE and only ONE advection scheme' )
127      IF( nn_dynkeg /= nkeg_C2 .AND. nn_dynkeg /= nkeg_HW )   CALL ctl_stop( 'KEG scheme wrong value of nn_dynkeg' )
128
129
130      IF(lwp) THEN                    ! Print the choice
131         WRITE(numout,*)
132         SELECT CASE( n_dynadv )
133         CASE( np_LIN_dyn )   ;   WRITE(numout,*) '      ===>>   linear dynamics : no momentum advection used'
134         CASE( np_VEC_c2  )   ;   WRITE(numout,*) '      ===>>   vector form : keg + zad + vor is used' 
135            IF( nn_dynkeg == nkeg_C2  )   WRITE(numout,*) '              with Centered standard keg scheme'
136            IF( nn_dynkeg == nkeg_HW  )   WRITE(numout,*) '              with Hollingsworth keg scheme'
137         CASE( np_FLX_c2  )   ;   WRITE(numout,*) '      ===>>   flux form   : 2nd order scheme is used'
138         CASE( np_FLX_ubs )   ;   WRITE(numout,*) '      ===>>   flux form   : UBS       scheme is used'
139         END SELECT
140      ENDIF
141      !
142   END SUBROUTINE dyn_adv_init
143
144  !!======================================================================
145END MODULE dynadv
Note: See TracBrowser for help on using the repository browser.