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/TAM_V3_0/NEMO/OPA_SRC/DYN – NEMO

source: branches/TAM_V3_0/NEMO/OPA_SRC/DYN/dynadv.F90 @ 1884

Last change on this file since 1884 was 1884, checked in by rblod, 14 years ago

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