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 @ 527

Last change on this file since 527 was 519, checked in by opalod, 18 years ago

nemo_v1_update_74 : CT : - add comments for the UBS scheme

  • syntax correction
  • remove the use of eddy velocity in the calculation of poleward transport since it is already included into the normal velocity
  • remove the save of the trend associated to the BBL advective velocity since it is already included into the normal velocity
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.9 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   NAMELIST/nam_traadv/ ln_traadv_cen2 , ln_traadv_tvd,   &
39      &                 ln_traadv_muscl, ln_traadv_muscl2, ln_traadv_ubs
40
41   INTEGER ::   nadv   ! choice of the type of advection scheme
42
43   !! * Substitutions
44#  include "domzgr_substitute.h90"
45#  include "vectopt_loop_substitute.h90"
46   !!----------------------------------------------------------------------
47   !!   OPA 9.0 , LOCEAN-IPSL (2006)
48   !! $Header$
49   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
50   !!----------------------------------------------------------------------
51
52CONTAINS
53
54   SUBROUTINE tra_adv( kt )
55      !!----------------------------------------------------------------------
56      !!                  ***  ROUTINE tra_adv  ***
57      !!
58      !! ** Purpose :   compute the ocean tracer advection trend.
59      !!
60      !! ** Method  : - Update (ua,va) with the advection term following nadv
61      !!----------------------------------------------------------------------
62#if ( defined key_trabbl_adv || defined key_traldf_eiv )
63      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zun, zvn, zwn   ! effective velocity
64#else
65      USE oce, ONLY :                       zun => un       ! the effective velocity is the
66      USE oce, ONLY :                       zvn => vn       ! Eulerian velocity
67      USE oce, ONLY :                       zwn => wn       !
68#endif
69      !!
70      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
71      !!----------------------------------------------------------------------
72
73      IF( kt == nit000 )   CALL tra_adv_ctl          ! initialisation & control of options
74
75#if defined key_trabbl_adv
76      zun(:,:,:) = un(:,:,:) - u_bbl(:,:,:)          ! add the bbl velocity
77      zvn(:,:,:) = vn(:,:,:) - v_bbl(:,:,:)
78      zwn(:,:,:) = wn(:,:,:) + w_bbl(:,:,:)
79#endif
80      IF( lk_traldf_eiv ) THEN                       ! commpute and add the eiv velocity
81         IF( .NOT. lk_trabbl_adv ) THEN
82            zun(:,:,:) = un(:,:,:)
83            zvn(:,:,:) = vn(:,:,:)
84            zwn(:,:,:) = wn(:,:,:)
85         ENDIF
86         CALL tra_adv_eiv( kt, zun, zvn, zwn ) 
87      ENDIF
88
89      SELECT CASE ( nadv )                           ! compute advection trend and add it to general trend
90      CASE ( 0 )   ;   CALL tra_adv_cen2    ( kt, zun, zvn, zwn )    ! 2nd order centered scheme k-j-i loops
91      CASE ( 1 )   ;   CALL tra_adv_cen2_jki( kt, zun, zvn, zwn )    ! 2nd order centered scheme
92      CASE ( 2 )   ;   CALL tra_adv_tvd     ( kt, zun, zvn, zwn )    ! TVD    scheme
93      CASE ( 3 )   ;   CALL tra_adv_muscl   ( kt, zun, zvn, zwn )    ! MUSCL  scheme
94      CASE ( 4 )   ;   CALL tra_adv_muscl2  ( kt, zun, zvn, zwn )    ! MUSCL2 scheme
95      CASE ( 5 )   ;   CALL tra_adv_ubs     ( kt, zun, zvn, zwn )    ! UBS    scheme
96      !
97      CASE (-1 )                                                     ! esopa: test all possibility with control print
98         ;             CALL tra_adv_cen2    ( kt, zun, zvn, zwn )
99         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv0 - Ta: ', mask1=tmask,               &
100            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
101         ;             CALL tra_adv_cen2_jki( kt, zun, zvn, zwn )
102         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv1 - Ta: ', mask1=tmask,               &
103            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
104         ;             CALL tra_adv_tvd     ( kt, zun, zvn, zwn )
105         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv2 - Ta: ', mask1=tmask,               &
106            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
107         ;             CALL tra_adv_muscl   ( kt, zun, zvn, zwn )
108         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv3 - Ta: ', mask1=tmask,               &
109            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
110         ;             CALL tra_adv_muscl2  ( kt, zun, zvn, zwn )
111         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv4 - Ta: ', mask1=tmask,               &
112            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
113         ;             CALL tra_adv_ubs     ( kt, zun, zvn, zwn )
114         ;             CALL prt_ctl( tab3d_1=ta, clinfo1=' adv5 - Ta: ', mask1=tmask,               &
115            &                        tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
116      END SELECT
117      !                                              ! print mean trends (used for debugging)
118      IF(ln_ctl)   CALL prt_ctl( tab3d_1=ta, clinfo1=' adv  - Ta: ', mask1=tmask,               &
119         &                       tab3d_2=sa, clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
120      !
121   END SUBROUTINE tra_adv
122
123
124   SUBROUTINE tra_adv_ctl
125      !!---------------------------------------------------------------------
126      !!                  ***  ROUTINE tra_adv_ctl  ***
127      !!               
128      !! ** Purpose :   Control the consistency between namelist options for
129      !!              tracer advection schemes and set nadv
130      !!----------------------------------------------------------------------
131      INTEGER ::   ioptio
132      !!----------------------------------------------------------------------
133
134      REWIND ( numnam )               ! Read Namelist nam_traadv : tracer advection scheme
135      READ   ( numnam, nam_traadv )
136
137      IF(lwp) THEN                    ! Namelist print
138         WRITE(numout,*)
139         WRITE(numout,*) 'tra_adv_ctl : choice/control of the tracer advection scheme'
140         WRITE(numout,*) '~~~~~~~~~~~'
141         WRITE(numout,*) '       Namelist nam_traadv : chose a advection scheme for tracers'
142         WRITE(numout,*) '          2nd order advection scheme     ln_traadv_cen2   = ', ln_traadv_cen2
143         WRITE(numout,*) '          TVD advection scheme           ln_traadv_tvd    = ', ln_traadv_tvd
144         WRITE(numout,*) '          MUSCL  advection scheme        ln_traadv_muscl  = ', ln_traadv_muscl
145         WRITE(numout,*) '          MUSCL2 advection scheme        ln_traadv_muscl2 = ', ln_traadv_muscl2
146         WRITE(numout,*) '          UBS    advection scheme        ln_traadv_ubs    = ', ln_traadv_ubs
147      ENDIF
148
149      ioptio = 0                      ! Parameter control
150      IF( ln_traadv_cen2   )   ioptio = ioptio + 1
151      IF( ln_traadv_tvd    )   ioptio = ioptio + 1
152      IF( ln_traadv_muscl  )   ioptio = ioptio + 1
153      IF( ln_traadv_muscl2 )   ioptio = ioptio + 1
154      IF( ln_traadv_ubs    )   ioptio = ioptio + 1
155      IF( lk_esopa         )   ioptio =          1
156
157      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist nam_traadv' )
158
159      IF( n_cla == 1 .AND. .NOT. ln_traadv_cen2 )   &
160         &                CALL ctl_stop( 'cross-land advection only with 2nd order advection scheme' )
161
162      !                              ! Set nadv
163      IF( ln_traadv_cen2   )   nadv =  0
164#if defined key_mpp_omp
165      IF( ln_traadv_cen2   )   nadv =  1
166#endif
167      IF( ln_traadv_tvd    )   nadv =  2
168      IF( ln_traadv_muscl  )   nadv =  3
169      IF( ln_traadv_muscl2 )   nadv =  4
170      IF( ln_traadv_ubs    )   nadv =  5
171      IF( lk_esopa         )   nadv = -1
172
173      IF(lwp) THEN                   ! Print the choice
174         WRITE(numout,*)
175         IF( nadv ==  0 )   WRITE(numout,*) '         2nd order scheme is used'
176         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is usedi, k-j-i case'
177         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
178         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
179         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
180         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
181         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
182      ENDIF
183      !
184   END SUBROUTINE tra_adv_ctl
185
186  !!======================================================================
187END MODULE traadv
Note: See TracBrowser for help on using the repository browser.