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/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/DYN/dynadv.F90 @ 9383

Last change on this file since 9383 was 9383, checked in by andmirek, 6 years ago

#2050 fixes and changes

File size: 9.3 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   PRIVATE adv_namelist
31 
32   !                                    !* namdyn_adv namelist *
33   LOGICAL, PUBLIC ::   ln_dynadv_vec   !: vector form flag
34   INTEGER, PUBLIC ::   nn_dynkeg       !: scheme of kinetic energy gradient: =0 C2 ; =1 Hollingsworth
35   LOGICAL, PUBLIC ::   ln_dynadv_cen2  !: flux form - 2nd order centered scheme flag
36   LOGICAL, PUBLIC ::   ln_dynadv_ubs   !: flux form - 3rd order UBS scheme flag
37   LOGICAL, PUBLIC ::   ln_dynzad_zts   !: vertical advection with sub-timestepping (requires vector form)
38   
39   INTEGER ::   nadv   ! choice of the formulation and scheme for the advection
40
41   !! * Substitutions
42#  include "domzgr_substitute.h90"
43#  include "vectopt_loop_substitute.h90"
44   !!----------------------------------------------------------------------
45   !! NEMO/OPA 3.6 , NEMO Consortium (2015)
46   !! $Id$
47   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
48   !!----------------------------------------------------------------------
49CONTAINS
50
51   SUBROUTINE dyn_adv( kt )
52      !!---------------------------------------------------------------------
53      !!                  ***  ROUTINE dyn_adv  ***
54      !!               
55      !! ** Purpose :   compute the ocean momentum advection trend.
56      !!
57      !! ** Method  : - Update (ua,va) with the advection term following nadv
58      !!      NB: in flux form advection (ln_dynadv_cen2 or ln_dynadv_ubs=T)
59      !!      a metric term is add to the coriolis term while in vector form
60      !!      it is the relative vorticity which is added to coriolis term
61      !!      (see dynvor module).
62      !!----------------------------------------------------------------------
63      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
64      !!----------------------------------------------------------------------
65      !
66      IF( nn_timing == 1 )  CALL timing_start('dyn_adv')
67      !
68      SELECT CASE ( nadv )                  ! compute advection trend and add it to general trend
69      CASE ( 0 )     
70                      CALL dyn_keg     ( kt, nn_dynkeg )    ! vector form : horizontal gradient of kinetic energy
71                      CALL dyn_zad     ( kt )               ! vector form : vertical advection
72      CASE ( 1 )     
73                      CALL dyn_keg     ( kt, nn_dynkeg )    ! vector form : horizontal gradient of kinetic energy
74                      CALL dyn_zad_zts ( kt )               ! vector form : vertical advection with sub-timestepping
75      CASE ( 2 ) 
76                      CALL dyn_adv_cen2( kt )               ! 2nd order centered scheme
77      CASE ( 3 )   
78                      CALL dyn_adv_ubs ( kt )               ! 3rd order UBS      scheme
79      !
80      CASE (-1 )                                            ! esopa: test all possibility with control print
81                      CALL dyn_keg     ( kt, nn_dynkeg )
82                      CALL dyn_zad     ( kt )
83                      CALL dyn_adv_cen2( kt )
84                      CALL dyn_adv_ubs ( kt )
85      END SELECT
86      !
87      IF( nn_timing == 1 )  CALL timing_stop('dyn_adv')
88      !
89   END SUBROUTINE dyn_adv
90
91   
92   SUBROUTINE dyn_adv_init
93      !!---------------------------------------------------------------------
94      !!                  ***  ROUTINE dyn_adv_init  ***
95      !!               
96      !! ** Purpose :   Control the consistency between namelist options for
97      !!              momentum advection formulation & scheme and set nadv
98      !!----------------------------------------------------------------------
99      INTEGER ::   ioptio, ios   ! Local integer
100      !
101      NAMELIST/namdyn_adv/ ln_dynadv_vec, nn_dynkeg, ln_dynadv_cen2 , ln_dynadv_ubs, ln_dynzad_zts
102      !!----------------------------------------------------------------------
103      !
104      IF(lwm) THEN
105         REWIND( numnam_ref )              ! Namelist namdyn_adv in reference namelist : Momentum advection scheme
106         READ  ( numnam_ref, namdyn_adv, IOSTAT = ios, ERR = 901)
107901      CONTINUE
108      ENDIF
109      call mpp_bcast(ios)
110      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_adv in reference namelist', lwp )
111      IF(lwm) THEN
112         REWIND( numnam_cfg )              ! Namelist namdyn_adv in configuration namelist : Momentum advection scheme
113         READ  ( numnam_cfg, namdyn_adv, IOSTAT = ios, ERR = 902 )
114902      CONTINUE
115      ENDIF
116      call mpp_bcast(ios)
117      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_adv in configuration namelist', lwp )
118
119      IF(lwm) WRITE ( numond, namdyn_adv )
120
121      CALL adv_namelist()
122
123      IF(lwp) THEN                    ! Namelist print
124         WRITE(numout,*)
125         WRITE(numout,*) 'dyn_adv_init : choice/control of the momentum advection scheme'
126         WRITE(numout,*) '~~~~~~~~~~~'
127         WRITE(numout,*) '       Namelist namdyn_adv : chose a advection formulation & scheme for momentum'
128         WRITE(numout,*) '          Vector/flux form (T/F)                           ln_dynadv_vec  = ', ln_dynadv_vec
129         WRITE(numout,*) '          = 0 standard scheme  ; =1 Hollingsworth scheme   nn_dynkeg      = ', nn_dynkeg
130         WRITE(numout,*) '          2nd order centred advection scheme               ln_dynadv_cen2 = ', ln_dynadv_cen2
131         WRITE(numout,*) '          3rd order UBS advection scheme                   ln_dynadv_ubs  = ', ln_dynadv_ubs
132         WRITE(numout,*) '          Sub timestepping of vertical advection           ln_dynzad_zts  = ', ln_dynzad_zts
133      ENDIF
134
135      ioptio = 0                      ! Parameter control
136      IF( ln_dynadv_vec  )   ioptio = ioptio + 1
137      IF( ln_dynadv_cen2 )   ioptio = ioptio + 1
138      IF( ln_dynadv_ubs  )   ioptio = ioptio + 1
139      IF( lk_esopa       )   ioptio =          1
140
141      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namdyn_adv' )
142      IF( ln_dynzad_zts .AND. .NOT. ln_dynadv_vec )   &
143         CALL ctl_stop( 'Sub timestepping of vertical advection requires vector form; set ln_dynadv_vec = .TRUE.' )
144      IF( nn_dynkeg /= nkeg_C2 .AND. nn_dynkeg /= nkeg_HW )   & 
145         CALL ctl_stop( 'KEG scheme wrong value of nn_dynkeg' )
146
147      !                               ! Set nadv
148      IF( ln_dynadv_vec  )   nadv =  0 
149      IF( ln_dynzad_zts  )   nadv =  1
150      IF( ln_dynadv_cen2 )   nadv =  2
151      IF( ln_dynadv_ubs  )   nadv =  3
152      IF( lk_esopa       )   nadv = -1
153
154      IF(lwp) THEN                    ! Print the choice
155         WRITE(numout,*)
156         IF( nadv ==  0 )   WRITE(numout,*) '         vector form : keg + zad + vor is used' 
157         IF( nadv ==  1 )   WRITE(numout,*) '         vector form : keg + zad_zts + vor is used'
158         IF( nadv ==  0 .OR. nadv ==  1 ) THEN
159            IF( nn_dynkeg == nkeg_C2  )   WRITE(numout,*) 'with Centered standard keg scheme'
160            IF( nn_dynkeg == nkeg_HW  )   WRITE(numout,*) 'with Hollingsworth keg scheme'
161         ENDIF
162         IF( nadv ==  2 )   WRITE(numout,*) '         flux form   : 2nd order scheme is used'
163         IF( nadv ==  3 )   WRITE(numout,*) '         flux form   : UBS       scheme is used'
164         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection formulation'
165      ENDIF
166      !
167   END SUBROUTINE dyn_adv_init
168
169   SUBROUTINE adv_namelist()
170     !!---------------------------------------------------------------------
171     !!                   ***  ROUTINE adv_namelist  ***
172     !!                     
173     !! ** Purpose :   Broadcast namelist variables read by procesor lwm
174     !!
175     !! ** Method  :   use lib_mpp
176     !!----------------------------------------------------------------------
177#if defined key_mpp_mpi
178      CALL mpp_bcast(ln_dynadv_vec)
179      CALL mpp_bcast(nn_dynkeg)
180      CALL mpp_bcast(ln_dynadv_cen2)
181      CALL mpp_bcast(ln_dynadv_ubs)
182      CALL mpp_bcast(ln_dynzad_zts)
183#endif
184   END SUBROUTINE adv_namelist
185  !!======================================================================
186END MODULE dynadv
Note: See TracBrowser for help on using the repository browser.