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.
traadv.F90 in trunk/NEMO/OPA_SRC/TRA – NEMO

source: trunk/NEMO/OPA_SRC/TRA/traadv.F90 @ 584

Last change on this file since 584 was 541, checked in by opalod, 18 years ago

nemo_v1_bugfix_065:RB: move namelist declaration for compatibility with Agrif
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.0 KB
Line 
1MODULE traadv
2   !!==============================================================================
3   !!                       ***  MODULE  traadv  ***
4   !! Ocean active tracers:  advection trend
5   !!==============================================================================
6   !! History :  9.0  !  05-11  (G. Madec)  Original code
7   !!----------------------------------------------------------------------
8
9   !!----------------------------------------------------------------------
10   !!   tra_adv      : compute ocean tracer advection trend
11   !!   tra_adv_ctl  : control the different options of advection scheme
12   !!----------------------------------------------------------------------
13   USE oce             ! ocean dynamics and active tracers
14   USE dom_oce         ! ocean space and time domain
15   USE traadv_cen2     ! 2nd order centered scheme (tra_adv_cen2   routine)
16   USE traadv_cen2_jki ! 2nd order centered scheme (tra_adv_cen2   routine)
17   USE traadv_tvd      ! TVD    scheme             (tra_adv_tvd    routine)
18   USE traadv_muscl    ! MUSCL  scheme             (tra_adv_muscl  routine)
19   USE traadv_muscl2   ! MUSCL2 scheme             (tra_adv_muscl2 routine)
20   USE traadv_ubs      ! UBS    scheme             (tra_adv_ubs    routine)
21   USE traadv_eiv      ! eddy induced velocity     (tra_adv_eiv    routine)
22   USE trabbl          ! tracers: bottom boundary layer
23   USE ldftra_oce      ! lateral diffusion coefficient on tracers
24   USE in_out_manager  ! I/O manager
25   USE prtctl          ! Print control
26
27   IMPLICIT NONE
28   PRIVATE
29
30   PUBLIC   tra_adv    ! routine called by step module
31 
32   !!* Namelist nam_traadv
33   LOGICAL, PUBLIC ::   ln_traadv_cen2   = .TRUE.       ! 2nd order centered scheme flag
34   LOGICAL, PUBLIC ::   ln_traadv_tvd    = .FALSE.      ! TVD scheme flag
35   LOGICAL, PUBLIC ::   ln_traadv_muscl  = .FALSE.      ! MUSCL scheme flag
36   LOGICAL, PUBLIC ::   ln_traadv_muscl2 = .FALSE.      ! MUSCL2 scheme flag
37   LOGICAL, PUBLIC ::   ln_traadv_ubs    = .FALSE.      ! UBS scheme flag
38
39   INTEGER ::   nadv   ! choice of the type of advection scheme
40
41   !! * Substitutions
42#  include "domzgr_substitute.h90"
43#  include "vectopt_loop_substitute.h90"
44   !!----------------------------------------------------------------------
45   !!   OPA 9.0 , LOCEAN-IPSL (2006)
46   !! $Header$
47   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
48   !!----------------------------------------------------------------------
49
50CONTAINS
51
52   SUBROUTINE tra_adv( kt )
53      !!----------------------------------------------------------------------
54      !!                  ***  ROUTINE tra_adv  ***
55      !!
56      !! ** Purpose :   compute the ocean tracer advection trend.
57      !!
58      !! ** Method  : - Update (ua,va) with the advection term following nadv
59      !!----------------------------------------------------------------------
60#if ( defined key_trabbl_adv || defined key_traldf_eiv )
61      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zun, zvn, zwn   ! effective velocity
62#else
63      USE oce, ONLY :                       zun => un       ! the effective velocity is the
64      USE oce, ONLY :                       zvn => vn       ! Eulerian velocity
65      USE oce, ONLY :                       zwn => wn       !
66#endif
67      !!
68      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
69      !!----------------------------------------------------------------------
70
71      IF( kt == nit000 )   CALL tra_adv_ctl          ! initialisation & control of options
72
73#if defined key_trabbl_adv
74      zun(:,:,:) = un(:,:,:) - u_bbl(:,:,:)          ! add the bbl velocity
75      zvn(:,:,:) = vn(:,:,:) - v_bbl(:,:,:)
76      zwn(:,:,:) = wn(:,:,:) + w_bbl(:,:,:)
77#endif
78      IF( lk_traldf_eiv ) THEN                       ! commpute and add the eiv velocity
79         IF( .NOT. lk_trabbl_adv ) THEN
80            zun(:,:,:) = un(:,:,:)
81            zvn(:,:,:) = vn(:,:,:)
82            zwn(:,:,:) = wn(:,:,:)
83         ENDIF
84         CALL tra_adv_eiv( kt, zun, zvn, zwn ) 
85      ENDIF
86
87      SELECT CASE ( nadv )                           ! compute advection trend and add it to general trend
88      CASE ( 0 )   ;   CALL tra_adv_cen2    ( kt, zun, zvn, zwn )    ! 2nd order centered scheme k-j-i loops
89      CASE ( 1 )   ;   CALL tra_adv_cen2_jki( kt, zun, zvn, zwn )    ! 2nd order centered scheme
90      CASE ( 2 )   ;   CALL tra_adv_tvd     ( kt, zun, zvn, zwn )    ! TVD    scheme
91      CASE ( 3 )   ;   CALL tra_adv_muscl   ( kt, zun, zvn, zwn )    ! MUSCL  scheme
92      CASE ( 4 )   ;   CALL tra_adv_muscl2  ( kt, zun, zvn, zwn )    ! MUSCL2 scheme
93      CASE ( 5 )   ;   CALL tra_adv_ubs     ( kt, zun, zvn, zwn )    ! UBS    scheme
94      !
95      CASE (-1 )                                                     ! esopa: test all possibility with control print
96         ;             CALL tra_adv_cen2    ( kt, zun, zvn, zwn )
97         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv0 - Ta: ', mask1=tmask,               &
98            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
99         ;             CALL tra_adv_cen2_jki( kt, zun, zvn, zwn )
100         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv1 - Ta: ', mask1=tmask,               &
101            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
102         ;             CALL tra_adv_tvd     ( kt, zun, zvn, zwn )
103         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv2 - Ta: ', mask1=tmask,               &
104            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
105         ;             CALL tra_adv_muscl   ( kt, zun, zvn, zwn )
106         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv3 - Ta: ', mask1=tmask,               &
107            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
108         ;             CALL tra_adv_muscl2  ( kt, zun, zvn, zwn )
109         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv4 - Ta: ', mask1=tmask,               &
110            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
111         ;             CALL tra_adv_ubs     ( kt, zun, zvn, zwn )
112         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv5 - Ta: ', mask1=tmask,               &
113            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
114      END SELECT
115      !                                              ! print mean trends (used for debugging)
116      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ta, clinfo1=' adv  - Ta: ', mask1=tmask,               &
117         &                       tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
118      !
119   END SUBROUTINE tra_adv
120
121
122   SUBROUTINE tra_adv_ctl
123      !!---------------------------------------------------------------------
124      !!                  ***  ROUTINE tra_adv_ctl  ***
125      !!               
126      !! ** Purpose :   Control the consistency between namelist options for
127      !!              tracer advection schemes and set nadv
128      !!----------------------------------------------------------------------
129      INTEGER ::   ioptio
130
131      NAMELIST/nam_traadv/ ln_traadv_cen2 , ln_traadv_tvd,   &
132         &                 ln_traadv_muscl, ln_traadv_muscl2, ln_traadv_ubs
133      !!----------------------------------------------------------------------
134
135      REWIND ( numnam )               ! Read Namelist nam_traadv : tracer advection scheme
136      READ   ( numnam, nam_traadv )
137
138      IF(lwp) THEN                    ! Namelist print
139         WRITE(numout,*)
140         WRITE(numout,*) 'tra_adv_ctl : choice/control of the tracer advection scheme'
141         WRITE(numout,*) '~~~~~~~~~~~'
142         WRITE(numout,*) '       Namelist nam_traadv : chose a advection scheme for tracers'
143         WRITE(numout,*) '          2nd order advection scheme     ln_traadv_cen2   = ', ln_traadv_cen2
144         WRITE(numout,*) '          TVD advection scheme           ln_traadv_tvd    = ', ln_traadv_tvd
145         WRITE(numout,*) '          MUSCL  advection scheme        ln_traadv_muscl  = ', ln_traadv_muscl
146         WRITE(numout,*) '          MUSCL2 advection scheme        ln_traadv_muscl2 = ', ln_traadv_muscl2
147         WRITE(numout,*) '          UBS    advection scheme        ln_traadv_ubs    = ', ln_traadv_ubs
148      ENDIF
149
150      ioptio = 0                      ! Parameter control
151      IF( ln_traadv_cen2   )   ioptio = ioptio + 1
152      IF( ln_traadv_tvd    )   ioptio = ioptio + 1
153      IF( ln_traadv_muscl  )   ioptio = ioptio + 1
154      IF( ln_traadv_muscl2 )   ioptio = ioptio + 1
155      IF( ln_traadv_ubs    )   ioptio = ioptio + 1
156      IF( lk_esopa         )   ioptio =          1
157
158      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist nam_traadv' )
159
160      IF( n_cla == 1 .AND. .NOT. ln_traadv_cen2 )   &
161         &                CALL ctl_stop( 'cross-land advection only with 2nd order advection scheme' )
162
163      !                              ! Set nadv
164      IF( ln_traadv_cen2   )   nadv =  0
165#if defined key_mpp_omp
166      IF( ln_traadv_cen2   )   nadv =  1
167#endif
168      IF( ln_traadv_tvd    )   nadv =  2
169      IF( ln_traadv_muscl  )   nadv =  3
170      IF( ln_traadv_muscl2 )   nadv =  4
171      IF( ln_traadv_ubs    )   nadv =  5
172      IF( lk_esopa         )   nadv = -1
173
174      IF(lwp) THEN                   ! Print the choice
175         WRITE(numout,*)
176         IF( nadv ==  0 )   WRITE(numout,*) '         2nd order scheme is used'
177         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is usedi, k-j-i case'
178         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
179         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
180         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
181         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
182         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
183      ENDIF
184      !
185   END SUBROUTINE tra_adv_ctl
186
187  !!======================================================================
188END MODULE traadv
Note: See TracBrowser for help on using the repository browser.