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

source: trunk/NEMOGCM/NEMO/OPA_SRC/DYN/dynadv.F90 @ 3294

Last change on this file since 3294 was 3294, checked in by rblod, 12 years ago

Merge of 3.4beta into the trunk
  • Property svn:keywords set to Id
File size: 6.4 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   USE timing          ! Timing
22
23   IMPLICIT NONE
24   PRIVATE
25
26   PUBLIC dyn_adv       ! routine called by step module
27   PUBLIC dyn_adv_init  ! routine called by opa module
28 
29   LOGICAL, PUBLIC ::   ln_dynadv_vec  = .TRUE.    !: vector form flag
30   LOGICAL, PUBLIC ::   ln_dynadv_cen2 = .FALSE.   !: flux form - 2nd order centered scheme flag
31   LOGICAL, PUBLIC ::   ln_dynadv_ubs  = .FALSE.   !: flux form - 3rd order UBS scheme flag
32   
33   INTEGER ::   nadv   ! choice of the formulation and scheme for the advection
34
35   !! * Substitutions
36#  include "domzgr_substitute.h90"
37#  include "vectopt_loop_substitute.h90"
38   !!----------------------------------------------------------------------
39   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
40   !! $Id$
41   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
42   !!----------------------------------------------------------------------
43CONTAINS
44
45   SUBROUTINE dyn_adv( kt )
46      !!---------------------------------------------------------------------
47      !!                  ***  ROUTINE dyn_adv  ***
48      !!               
49      !! ** Purpose :   compute the ocean momentum advection trend.
50      !!
51      !! ** Method  : - Update (ua,va) with the advection term following nadv
52      !!      NB: in flux form advection (ln_dynadv_cen2 or ln_dynadv_ubs=T)
53      !!      a metric term is add to the coriolis term while in vector form
54      !!      it is the relative vorticity which is added to coriolis term
55      !!      (see dynvor module).
56      !!----------------------------------------------------------------------
57      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
58      !!----------------------------------------------------------------------
59      !
60      IF( nn_timing == 1 )  CALL timing_start('dyn_adv')
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      IF( nn_timing == 1 )  CALL timing_stop('dyn_adv')
79      !
80   END SUBROUTINE dyn_adv
81
82   
83   SUBROUTINE dyn_adv_init
84      !!---------------------------------------------------------------------
85      !!                  ***  ROUTINE dyn_adv_init  ***
86      !!               
87      !! ** Purpose :   Control the consistency between namelist options for
88      !!              momentum advection formulation & scheme and set nadv
89      !!----------------------------------------------------------------------
90      INTEGER ::   ioptio
91      !!
92      NAMELIST/namdyn_adv/ ln_dynadv_vec, ln_dynadv_cen2 , ln_dynadv_ubs
93      !!----------------------------------------------------------------------
94
95      REWIND ( numnam )               ! Read Namelist namdyn_adv : momentum advection scheme
96      READ   ( numnam, namdyn_adv )
97
98      IF(lwp) THEN                    ! Namelist print
99         WRITE(numout,*)
100         WRITE(numout,*) 'dyn_adv_init : choice/control of the momentum advection scheme'
101         WRITE(numout,*) '~~~~~~~~~~~'
102         WRITE(numout,*) '       Namelist namdyn_adv : chose a advection formulation & scheme for momentum'
103         WRITE(numout,*) '          Vector/flux form (T/F)             ln_dynadv_vec  = ', ln_dynadv_vec
104         WRITE(numout,*) '          2nd order centred advection scheme ln_dynadv_cen2 = ', ln_dynadv_cen2
105         WRITE(numout,*) '          3rd order UBS advection scheme     ln_dynadv_ubs  = ', ln_dynadv_ubs
106      ENDIF
107
108      ioptio = 0                      ! Parameter control
109      IF( ln_dynadv_vec  )   ioptio = ioptio + 1
110      IF( ln_dynadv_cen2 )   ioptio = ioptio + 1
111      IF( ln_dynadv_ubs  )   ioptio = ioptio + 1
112      IF( lk_esopa       )   ioptio =          1
113
114      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namdyn_adv' )
115
116      !                               ! Set nadv
117      IF( ln_dynadv_vec  )   nadv =  0 
118      IF( ln_dynadv_cen2 )   nadv =  1
119      IF( ln_dynadv_ubs  )   nadv =  2
120      IF( lk_esopa       )   nadv = -1
121
122      IF(lwp) THEN                    ! Print the choice
123         WRITE(numout,*)
124         IF( nadv ==  0 )   WRITE(numout,*) '         vector form : keg + zad + vor is used'
125         IF( nadv ==  1 )   WRITE(numout,*) '         flux form   : 2nd order scheme is used'
126         IF( nadv ==  2 )   WRITE(numout,*) '         flux form   : UBS       scheme is used'
127         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection formulation'
128      ENDIF
129      !
130   END SUBROUTINE dyn_adv_init
131
132  !!======================================================================
133END MODULE dynadv
Note: See TracBrowser for help on using the repository browser.