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/2011/dev_r2739_LOCEAN8_ZTC/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/2011/dev_r2739_LOCEAN8_ZTC/NEMOGCM/NEMO/OPA_SRC/TRA/traadv.F90 @ 2970

Last change on this file since 2970 was 2905, checked in by mlelod, 13 years ago

first commit, compilation ok, see ticket/863?
  • Property svn:keywords set to Id
File size: 11.9 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 domvvl          ! variable vertical scale factors
17   USE traadv_cen2     ! 2nd order centered scheme (tra_adv_cen2   routine)
18   USE traadv_tvd      ! TVD      scheme           (tra_adv_tvd    routine)
19   USE traadv_muscl    ! MUSCL    scheme           (tra_adv_muscl  routine)
20   USE traadv_muscl2   ! MUSCL2   scheme           (tra_adv_muscl2 routine)
21   USE traadv_ubs      ! UBS      scheme           (tra_adv_ubs    routine)
22   USE traadv_qck      ! QUICKEST scheme           (tra_adv_qck    routine)
23   USE traadv_eiv      ! eddy induced velocity     (tra_adv_eiv    routine)
24   USE cla             ! cross land advection      (cla_traadv     routine)
25   USE ldftra_oce      ! lateral diffusion coefficient on tracers
26   USE in_out_manager  ! I/O manager
27   USE iom             ! I/O module
28   USE prtctl          ! Print control
29   USE lib_mpp         ! MPP library
30
31   IMPLICIT NONE
32   PRIVATE
33
34   PUBLIC   tra_adv        ! routine called by step module
35   PUBLIC   tra_adv_init   ! routine called by opa module
36
37   !                                        !!* Namelist namtra_adv *
38   LOGICAL ::   ln_traadv_cen2   = .TRUE.    ! 2nd order centered scheme flag
39   LOGICAL ::   ln_traadv_tvd    = .FALSE.   ! TVD scheme flag
40   LOGICAL ::   ln_traadv_muscl  = .FALSE.   ! MUSCL scheme flag
41   LOGICAL ::   ln_traadv_muscl2 = .FALSE.   ! MUSCL2 scheme flag
42   LOGICAL ::   ln_traadv_ubs    = .FALSE.   ! UBS scheme flag
43   LOGICAL ::   ln_traadv_qck    = .FALSE.   ! QUICKEST scheme flag
44
45   INTEGER ::   nadv   ! choice of the type of advection scheme
46
47   !! * Substitutions
48#  include "domzgr_substitute.h90"
49#  include "vectopt_loop_substitute.h90"
50   !!----------------------------------------------------------------------
51   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
52   !! $Id$
53   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
54   !!----------------------------------------------------------------------
55CONTAINS
56
57   SUBROUTINE tra_adv( kt )
58      !!----------------------------------------------------------------------
59      !!                  ***  ROUTINE tra_adv  ***
60      !!
61      !! ** Purpose :   compute the ocean tracer advection trend.
62      !!
63      !! ** Method  : - Update (ua,va) with the advection term following nadv
64      !!----------------------------------------------------------------------
65      USE wrk_nemo, ONLY:   wrk_in_use, wrk_not_released
66      USE wrk_nemo, ONLY:   zun => wrk_3d_1 , zvn => wrk_3d_2 , zwn => wrk_3d_3   ! 3D workspace
67      !
68      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
69      !
70      INTEGER ::   jk   ! dummy loop index
71      !!----------------------------------------------------------------------
72      !
73      IF( wrk_in_use(3, 1,2,3) ) THEN
74         CALL ctl_stop('tra_adv: requested workspace arrays unavailable')   ;   RETURN
75      ENDIF
76      !                                          ! set time step
77      IF( neuler == 0 .AND. kt == nit000 ) THEN     ! at nit000
78         r2dtra(:) =  rdttra(:)                          ! = rdtra (restarting with Euler time stepping)
79      ELSEIF( kt <= nit000 + 1) THEN                ! at nit000 or nit000+1
80         r2dtra(:) = 2._wp * rdttra(:)                   ! = 2 rdttra (leapfrog)
81      ENDIF
82      !
83      IF( nn_cla == 1 )   CALL cla_traadv( kt )       !==  Cross Land Advection  ==! (hor. advection)
84      !
85      !                                               !==  effective transport  ==!
86      DO jk = 1, jpkm1
87         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)                  ! eulerian transport only
88         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
89         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * wn(:,:,jk)
90      END DO
91      !
92      IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
93         zun(:,:,:) = zun(:,:,:) + un_td(:,:,:)
94         zvn(:,:,:) = zvn(:,:,:) + vn_td(:,:,:)
95      ENDIF
96      !
97      zun(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
98      zvn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
99      zwn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
100      !
101      IF( lk_traldf_eiv .AND. .NOT. ln_traldf_grif )   &
102         &              CALL tra_adv_eiv( kt, zun, zvn, zwn, 'TRA' )          ! add the eiv transport (if necessary)
103      !
104      CALL iom_put( "uocetr_eff", zun )                                         ! output effective transport     
105      CALL iom_put( "vocetr_eff", zvn )
106      CALL iom_put( "wocetr_eff", zwn )
107
108      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
109      CASE ( 1 )   ;    CALL tra_adv_cen2  ( kt, 'TRA',         zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  2nd order centered
110      CASE ( 2 )   ;    CALL tra_adv_tvd   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  TVD
111      CASE ( 3 )   ;    CALL tra_adv_muscl ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb,      tsa, jpts )   !  MUSCL
112      CASE ( 4 )   ;    CALL tra_adv_muscl2( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  MUSCL2
113      CASE ( 5 )   ;    CALL tra_adv_ubs   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  UBS
114      CASE ( 6 )   ;    CALL tra_adv_qck   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  QUICKEST
115      !
116      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
117         CALL tra_adv_cen2  ( kt, 'TRA',         zun, zvn, zwn, tsb, tsn, tsa, jpts )         
118         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv0 - Ta: ', mask1=tmask,               &
119            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
120         CALL tra_adv_tvd   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
121         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv1 - Ta: ', mask1=tmask,               &
122            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
123         CALL tra_adv_muscl ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb,      tsa, jpts )         
124         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv3 - Ta: ', mask1=tmask,               &
125            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
126         CALL tra_adv_muscl2( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
127         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv4 - Ta: ', mask1=tmask,               &
128            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
129         CALL tra_adv_ubs   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
130         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv5 - Ta: ', mask1=tmask,               &
131            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
132         CALL tra_adv_qck   ( kt, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
133         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv6 - Ta: ', mask1=tmask,               &
134            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
135      END SELECT
136      !
137      !                                              ! print mean trends (used for debugging)
138      IF(ln_ctl)   CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv  - Ta: ', mask1=tmask,               &
139         &                       tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
140      !
141      IF( wrk_not_released(3,1,2,3) )   CALL ctl_stop('tra_adv: failed to release workspace arrays')
142      !
143   END SUBROUTINE tra_adv
144
145
146   SUBROUTINE tra_adv_init
147      !!---------------------------------------------------------------------
148      !!                  ***  ROUTINE tra_adv_init  ***
149      !!               
150      !! ** Purpose :   Control the consistency between namelist options for
151      !!              tracer advection schemes and set nadv
152      !!----------------------------------------------------------------------
153      INTEGER ::   ioptio
154      !!
155      NAMELIST/namtra_adv/ ln_traadv_cen2 , ln_traadv_tvd,     &
156         &                 ln_traadv_muscl, ln_traadv_muscl2,  &
157         &                 ln_traadv_ubs  , ln_traadv_qck
158      !!----------------------------------------------------------------------
159
160      REWIND( numnam )                ! Read Namelist namtra_adv : tracer advection scheme
161      READ  ( numnam, namtra_adv )
162
163      IF(lwp) THEN                    ! Namelist print
164         WRITE(numout,*)
165         WRITE(numout,*) 'tra_adv_init : choice/control of the tracer advection scheme'
166         WRITE(numout,*) '~~~~~~~~~~~'
167         WRITE(numout,*) '   Namelist namtra_adv : chose a advection scheme for tracers'
168         WRITE(numout,*) '      2nd order advection scheme     ln_traadv_cen2   = ', ln_traadv_cen2
169         WRITE(numout,*) '      TVD advection scheme           ln_traadv_tvd    = ', ln_traadv_tvd
170         WRITE(numout,*) '      MUSCL  advection scheme        ln_traadv_muscl  = ', ln_traadv_muscl
171         WRITE(numout,*) '      MUSCL2 advection scheme        ln_traadv_muscl2 = ', ln_traadv_muscl2
172         WRITE(numout,*) '      UBS    advection scheme        ln_traadv_ubs    = ', ln_traadv_ubs
173         WRITE(numout,*) '      QUICKEST advection scheme      ln_traadv_qck    = ', ln_traadv_qck
174      ENDIF
175
176      ioptio = 0                      ! Parameter control
177      IF( ln_traadv_cen2   )   ioptio = ioptio + 1
178      IF( ln_traadv_tvd    )   ioptio = ioptio + 1
179      IF( ln_traadv_muscl  )   ioptio = ioptio + 1
180      IF( ln_traadv_muscl2 )   ioptio = ioptio + 1
181      IF( ln_traadv_ubs    )   ioptio = ioptio + 1
182      IF( ln_traadv_qck    )   ioptio = ioptio + 1
183      IF( lk_esopa         )   ioptio =          1
184
185      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtra_adv' )
186
187      !                              ! Set nadv
188      IF( ln_traadv_cen2   )   nadv =  1
189      IF( ln_traadv_tvd    )   nadv =  2
190      IF( ln_traadv_muscl  )   nadv =  3
191      IF( ln_traadv_muscl2 )   nadv =  4
192      IF( ln_traadv_ubs    )   nadv =  5
193      IF( ln_traadv_qck    )   nadv =  6
194      IF( lk_esopa         )   nadv = -1
195
196      IF(lwp) THEN                   ! Print the choice
197         WRITE(numout,*)
198         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
199         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
200         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
201         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
202         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
203         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
204         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
205      ENDIF
206      !
207   END SUBROUTINE tra_adv_init
208
209  !!======================================================================
210END MODULE traadv
Note: See TracBrowser for help on using the repository browser.