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/2015/dev_r5836_NOC3_vvl_by_default/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/2015/dev_r5836_NOC3_vvl_by_default/NEMOGCM/NEMO/OPA_SRC/DYN/dynadv.F90 @ 6004

Last change on this file since 6004 was 6004, checked in by gm, 8 years ago

#1613: vvl by default, step III: Merge with the trunk (free surface simplification) (see wiki)

  • Property svn:keywords set to Id
File size: 7.9 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   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
12   !!   dyn_adv      : compute the momentum advection trend
13   !!   dyn_adv_init : control the different options of advection scheme
14   !!----------------------------------------------------------------------
15   USE dom_oce         ! ocean space and time domain
16   USE dynadv_cen2     ! centred flux form advection      (dyn_adv_cen2 routine)
17   USE dynadv_ubs      ! UBS flux form advection          (dyn_adv_ubs  routine)
18   USE dynkeg          ! kinetic energy gradient          (dyn_keg      routine)
19   USE dynzad          ! vertical advection               (dyn_zad      routine)
20   !
21   USE in_out_manager  ! I/O manager
22   USE lib_mpp         ! MPP library
23   USE timing          ! Timing
24
25   IMPLICIT NONE
26   PRIVATE
27
28   PUBLIC dyn_adv       ! routine called by step module
29   PUBLIC dyn_adv_init  ! routine called by opa  module
30 
31   !                                    !* namdyn_adv namelist *
32   LOGICAL, PUBLIC ::   ln_dynadv_vec   !: vector form flag
33   INTEGER, PUBLIC ::   nn_dynkeg       !: scheme of kinetic energy gradient: =0 C2 ; =1 Hollingsworth
34   LOGICAL, PUBLIC ::   ln_dynadv_cen2  !: flux form - 2nd order centered scheme flag
35   LOGICAL, PUBLIC ::   ln_dynadv_ubs   !: flux form - 3rd order UBS scheme flag
36   LOGICAL, PUBLIC ::   ln_dynzad_zts   !: vertical advection with sub-timestepping (requires vector form)
37   
38   INTEGER ::   nadv   ! choice of the formulation and scheme for the advection
39
40   !! * Substitutions
41#  include "vectopt_loop_substitute.h90"
42   !!----------------------------------------------------------------------
43   !! NEMO/OPA 3.6 , NEMO Consortium (2015)
44   !! $Id$
45   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
46   !!----------------------------------------------------------------------
47CONTAINS
48
49   SUBROUTINE dyn_adv( kt )
50      !!---------------------------------------------------------------------
51      !!                  ***  ROUTINE dyn_adv  ***
52      !!               
53      !! ** Purpose :   compute the ocean momentum advection trend.
54      !!
55      !! ** Method  : - Update (ua,va) with the advection term following nadv
56      !!      NB: in flux form advection (ln_dynadv_cen2 or ln_dynadv_ubs=T)
57      !!      a metric term is add to the coriolis term while in vector form
58      !!      it is the relative vorticity which is added to coriolis term
59      !!      (see dynvor module).
60      !!----------------------------------------------------------------------
61      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
62      !!----------------------------------------------------------------------
63      !
64      IF( nn_timing == 1 )  CALL timing_start('dyn_adv')
65      !
66      SELECT CASE ( nadv )                  ! compute advection trend and add it to general trend
67      CASE ( 0 )     
68                      CALL dyn_keg     ( kt, nn_dynkeg )    ! vector form : horizontal gradient of kinetic energy
69                      CALL dyn_zad     ( kt )               ! vector form : vertical advection
70      CASE ( 1 )     
71                      CALL dyn_keg     ( kt, nn_dynkeg )    ! vector form : horizontal gradient of kinetic energy
72                      CALL dyn_zad_zts ( kt )               ! vector form : vertical advection with sub-timestepping
73      CASE ( 2 ) 
74                      CALL dyn_adv_cen2( kt )               ! 2nd order centered scheme
75      CASE ( 3 )   
76                      CALL dyn_adv_ubs ( kt )               ! 3rd order UBS      scheme
77      END SELECT
78      !
79      IF( nn_timing == 1 )  CALL timing_stop('dyn_adv')
80      !
81   END SUBROUTINE dyn_adv
82
83   
84   SUBROUTINE dyn_adv_init
85      !!---------------------------------------------------------------------
86      !!                  ***  ROUTINE dyn_adv_init  ***
87      !!               
88      !! ** Purpose :   Control the consistency between namelist options for
89      !!              momentum advection formulation & scheme and set nadv
90      !!----------------------------------------------------------------------
91      INTEGER ::   ioptio, ios   ! Local integer
92      !
93      NAMELIST/namdyn_adv/ ln_dynadv_vec, nn_dynkeg, ln_dynadv_cen2 , ln_dynadv_ubs, ln_dynzad_zts
94      !!----------------------------------------------------------------------
95      !
96      REWIND( numnam_ref )              ! Namelist namdyn_adv in reference namelist : Momentum advection scheme
97      READ  ( numnam_ref, namdyn_adv, IOSTAT = ios, ERR = 901)
98901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_adv in reference namelist', lwp )
99      !
100      REWIND( numnam_cfg )              ! Namelist namdyn_adv in configuration namelist : Momentum advection scheme
101      READ  ( numnam_cfg, namdyn_adv, IOSTAT = ios, ERR = 902 )
102902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_adv in configuration namelist', lwp )
103      IF(lwm) WRITE ( numond, namdyn_adv )
104
105      IF(lwp) THEN                    ! Namelist print
106         WRITE(numout,*)
107         WRITE(numout,*) 'dyn_adv_init : choice/control of the momentum advection scheme'
108         WRITE(numout,*) '~~~~~~~~~~~'
109         WRITE(numout,*) '       Namelist namdyn_adv : chose a advection formulation & scheme for momentum'
110         WRITE(numout,*) '          Vector/flux form (T/F)                           ln_dynadv_vec  = ', ln_dynadv_vec
111         WRITE(numout,*) '          = 0 standard scheme  ; =1 Hollingsworth scheme   nn_dynkeg      = ', nn_dynkeg
112         WRITE(numout,*) '          2nd order centred advection scheme               ln_dynadv_cen2 = ', ln_dynadv_cen2
113         WRITE(numout,*) '          3rd order UBS advection scheme                   ln_dynadv_ubs  = ', ln_dynadv_ubs
114         WRITE(numout,*) '          Sub timestepping of vertical advection           ln_dynzad_zts  = ', ln_dynzad_zts
115      ENDIF
116
117      ioptio = 0                      ! Parameter control
118      IF( ln_dynadv_vec  )   ioptio = ioptio + 1
119      IF( ln_dynadv_cen2 )   ioptio = ioptio + 1
120      IF( ln_dynadv_ubs  )   ioptio = ioptio + 1
121
122      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namdyn_adv' )
123      IF( ln_dynzad_zts .AND. .NOT. ln_dynadv_vec )   &
124         CALL ctl_stop( 'Sub timestepping of vertical advection requires vector form; set ln_dynadv_vec = .TRUE.' )
125      IF( nn_dynkeg /= nkeg_C2 .AND. nn_dynkeg /= nkeg_HW )   & 
126         CALL ctl_stop( 'KEG scheme wrong value of nn_dynkeg' )
127
128      !                               ! Set nadv
129      IF( ln_dynadv_vec  )   nadv =  0 
130      IF( ln_dynzad_zts  )   nadv =  1
131      IF( ln_dynadv_cen2 )   nadv =  2
132      IF( ln_dynadv_ubs  )   nadv =  3
133
134      IF(lwp) THEN                    ! Print the choice
135         WRITE(numout,*)
136         IF( nadv ==  0 )   WRITE(numout,*) '         vector form : keg + zad + vor is used' 
137         IF( nadv ==  1 )   WRITE(numout,*) '         vector form : keg + zad_zts + vor is used'
138         IF( nadv ==  0 .OR. nadv ==  1 ) THEN
139            IF( nn_dynkeg == nkeg_C2  )   WRITE(numout,*) 'with Centered standard keg scheme'
140            IF( nn_dynkeg == nkeg_HW  )   WRITE(numout,*) 'with Hollingsworth keg scheme'
141         ENDIF
142         IF( nadv ==  2 )   WRITE(numout,*) '         flux form   : 2nd order scheme is used'
143         IF( nadv ==  3 )   WRITE(numout,*) '         flux form   : UBS       scheme is used'
144      ENDIF
145      !
146   END SUBROUTINE dyn_adv_init
147
148  !!======================================================================
149END MODULE dynadv
Note: See TracBrowser for help on using the repository browser.