source: branches/UKMO/dev_r5518_GO6_package/NEMOGCM/NEMO/OPA_SRC/TRA/traadv.F90 @ 7061

Last change on this file since 7061 was 7061, checked in by davestorkey, 4 years ago

Enable 3D tracer trends diagnostics ,ie. diagnostics obtained for ln_tra_trd=T, in UKMO/dev_r5518_GO6_package branch.
Remove error check for VVL and implement thickness weighting.
Also implement new diagnostics:
ttrd_totad : the total trend due to advection (correct alternative to ttrd_ad!)
ttrd_iso_x/y/z1 : individual components of trend due to isopycnal diffusion. Note the "z1" diagnostic is only part of the vertical trend. The other part is ttrd_zdf minus ttrd_zdfp.
ttrd_evd : the trend due to the EVD convection term (which is contained in ttrd_zdf and ttrd_zdfp).
ttrd_tot : the total model trend.
u/v/weiv_masstr3d : the components of the mass transport due to the Gent-Mc Williams? scheme.
u/v/weiv_heattr3d : the components of the heat transport due to the Gent-Mc Williams? scheme.
u/v/weiv_salttr3d : the components of the salt transport due to the Gent-Mc Williams? scheme.

File size: 14.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   !!            4.0  !  2011-06  (G. Madec)  Addition of Mixed Layer Eddy parameterisation
9   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
12   !!   tra_adv      : compute ocean tracer advection trend
13   !!   tra_adv_ctl  : control the different options of advection scheme
14   !!----------------------------------------------------------------------
15   USE oce             ! ocean dynamics and active tracers
16   USE dom_oce         ! ocean space and time domain
17   USE domvvl          ! variable vertical scale factors
18   USE traadv_cen2     ! 2nd order centered scheme (tra_adv_cen2   routine)
19   USE traadv_tvd      ! TVD      scheme           (tra_adv_tvd    routine)
20   USE traadv_muscl    ! MUSCL    scheme           (tra_adv_muscl  routine)
21   USE traadv_muscl2   ! MUSCL2   scheme           (tra_adv_muscl2 routine)
22   USE traadv_ubs      ! UBS      scheme           (tra_adv_ubs    routine)
23   USE traadv_qck      ! QUICKEST scheme           (tra_adv_qck    routine)
24   USE traadv_eiv      ! eddy induced velocity     (tra_adv_eiv    routine)
25   USE traadv_mle      ! ML eddy induced velocity  (tra_adv_mle    routine)
26   USE cla             ! cross land advection      (cla_traadv     routine)
27   USE ldftra_oce      ! lateral diffusion coefficient on tracers
28   USE trd_oce         ! trends: ocean variables
29   USE trdtra          ! trends manager: tracers
30   !
31   USE in_out_manager  ! I/O manager
32   USE iom             ! I/O module
33   USE prtctl          ! Print control
34   USE lib_mpp         ! MPP library
35   USE wrk_nemo        ! Memory Allocation
36   USE timing          ! Timing
37   USE sbc_oce
38   USE diaptr          ! Poleward heat transport
39
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   tra_adv        ! routine called by step module
45   PUBLIC   tra_adv_init   ! routine called by opa module
46
47   !                              !!* Namelist namtra_adv *
48   LOGICAL ::   ln_traadv_cen2     ! 2nd order centered scheme flag
49   LOGICAL ::   ln_traadv_tvd      ! TVD scheme flag
50   LOGICAL ::   ln_traadv_tvd_zts  ! TVD scheme flag with vertical sub time-stepping
51   LOGICAL ::   ln_traadv_muscl    ! MUSCL scheme flag
52   LOGICAL ::   ln_traadv_muscl2   ! MUSCL2 scheme flag
53   LOGICAL ::   ln_traadv_ubs      ! UBS scheme flag
54   LOGICAL ::   ln_traadv_qck      ! QUICKEST scheme flag
55   LOGICAL ::   ln_traadv_msc_ups  ! use upstream scheme within muscl
56
57
58   INTEGER ::   nadv   ! choice of the type of advection scheme
59
60   !! * Substitutions
61#  include "domzgr_substitute.h90"
62#  include "vectopt_loop_substitute.h90"
63   !!----------------------------------------------------------------------
64   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
65   !! $Id$
66   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
67   !!----------------------------------------------------------------------
68CONTAINS
69
70   SUBROUTINE tra_adv( kt )
71      !!----------------------------------------------------------------------
72      !!                  ***  ROUTINE tra_adv  ***
73      !!
74      !! ** Purpose :   compute the ocean tracer advection trend.
75      !!
76      !! ** Method  : - Update (ua,va) with the advection term following nadv
77      !!----------------------------------------------------------------------
78      !
79      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
80      !
81      INTEGER ::   jk   ! dummy loop index
82      REAL(wp), POINTER, DIMENSION(:,:,:) :: zun, zvn, zwn
83      REAL(wp), POINTER, DIMENSION(:,:,:) ::   ztrdt, ztrds   ! 3D workspace
84      !!----------------------------------------------------------------------
85      !
86      IF( nn_timing == 1 )  CALL timing_start('tra_adv')
87      !
88      CALL wrk_alloc( jpi, jpj, jpk, zun, zvn, zwn )
89      !                                          ! set time step
90      IF( neuler == 0 .AND. kt == nit000 ) THEN     ! at nit000
91         r2dtra(:) =  rdttra(:)                          ! = rdtra (restarting with Euler time stepping)
92      ELSEIF( kt <= nit000 + 1) THEN                ! at nit000 or nit000+1
93         r2dtra(:) = 2._wp * rdttra(:)                   ! = 2 rdttra (leapfrog)
94      ENDIF
95      !
96      IF( nn_cla == 1 .AND. cp_cfg == 'orca' .AND. jp_cfg == 2 )   CALL cla_traadv( kt )       !==  Cross Land Advection  ==! (hor. advection)
97      !
98      !                                               !==  effective transport  ==!
99      DO jk = 1, jpkm1
100         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)                  ! eulerian transport only
101         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
102         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * wn(:,:,jk)
103      END DO
104      !
105      IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
106         zun(:,:,:) = zun(:,:,:) + un_td(:,:,:)
107         zvn(:,:,:) = zvn(:,:,:) + vn_td(:,:,:)
108      ENDIF
109      !
110      zun(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
111      zvn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
112      zwn(:,:,jpk) = 0._wp                                                     ! no transport trough the bottom
113      !
114      IF( lk_traldf_eiv .AND. .NOT. ln_traldf_grif )   &
115         &              CALL tra_adv_eiv( kt, nit000, zun, zvn, zwn, 'TRA' )    ! add the eiv transport (if necessary)
116      !
117      IF( ln_mle    )   CALL tra_adv_mle( kt, nit000, zun, zvn, zwn, 'TRA' )    ! add the mle transport (if necessary)
118      !
119      CALL iom_put( "uocetr_eff", zun )                                         ! output effective transport     
120      CALL iom_put( "vocetr_eff", zvn )
121      CALL iom_put( "wocetr_eff", zwn )
122      !
123      IF( ln_diaptr )   CALL dia_ptr( zvn )                                     ! diagnose the effective MSF
124      !
125      IF( l_trdtra )   THEN                    !* Save ta and sa trends
126         CALL wrk_alloc( jpi, jpj, jpk, ztrdt, ztrds )
127         ztrdt(:,:,:) = tsa(:,:,:,jp_tem)
128         ztrds(:,:,:) = tsa(:,:,:,jp_sal)
129      ENDIF
130      !
131      SELECT CASE ( nadv )                            !==  compute advection trend and add it to general trend  ==!
132      CASE ( 1 )   ;    CALL tra_adv_cen2   ( kt, nit000, 'TRA',         zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  2nd order centered
133      CASE ( 2 )   ;    CALL tra_adv_tvd    ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  TVD
134      CASE ( 3 )   ;    CALL tra_adv_muscl  ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb,      tsa, jpts, ln_traadv_msc_ups )   !  MUSCL
135      CASE ( 4 )   ;    CALL tra_adv_muscl2 ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  MUSCL2
136      CASE ( 5 )   ;    CALL tra_adv_ubs    ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  UBS
137      CASE ( 6 )   ;    CALL tra_adv_qck    ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  QUICKEST
138      CASE ( 7 )   ;    CALL tra_adv_tvd_zts( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )   !  TVD ZTS
139      !
140      CASE (-1 )                                      !==  esopa: test all possibility with control print  ==!
141         CALL tra_adv_cen2  ( kt, nit000, 'TRA',         zun, zvn, zwn, tsb, tsn, tsa, jpts )         
142         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv0 - Ta: ', mask1=tmask,               &
143            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
144         CALL tra_adv_tvd   ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
145         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv1 - Ta: ', mask1=tmask,               &
146            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
147         CALL tra_adv_muscl ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb,      tsa, jpts, ln_traadv_msc_ups )         
148         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv3 - Ta: ', mask1=tmask,               &
149            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
150         CALL tra_adv_muscl2( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
151         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv4 - Ta: ', mask1=tmask,               &
152            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
153         CALL tra_adv_ubs   ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
154         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv5 - Ta: ', mask1=tmask,               &
155            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
156         CALL tra_adv_qck   ( kt, nit000, 'TRA', r2dtra, zun, zvn, zwn, tsb, tsn, tsa, jpts )         
157         CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv6 - Ta: ', mask1=tmask,               &
158            &          tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
159      END SELECT
160      !
161      IF( l_trdtra )   THEN                      ! save the advective trends for further diagnostics
162         DO jk = 1, jpkm1
163            ztrdt(:,:,jk) = tsa(:,:,jk,jp_tem) - ztrdt(:,:,jk)
164            ztrds(:,:,jk) = tsa(:,:,jk,jp_sal) - ztrds(:,:,jk)
165         END DO
166         CALL trd_tra( kt, 'TRA', jp_tem, jptra_totad, ztrdt )
167         CALL trd_tra( kt, 'TRA', jp_sal, jptra_totad, ztrds )
168         CALL wrk_dealloc( jpi, jpj, jpk, ztrdt, ztrds )
169      ENDIF
170      !                                              ! print mean trends (used for debugging)
171      IF(ln_ctl)   CALL prt_ctl( tab3d_1=tsa(:,:,:,jp_tem), clinfo1=' adv  - Ta: ', mask1=tmask,               &
172         &                       tab3d_2=tsa(:,:,:,jp_sal), clinfo2=       ' Sa: ', mask2=tmask, clinfo3='tra' )
173      !
174      IF( nn_timing == 1 )  CALL timing_stop( 'tra_adv' )
175      !
176      CALL wrk_dealloc( jpi, jpj, jpk, zun, zvn, zwn )
177      !                                         
178   END SUBROUTINE tra_adv
179
180
181   SUBROUTINE tra_adv_init
182      !!---------------------------------------------------------------------
183      !!                  ***  ROUTINE tra_adv_init  ***
184      !!               
185      !! ** Purpose :   Control the consistency between namelist options for
186      !!              tracer advection schemes and set nadv
187      !!----------------------------------------------------------------------
188      INTEGER ::   ioptio
189      INTEGER ::   ios                 ! Local integer output status for namelist read
190      !!
191      NAMELIST/namtra_adv/ ln_traadv_cen2 , ln_traadv_tvd,     &
192         &                 ln_traadv_muscl, ln_traadv_muscl2,  &
193         &                 ln_traadv_ubs  , ln_traadv_qck,     &
194         &                 ln_traadv_msc_ups, ln_traadv_tvd_zts
195      !!----------------------------------------------------------------------
196
197      REWIND( numnam_ref )              ! Namelist namtra_adv in reference namelist : Tracer advection scheme
198      READ  ( numnam_ref, namtra_adv, IOSTAT = ios, ERR = 901)
199901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_adv in reference namelist', lwp )
200
201      REWIND( numnam_cfg )              ! Namelist namtra_adv in configuration namelist : Tracer advection scheme
202      READ  ( numnam_cfg, namtra_adv, IOSTAT = ios, ERR = 902 )
203902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtra_adv in configuration namelist', lwp )
204      IF(lwm) WRITE ( numond, namtra_adv )
205
206      IF(lwp) THEN                    ! Namelist print
207         WRITE(numout,*)
208         WRITE(numout,*) 'tra_adv_init : choice/control of the tracer advection scheme'
209         WRITE(numout,*) '~~~~~~~~~~~'
210         WRITE(numout,*) '   Namelist namtra_adv : chose a advection scheme for tracers'
211         WRITE(numout,*) '      2nd order advection scheme     ln_traadv_cen2    = ', ln_traadv_cen2
212         WRITE(numout,*) '      TVD advection scheme           ln_traadv_tvd     = ', ln_traadv_tvd
213         WRITE(numout,*) '      MUSCL  advection scheme        ln_traadv_muscl   = ', ln_traadv_muscl
214         WRITE(numout,*) '      MUSCL2 advection scheme        ln_traadv_muscl2  = ', ln_traadv_muscl2
215         WRITE(numout,*) '      UBS    advection scheme        ln_traadv_ubs     = ', ln_traadv_ubs
216         WRITE(numout,*) '      QUICKEST advection scheme      ln_traadv_qck     = ', ln_traadv_qck
217         WRITE(numout,*) '      upstream scheme within muscl   ln_traadv_msc_ups = ', ln_traadv_msc_ups
218         WRITE(numout,*) '      TVD advection scheme with zts  ln_traadv_tvd_zts = ', ln_traadv_tvd_zts
219      ENDIF
220
221      ioptio = 0                      ! Parameter control
222      IF( ln_traadv_cen2   )   ioptio = ioptio + 1
223      IF( ln_traadv_tvd    )   ioptio = ioptio + 1
224      IF( ln_traadv_muscl  )   ioptio = ioptio + 1
225      IF( ln_traadv_muscl2 )   ioptio = ioptio + 1
226      IF( ln_traadv_ubs    )   ioptio = ioptio + 1
227      IF( ln_traadv_qck    )   ioptio = ioptio + 1
228      IF( ln_traadv_tvd_zts)   ioptio = ioptio + 1
229      IF( lk_esopa         )   ioptio =          1
230
231      IF( ( ln_traadv_muscl .OR. ln_traadv_muscl2 .OR. ln_traadv_ubs .OR. ln_traadv_qck .OR. ln_traadv_tvd_zts )   &
232         .AND. ln_isfcav )   CALL ctl_stop( 'Only traadv_cen2 and traadv_tvd is compatible with ice shelf cavity')
233
234      IF( ioptio /= 1 )   CALL ctl_stop( 'Choose ONE advection scheme in namelist namtra_adv' )
235
236      !                              ! Set nadv
237      IF( ln_traadv_cen2   )   nadv =  1
238      IF( ln_traadv_tvd    )   nadv =  2
239      IF( ln_traadv_muscl  )   nadv =  3
240      IF( ln_traadv_muscl2 )   nadv =  4
241      IF( ln_traadv_ubs    )   nadv =  5
242      IF( ln_traadv_qck    )   nadv =  6
243      IF( ln_traadv_tvd_zts)   nadv =  7
244      IF( lk_esopa         )   nadv = -1
245
246      IF(lwp) THEN                   ! Print the choice
247         WRITE(numout,*)
248         IF( nadv ==  1 )   WRITE(numout,*) '         2nd order scheme is used'
249         IF( nadv ==  2 )   WRITE(numout,*) '         TVD       scheme is used'
250         IF( nadv ==  3 )   WRITE(numout,*) '         MUSCL     scheme is used'
251         IF( nadv ==  4 )   WRITE(numout,*) '         MUSCL2    scheme is used'
252         IF( nadv ==  5 )   WRITE(numout,*) '         UBS       scheme is used'
253         IF( nadv ==  6 )   WRITE(numout,*) '         QUICKEST  scheme is used'
254         IF( nadv ==  7 )   WRITE(numout,*) '         TVD ZTS   scheme is used'
255         IF( nadv == -1 )   WRITE(numout,*) '         esopa test: use all advection scheme'
256      ENDIF
257      !
258      CALL tra_adv_mle_init          ! initialisation of the Mixed Layer Eddy parametrisation (MLE)
259      !
260   END SUBROUTINE tra_adv_init
261
262  !!======================================================================
263END MODULE traadv
Note: See TracBrowser for help on using the repository browser.