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/2011/DEV_r2739_STFC_dCSE/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

source: branches/2011/DEV_r2739_STFC_dCSE/NEMOGCM/NEMO/OPA_SRC/DYN/dynadv.F90 @ 4460

Last change on this file since 4460 was 3211, checked in by spickles2, 12 years ago

Stephen Pickles, 11 Dec 2011

Commit to bring the rest of the DCSE NEMO development branch
in line with the latest development version. This includes
array index re-ordering of all OPA_SRC/.
  • Property svn:keywords set to Id
File size: 6.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   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   dyn_adv      : compute the momentum advection trend
12   !!   dyn_adv_init : control the different options of advection scheme
13   !!----------------------------------------------------------------------
14   USE dom_oce         ! ocean space and time domain
15   USE dynadv_cen2     ! centred flux form advection      (dyn_adv_cen2 routine)
16   USE dynadv_ubs      ! UBS flux form advection          (dyn_adv_ubs  routine)
17   USE dynkeg          ! kinetic energy gradient          (dyn_keg      routine)
18   USE dynzad          ! vertical advection               (dyn_zad      routine)
19   USE in_out_manager  ! I/O manager
20   USE lib_mpp         ! MPP library
21
22   IMPLICIT NONE
23   PRIVATE
24
25   PUBLIC dyn_adv       ! routine called by step module
26   PUBLIC dyn_adv_init  ! routine called by opa module
27 
28   LOGICAL, PUBLIC ::   ln_dynadv_vec  = .TRUE.    !: vector form flag
29   LOGICAL, PUBLIC ::   ln_dynadv_cen2 = .FALSE.   !: flux form - 2nd order centered scheme flag
30   LOGICAL, PUBLIC ::   ln_dynadv_ubs  = .FALSE.   !: flux form - 3rd order UBS scheme flag
31   
32   INTEGER ::   nadv   ! choice of the formulation and scheme for the advection
33
34   !! * Control permutation of array indices
35#  include "dom_oce_ftrans.h90"
36
37   !! * Substitutions
38#  include "domzgr_substitute.h90"
39#  include "vectopt_loop_substitute.h90"
40   !!----------------------------------------------------------------------
41   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
42   !! $Id$
43   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
44   !!----------------------------------------------------------------------
45CONTAINS
46
47   SUBROUTINE dyn_adv( kt )
48      !!---------------------------------------------------------------------
49      !!                  ***  ROUTINE dyn_adv  ***
50      !!               
51      !! ** Purpose :   compute the ocean momentum advection trend.
52      !!
53      !! ** Method  : - Update (ua,va) with the advection term following nadv
54      !!      NB: in flux form advection (ln_dynadv_cen2 or ln_dynadv_ubs=T)
55      !!      a metric term is add to the coriolis term while in vector form
56      !!      it is the relative vorticity which is added to coriolis term
57      !!      (see dynvor module).
58      !!----------------------------------------------------------------------
59      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
60      !!----------------------------------------------------------------------
61      !
62      SELECT CASE ( nadv )                  ! compute advection trend and add it to general trend
63      CASE ( 0 )     
64                      CALL dyn_keg     ( kt )    ! vector form : horizontal gradient of kinetic energy
65                      CALL dyn_zad     ( kt )    ! vector form : vertical advection
66      CASE ( 1 ) 
67                      CALL dyn_adv_cen2( kt )    ! 2nd order centered scheme
68      CASE ( 2 )   
69                      CALL dyn_adv_ubs ( kt )    ! 3rd order UBS      scheme
70      !
71      CASE (-1 )                                 ! esopa: test all possibility with control print
72                      CALL dyn_keg     ( kt )
73                      CALL dyn_zad     ( kt )
74                      CALL dyn_adv_cen2( kt )
75                      CALL dyn_adv_ubs ( kt )
76      END SELECT
77      !
78   END SUBROUTINE dyn_adv
79
80   
81   SUBROUTINE dyn_adv_init
82      !!---------------------------------------------------------------------
83      !!                  ***  ROUTINE dyn_adv_init  ***
84      !!               
85      !! ** Purpose :   Control the consistency between namelist options for
86      !!              momentum advection formulation & scheme and set nadv
87      !!----------------------------------------------------------------------
88      INTEGER ::   ioptio
89      !!
90      NAMELIST/namdyn_adv/ ln_dynadv_vec, ln_dynadv_cen2 , ln_dynadv_ubs
91      !!----------------------------------------------------------------------
92
93      REWIND ( numnam )               ! Read Namelist namdyn_adv : momentum advection scheme
94      READ   ( numnam, namdyn_adv )
95
96      IF(lwp) THEN                    ! Namelist print
97         WRITE(numout,*)
98         WRITE(numout,*) 'dyn_adv_init : choice/control of the momentum advection scheme'
99         WRITE(numout,*) '~~~~~~~~~~~'
100         WRITE(numout,*) '       Namelist namdyn_adv : chose a advection formulation & scheme for momentum'
101         WRITE(numout,*) '          Vector/flux form (T/F)             ln_dynadv_vec  = ', ln_dynadv_vec
102         WRITE(numout,*) '          2nd order centred advection scheme ln_dynadv_cen2 = ', ln_dynadv_cen2
103         WRITE(numout,*) '          3rd order UBS advection scheme     ln_dynadv_ubs  = ', ln_dynadv_ubs
104      ENDIF
105
106      ioptio = 0                      ! Parameter control
107      IF( ln_dynadv_vec  )   ioptio = ioptio + 1
108      IF( ln_dynadv_cen2 )   ioptio = ioptio + 1
109      IF( ln_dynadv_ubs  )   ioptio = ioptio + 1
110      IF( lk_esopa       )   ioptio =          1
111
112      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namdyn_adv' )
113
114      !                               ! Set nadv
115      IF( ln_dynadv_vec  )   nadv =  0 
116      IF( ln_dynadv_cen2 )   nadv =  1
117      IF( ln_dynadv_ubs  )   nadv =  2
118      IF( lk_esopa       )   nadv = -1
119
120      IF(lwp) THEN                    ! Print the choice
121         WRITE(numout,*)
122         IF( nadv ==  0 )   WRITE(numout,*) '         vector form : keg + zad + vor is used'
123         IF( nadv ==  1 )   WRITE(numout,*) '         flux form   : 2nd order scheme is used'
124         IF( nadv ==  2 )   WRITE(numout,*) '         flux form   : UBS       scheme is used'
125         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection formulation'
126      ENDIF
127      !
128   END SUBROUTINE dyn_adv_init
129
130  !!======================================================================
131END MODULE dynadv
Note: See TracBrowser for help on using the repository browser.