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 branches/DEV_r2106_LOCEAN2010/NEMO/OPA_SRC/TRA – NEMO

source: branches/DEV_r2106_LOCEAN2010/NEMO/OPA_SRC/TRA/traadv.F90 @ 2224

Last change on this file since 2224 was 2104, checked in by cetlod, 14 years ago

update DEV_r2006_merge_TRA_TRC according to review
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 11.1 KB
Line 
1MODULE traadv
2   !!==============================================================================
3   !!                       ***  MODULE  traadv  ***
4   !! Ocean active tracers:  advection trend
5   !!==============================================================================
6   !! History :  2.0  !  2005-11  (G. Madec)  Original code
7   !!            3.3  !  2010-09  (C. Ethe, G. Madec)  merge TRC-TRA + switch from velocity to transport
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   tra_adv      : compute ocean tracer advection trend
12   !!   tra_adv_ctl  : control the different options of advection scheme
13   !!----------------------------------------------------------------------
14   USE oce             ! ocean dynamics and active tracers
15   USE dom_oce         ! ocean space and time domain
16   USE traadv_cen2     ! 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_qck      ! QUICKEST scheme           (tra_adv_qck    routine)
22   USE traadv_eiv      ! eddy induced velocity     (tra_adv_eiv    routine)
23   USE ldftra_oce      ! lateral diffusion coefficient on tracers
24   USE in_out_manager  ! I/O manager
25   USE prtctl          ! Print control
26   USE iom
27
28   IMPLICIT NONE
29   PRIVATE
30
31   PUBLIC   tra_adv         ! routine called by step module
32   PUBLIC   tra_adv_init    ! routine called by opa module
33 
34   !                                                   !!* Namelist namtra_adv *
35   LOGICAL ::   ln_traadv_cen2   = .TRUE.       ! 2nd order centered scheme flag
36   LOGICAL ::   ln_traadv_tvd    = .FALSE.      ! TVD scheme flag
37   LOGICAL ::   ln_traadv_muscl  = .FALSE.      ! MUSCL scheme flag
38   LOGICAL ::   ln_traadv_muscl2 = .FALSE.      ! MUSCL2 scheme flag
39   LOGICAL ::   ln_traadv_ubs    = .FALSE.      ! UBS scheme flag
40   LOGICAL ::   ln_traadv_qck    = .FALSE.      ! QUICKEST scheme flag
41
42   INTEGER ::   nadv   ! choice of the type of advection scheme
43
44   REAL(wp), DIMENSION(jpk) ::   r2dt  ! vertical profile time-step, = 2 rdttra
45      !                                ! except at nit000 (=rdttra) if neuler=0
46
47   !! * Substitutions
48#  include "domzgr_substitute.h90"
49#  include "vectopt_loop_substitute.h90"
50   !!----------------------------------------------------------------------
51   !! NEMO/OPA 3.3 , LOCEAN-IPSL (2010)
52   !! $Id$
53   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
54   !!----------------------------------------------------------------------
55
56CONTAINS
57
58   SUBROUTINE tra_adv( kt )
59      !!----------------------------------------------------------------------
60      !!                  ***  ROUTINE tra_adv  ***
61      !!
62      !! ** Purpose :   compute the ocean tracer advection trend.
63      !!
64      !! ** Method  : - Update (ua,va) with the advection term following nadv
65      !!----------------------------------------------------------------------
66      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
67      !!
68      INTEGER ::   jk   ! dummy loop index
69      REAL(wp), DIMENSION(jpi,jpj,jpk)   ::  zun, zvn, zwn   ! 3D workspace: effective transport
70      !!----------------------------------------------------------------------
71      !                                          ! set time step
72      IF( neuler == 0 .AND. kt == nit000 ) THEN     ! at nit000
73         r2dt(:) =  rdttra(:)                          ! = rdtra (restarting with Euler time stepping)
74      ELSEIF( kt <= nit000 + 1) THEN                ! at nit000 or nit000+1
75         r2dt(:) = 2. * rdttra(:)                      ! = 2 rdttra (leapfrog)
76      ENDIF
77      !                                               !==  effective transport  ==!
78      DO jk = 1, jpkm1
79         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)                  ! eulerian transport only
80         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
81         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * wn(:,:,jk)
82      END DO
83      zwn(:,:,jpk) = 0.e0                                                     ! no transport trough the bottom
84      !
85      IF( lk_traldf_eiv )   CALL tra_adv_eiv( kt, zun, zvn, zwn, 'TRA' )      ! add the eiv transport (if necessary)
86      !
87      CALL iom_put( "uoce_eff", zun )                                         ! output effective transport     
88      CALL iom_put( "voce_eff", zvn )
89      CALL iom_put( "woce_eff", zwn )
90
91
92      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
93      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, 'TRA',       zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  2nd order centered
94      CASE ( 2 )   ;    CALL tra_adv_tvd   ( kt, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  TVD
95      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, 'TRA', r2dt, zun, zvn, zwn, tsb,      tsa, jpts )   !  MUSCL
96      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  MUSCL2
97      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  UBS
98      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  QUICKEST
99      !
100      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
101         CALL tra_adv_cen2  ( kt, 'TRA',       zun, zvn, zwn, tsb, tsn, tsa, jpts )         
102         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv0 - Ta: ', mask1=tmask,               &
103            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
104         CALL tra_adv_tvd   ( kt, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
105         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv1 - Ta: ', mask1=tmask,               &
106            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
107         CALL tra_adv_muscl ( kt, 'TRA', r2dt, zun, zvn, zwn, tsb,      tsa, jpts )         
108         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv3 - Ta: ', mask1=tmask,               &
109            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
110         CALL tra_adv_muscl2( kt, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
111         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv4 - Ta: ', mask1=tmask,               &
112            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
113         CALL tra_adv_ubs   ( kt, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
114         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv5 - Ta: ', mask1=tmask,               &
115            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
116         CALL tra_adv_qck   ( kt, 'TRA', r2dt, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
117         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv6 - Ta: ', mask1=tmask,               &
118            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
119         !
120      END SELECT
121
122      !                                              ! print mean trends (used for debugging)
123      IF(ln_ctl)   CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv  - Ta: ', mask1=tmask,               &
124         &                       tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
125      !
126   END SUBROUTINE tra_adv
127
128
129   SUBROUTINE tra_adv_init
130      !!---------------------------------------------------------------------
131      !!                  ***  ROUTINE tra_adv_init  ***
132      !!               
133      !! ** Purpose :   Control the consistency between namelist options for
134      !!              tracer advection schemes and set nadv
135      !!----------------------------------------------------------------------
136      INTEGER ::   ioptio
137      !!
138      NAMELIST/namtra_adv/ ln_traadv_cen2 , ln_traadv_tvd,    &
139         &                 ln_traadv_muscl, ln_traadv_muscl2, &
140         &                 ln_traadv_ubs  , ln_traadv_qck
141      !!----------------------------------------------------------------------
142
143      REWIND ( numnam )               ! Read Namelist namtra_adv : tracer advection scheme
144      READ   ( numnam, namtra_adv )
145
146      IF(lwp) THEN                    ! Namelist print
147         WRITE(numout,*)
148         WRITE(numout,*) 'tra_adv_init : choice/control of the tracer advection scheme'
149         WRITE(numout,*) '~~~~~~~~~~~'
150         WRITE(numout,*) '   Namelist namtra_adv : chose a advection scheme for tracers'
151         WRITE(numout,*) '      2nd order advection scheme     ln_traadv_cen2   = ', ln_traadv_cen2
152         WRITE(numout,*) '      TVD advection scheme           ln_traadv_tvd    = ', ln_traadv_tvd
153         WRITE(numout,*) '      MUSCL  advection scheme        ln_traadv_muscl  = ', ln_traadv_muscl
154         WRITE(numout,*) '      MUSCL2 advection scheme        ln_traadv_muscl2 = ', ln_traadv_muscl2
155         WRITE(numout,*) '      UBS    advection scheme        ln_traadv_ubs    = ', ln_traadv_ubs
156         WRITE(numout,*) '      QUICKEST advection scheme      ln_traadv_qck    = ', ln_traadv_qck
157    ENDIF
158
159      ioptio = 0                      ! Parameter control
160      IF( ln_traadv_cen2   )   ioptio = ioptio + 1
161      IF( ln_traadv_tvd    )   ioptio = ioptio + 1
162      IF( ln_traadv_muscl  )   ioptio = ioptio + 1
163      IF( ln_traadv_muscl2 )   ioptio = ioptio + 1
164      IF( ln_traadv_ubs    )   ioptio = ioptio + 1
165      IF( ln_traadv_qck    )   ioptio = ioptio + 1
166      IF( lk_esopa         )   ioptio =          1
167
168      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtra_adv' )
169
170      IF( n_cla == 1 .AND. .NOT. ln_traadv_cen2 )   &
171         &                CALL ctl_stop( 'cross-land advection only with 2nd order advection scheme' )
172
173      !                              ! Set nadv
174      IF( ln_traadv_cen2   )   nadv =  1
175      IF( ln_traadv_tvd    )   nadv =  2
176      IF( ln_traadv_muscl  )   nadv =  3
177      IF( ln_traadv_muscl2 )   nadv =  4
178      IF( ln_traadv_ubs    )   nadv =  5
179      IF( ln_traadv_qck    )   nadv =  6
180      IF( lk_esopa         )   nadv = -1
181
182      IF(lwp) THEN                   ! Print the choice
183         WRITE(numout,*)
184         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
185         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
186         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
187         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
188         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
189         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
190         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
191      ENDIF
192      !
193   END SUBROUTINE tra_adv_init
194
195  !!======================================================================
196END MODULE traadv
Note: See TracBrowser for help on using the repository browser.