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_tvd.F90 in branches/UKMO/dev_r5518_GO6_package_fix_rnf_MOCI_TEST_SUITE/NEMOGCM/NEMO/OPA_SRC/TRA – NEMO

source: branches/UKMO/dev_r5518_GO6_package_fix_rnf_MOCI_TEST_SUITE/NEMOGCM/NEMO/OPA_SRC/TRA/traadv_tvd.F90 @ 8191

Last change on this file since 8191 was 8191, checked in by andmirek, 7 years ago

merge with XIOS restart read branch

File size: 36.6 KB
Line 
1MODULE traadv_tvd
2   !!==============================================================================
3   !!                       ***  MODULE  traadv_tvd  ***
4   !! Ocean  tracers:  horizontal & vertical advective trend
5   !!==============================================================================
6   !! History :  OPA  !  1995-12  (L. Mortier)  Original code
7   !!                 !  2000-01  (H. Loukos)  adapted to ORCA
8   !!                 !  2000-10  (MA Foujols E.Kestenare)  include file not routine
9   !!                 !  2000-12  (E. Kestenare M. Levy)  fix bug in trtrd indexes
10   !!                 !  2001-07  (E. Durand G. Madec)  adaptation to ORCA config
11   !!            8.5  !  2002-06  (G. Madec)  F90: Free form and module
12   !!    NEMO    1.0  !  2004-01  (A. de Miranda, G. Madec, J.M. Molines ): advective bbl
13   !!            2.0  !  2008-04  (S. Cravatte) add the i-, j- & k- trends computation
14   !!             -   !  2009-11  (V. Garnier) Surface pressure gradient organization
15   !!            3.3  !  2010-05  (C. Ethe, G. Madec)  merge TRC-TRA + switch from velocity to transport
16   !!----------------------------------------------------------------------
17
18   !!----------------------------------------------------------------------
19   !!   tra_adv_tvd   : update the tracer trend with the 3D advection trends using a TVD scheme
20   !!   nonosc        : compute monotonic tracer fluxes by a non-oscillatory algorithm
21   !!----------------------------------------------------------------------
22   USE oce            ! ocean dynamics and active tracers
23   USE dom_oce        ! ocean space and time domain
24   USE trc_oce        ! share passive tracers/Ocean variables
25   USE trd_oce        ! trends: ocean variables
26   USE trdtra         ! tracers trends
27   USE dynspg_oce     ! choice/control of key cpp for surface pressure gradient
28   USE diaptr         ! poleward transport diagnostics
29   !
30   USE lib_mpp        ! MPP library
31   USE lbclnk         ! ocean lateral boundary condition (or mpp link)
32   USE in_out_manager ! I/O manager
33   USE wrk_nemo       ! Memory Allocation
34   USE timing         ! Timing
35   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
36   USE iom
37
38   IMPLICIT NONE
39   PRIVATE
40
41   PUBLIC   tra_adv_tvd        ! routine called by traadv.F90
42   PUBLIC   tra_adv_tvd_zts    ! routine called by traadv.F90
43
44   LOGICAL ::   l_trd   ! flag to compute trends
45   LOGICAL ::   l_trans   ! flag to output vertically integrated transports
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_tvd ( kt, kit000, cdtype, p2dt, pun, pvn, pwn,      &
58      &                                       ptb, ptn, pta, kjpt )
59      !!----------------------------------------------------------------------
60      !!                  ***  ROUTINE tra_adv_tvd  ***
61      !!
62      !! **  Purpose :   Compute the now trend due to total advection of
63      !!       tracers and add it to the general trend of tracer equations
64      !!
65      !! **  Method  :   TVD scheme, i.e. 2nd order centered scheme with
66      !!       corrected flux (monotonic correction)
67      !!       note: - this advection scheme needs a leap-frog time scheme
68      !!
69      !! ** Action : - update (pta) with the now advective tracer trends
70      !!             - save the trends
71      !!----------------------------------------------------------------------
72      USE oce     , ONLY:   zwx => ua        , zwy => va          ! (ua,va) used as workspace
73      !
74      INTEGER                              , INTENT(in   ) ::   kt              ! ocean time-step index
75      INTEGER                              , INTENT(in   ) ::   kit000          ! first time step index
76      CHARACTER(len=3)                     , INTENT(in   ) ::   cdtype          ! =TRA or TRC (tracer indicator)
77      INTEGER                              , INTENT(in   ) ::   kjpt            ! number of tracers
78      REAL(wp), DIMENSION(        jpk     ), INTENT(in   ) ::   p2dt            ! vertical profile of tracer time-step
79      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(in   ) ::   pun, pvn, pwn   ! 3 ocean velocity components
80      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in   ) ::   ptb, ptn        ! before and now tracer fields
81      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(inout) ::   pta             ! tracer trend
82      !
83      INTEGER  ::   ji, jj, jk, jn           ! dummy loop indices
84      INTEGER  ::   ik 
85      REAL(wp) ::   z2dtt, zbtr, ztra        ! local scalar
86      REAL(wp) ::   zfp_ui, zfp_vj, zfp_wk   !   -      -
87      REAL(wp) ::   zfm_ui, zfm_vj, zfm_wk   !   -      -
88<<<<<<< .working
89      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: zwi, zwz
90      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: ztrdx, ztrdy, ztrdz, zptry
91      REAL(wp), ALLOCATABLE, DIMENSION(:,:)   :: z2d
92=======
93      REAL(wp), POINTER, DIMENSION(:,:,:) :: zwi, zwz
94      REAL(wp), POINTER, DIMENSION(:,:,:) :: ztrdx, ztrdy, ztrdz, zptry
95      REAL(wp), POINTER, DIMENSION(:,:)   :: z2d
96>>>>>>> .merge-right.r7923
97      !!----------------------------------------------------------------------
98      !
99      IF( nn_timing == 1 )  CALL timing_start('tra_adv_tvd')
100      !
101      ALLOCATE(zwi(1:jpi, 1:jpj, 1:jpk))
102      ALLOCATE(zwz(1:jpi, 1:jpj, 1:jpk))
103
104      !
105      IF( kt == kit000 )  THEN
106         IF(lwp) WRITE(numout,*)
107         IF(lwp) WRITE(numout,*) 'tra_adv_tvd : TVD advection scheme on ', cdtype
108         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
109         !
110      ENDIF
111      l_trd = .FALSE.
112      l_trans = .FALSE.
113      IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE.
114      IF( cdtype == 'TRA' .AND. (iom_use("uadv_heattr") .OR. iom_use("vadv_heattr") ) ) l_trans = .TRUE.
115      !
116<<<<<<< .working
117      IF( l_trd .OR. l_trans )  THEN
118         ALLOCATE(ztrdx(1:jpi, 1:jpj, 1:jpk))
119         ALLOCATE(ztrdy(1:jpi, 1:jpj, 1:jpk))
120         ALLOCATE(ztrdz(1:jpi, 1:jpj, 1:jpk))
121=======
122      IF( l_trd .OR. l_trans )  THEN
123         CALL wrk_alloc( jpi, jpj, jpk, ztrdx, ztrdy, ztrdz )
124>>>>>>> .merge-right.r7923
125         ztrdx(:,:,:) = 0.e0   ;    ztrdy(:,:,:) = 0.e0   ;   ztrdz(:,:,:) = 0.e0
126<<<<<<< .working
127         ALLOCATE(z2d(1:jpi, 1:jpj))
128=======
129         CALL wrk_alloc( jpi, jpj, z2d )
130>>>>>>> .merge-right.r7923
131      ENDIF
132      !
133<<<<<<< .working
134      IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
135         ALLOCATE(zptry(1:jpi, 1:jpj, 1:jpk))
136         zptry(:,:,:) = 0._wp
137      ENDIF
138      !
139=======
140      IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
141         CALL wrk_alloc( jpi, jpj, jpk, zptry )
142         zptry(:,:,:) = 0._wp
143      ENDIF
144      !
145>>>>>>> .merge-right.r7923
146      zwi(:,:,:) = 0.e0 ; 
147      !
148      !                                                          ! ===========
149      DO jn = 1, kjpt                                            ! tracer loop
150         !                                                       ! ===========
151         ! 1. Bottom and k=1 value : flux set to zero
152         ! ----------------------------------
153         zwx(:,:,jpk) = 0.e0    ;    zwz(:,:,jpk) = 0.e0
154         zwy(:,:,jpk) = 0.e0    ;    zwi(:,:,jpk) = 0.e0
155         
156         zwz(:,:,1  ) = 0._wp
157         ! 2. upstream advection with initial mass fluxes & intermediate update
158         ! --------------------------------------------------------------------
159         ! upstream tracer flux in the i and j direction
160         DO jk = 1, jpkm1
161            DO jj = 1, jpjm1
162               DO ji = 1, fs_jpim1   ! vector opt.
163                  ! upstream scheme
164                  zfp_ui = pun(ji,jj,jk) + ABS( pun(ji,jj,jk) )
165                  zfm_ui = pun(ji,jj,jk) - ABS( pun(ji,jj,jk) )
166                  zfp_vj = pvn(ji,jj,jk) + ABS( pvn(ji,jj,jk) )
167                  zfm_vj = pvn(ji,jj,jk) - ABS( pvn(ji,jj,jk) )
168                  zwx(ji,jj,jk) = 0.5 * ( zfp_ui * ptb(ji,jj,jk,jn) + zfm_ui * ptb(ji+1,jj  ,jk,jn) )
169                  zwy(ji,jj,jk) = 0.5 * ( zfp_vj * ptb(ji,jj,jk,jn) + zfm_vj * ptb(ji  ,jj+1,jk,jn) )
170               END DO
171            END DO
172         END DO
173
174         ! upstream tracer flux in the k direction
175         ! Interior value
176         DO jk = 2, jpkm1
177            DO jj = 1, jpj
178               DO ji = 1, jpi
179                  zfp_wk = pwn(ji,jj,jk) + ABS( pwn(ji,jj,jk) )
180                  zfm_wk = pwn(ji,jj,jk) - ABS( pwn(ji,jj,jk) )
181                  zwz(ji,jj,jk) = 0.5 * ( zfp_wk * ptb(ji,jj,jk,jn) + zfm_wk * ptb(ji,jj,jk-1,jn) ) * wmask(ji,jj,jk)
182               END DO
183            END DO
184         END DO
185         ! Surface value
186         IF( lk_vvl ) THEN   
187            IF ( ln_isfcav ) THEN
188               DO jj = 1, jpj
189                  DO ji = 1, jpi
190                     zwz(ji,jj, mikt(ji,jj) ) = 0.e0          ! volume variable
191                  END DO
192               END DO
193            ELSE
194               zwz(:,:,1) = 0.e0          ! volume variable
195            END IF
196         ELSE               
197            IF ( ln_isfcav ) THEN
198               DO jj = 1, jpj
199                  DO ji = 1, jpi
200                     zwz(ji,jj, mikt(ji,jj) ) = pwn(ji,jj,mikt(ji,jj)) * ptb(ji,jj,mikt(ji,jj),jn)   ! linear free surface
201                  END DO
202               END DO   
203            ELSE
204               zwz(:,:,1) = pwn(:,:,1) * ptb(:,:,1,jn)   ! linear free surface
205            END IF
206         ENDIF
207
208         ! total advective trend
209         DO jk = 1, jpkm1
210            z2dtt = p2dt(jk)
211            DO jj = 2, jpjm1
212               DO ji = fs_2, fs_jpim1   ! vector opt.
213                  ! total intermediate advective trends
214                  ztra = - (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk  )   &
215                     &      + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk  )   &
216                     &      + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) ) / e1e2t(ji,jj)
217                  ! update and guess with monotonic sheme
218                  pta(ji,jj,jk,jn) =                       pta(ji,jj,jk,jn) +         ztra   / fse3t_n(ji,jj,jk) * tmask(ji,jj,jk)
219                  zwi(ji,jj,jk)    = ( fse3t_b(ji,jj,jk) * ptb(ji,jj,jk,jn) + z2dtt * ztra ) / fse3t_a(ji,jj,jk) * tmask(ji,jj,jk)
220               END DO
221            END DO
222         END DO
223         !                             ! Lateral boundary conditions on zwi  (unchanged sign)
224         CALL lbc_lnk( zwi, 'T', 1. ) 
225
226         !                                 ! trend diagnostics (contribution of upstream fluxes)
227         IF( l_trd .OR. l_trans )  THEN 
228            ! store intermediate advective trends
229            ztrdx(:,:,:) = zwx(:,:,:)   ;    ztrdy(:,:,:) = zwy(:,:,:)  ;   ztrdz(:,:,:) = zwz(:,:,:)
230         END IF
231         !                                 ! "Poleward" heat and salt transports (contribution of upstream fluxes)
232         IF( cdtype == 'TRA' .AND. ln_diaptr )    zptry(:,:,:) = zwy(:,:,:) 
233
234         ! 3. antidiffusive flux : high order minus low order
235         ! --------------------------------------------------
236         ! antidiffusive flux on i and j
237         DO jk = 1, jpkm1
238            DO jj = 1, jpjm1
239               DO ji = 1, fs_jpim1   ! vector opt.
240                  zwx(ji,jj,jk) = 0.5 * pun(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji+1,jj,jk,jn) ) - zwx(ji,jj,jk)
241                  zwy(ji,jj,jk) = 0.5 * pvn(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji,jj+1,jk,jn) ) - zwy(ji,jj,jk)
242               END DO
243            END DO
244         END DO
245     
246         ! antidiffusive flux on k
247         ! Interior value
248         DO jk = 2, jpkm1                   
249            DO jj = 1, jpj
250               DO ji = 1, jpi
251                  zwz(ji,jj,jk) = 0.5 * pwn(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji,jj,jk-1,jn) ) - zwz(ji,jj,jk)
252               END DO
253            END DO
254         END DO
255         ! surface value
256         IF ( ln_isfcav ) THEN
257            DO jj = 1, jpj
258               DO ji = 1, jpi
259                  zwz(ji,jj,mikt(ji,jj)) = 0.e0
260               END DO
261            END DO
262         ELSE
263            zwz(:,:,1) = 0.e0
264         END IF
265         CALL lbc_lnk( zwx, 'U', -1. )   ;   CALL lbc_lnk( zwy, 'V', -1. )         ! Lateral bondary conditions
266         CALL lbc_lnk( zwz, 'W',  1. )
267
268         ! 4. monotonicity algorithm
269         ! -------------------------
270         CALL nonosc( ptb(:,:,:,jn), zwx, zwy, zwz, zwi, p2dt )
271
272
273         ! 5. final trend with corrected fluxes
274         ! ------------------------------------
275         DO jk = 1, jpkm1
276            DO jj = 2, jpjm1
277               DO ji = fs_2, fs_jpim1   ! vector opt. 
278                  zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) )
279                  ! total advective trends
280                  ztra = - zbtr * (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk  )   &
281                     &             + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk  )   &
282                     &             + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) )
283                  ! add them to the general tracer trends
284                  pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) + ztra * tmask(ji,jj,jk)
285               END DO
286            END DO
287         END DO
288
289         !                                 ! trend diagnostics (contribution of upstream fluxes)
290         IF( l_trd .OR. l_trans )  THEN
291            ztrdx(:,:,:) = ztrdx(:,:,:) + zwx(:,:,:)  ! <<< Add to previously computed
292            ztrdy(:,:,:) = ztrdy(:,:,:) + zwy(:,:,:)  ! <<< Add to previously computed
293            ztrdz(:,:,:) = ztrdz(:,:,:) + zwz(:,:,:)  ! <<< Add to previously computed
294         ENDIF
295         
296         IF( l_trd ) THEN
297            CALL trd_tra( kt, cdtype, jn, jptra_xad, ztrdx, pun, ptn(:,:,:,jn) )
298            CALL trd_tra( kt, cdtype, jn, jptra_yad, ztrdy, pvn, ptn(:,:,:,jn) )
299            CALL trd_tra( kt, cdtype, jn, jptra_zad, ztrdz, pwn, ptn(:,:,:,jn) )
300         END IF
301
302         IF( l_trans .AND. jn==jp_tem ) THEN
303            z2d(:,:) = 0._wp 
304            DO jk = 1, jpkm1
305               DO jj = 2, jpjm1
306                  DO ji = fs_2, fs_jpim1   ! vector opt.
307                     z2d(ji,jj) = z2d(ji,jj) + ztrdx(ji,jj,jk) 
308                  END DO
309               END DO
310            END DO
311            CALL lbc_lnk( z2d, 'U', -1. )
312            CALL iom_put( "uadv_heattr", rau0_rcp * z2d )       ! heat transport in i-direction
313              !
314            z2d(:,:) = 0._wp 
315            DO jk = 1, jpkm1
316               DO jj = 2, jpjm1
317                  DO ji = fs_2, fs_jpim1   ! vector opt.
318                     z2d(ji,jj) = z2d(ji,jj) + ztrdy(ji,jj,jk) 
319                  END DO
320               END DO
321            END DO
322            CALL lbc_lnk( z2d, 'V', -1. )
323            CALL iom_put( "vadv_heattr", rau0_rcp * z2d )       ! heat transport in j-direction
324         ENDIF
325         ! "Poleward" heat and salt transports (contribution of upstream fluxes)
326         IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
327            zptry(:,:,:) = zptry(:,:,:) + zwy(:,:,:)  ! <<< Add to previously computed
328            CALL dia_ptr_ohst_components( jn, 'adv', zptry(:,:,:) )
329         ENDIF
330         !
331      END DO
332      !
333<<<<<<< .working
334      DEALLOCATE( zwi )
335      DEALLOCATE( zwz )
336      IF( l_trd .OR. l_trans )  THEN
337         DEALLOCATE( ztrdx )
338         DEALLOCATE( ztrdy )
339         DEALLOCATE( ztrdz )
340         DEALLOCATE( z2d )
341      ENDIF
342      IF( cdtype == 'TRA' .AND. ln_diaptr ) DEALLOCATE( zptry )
343=======
344      CALL wrk_dealloc( jpi, jpj, jpk, zwi, zwz )
345      IF( l_trd .OR. l_trans )  THEN
346         CALL wrk_dealloc( jpi, jpj, jpk, ztrdx, ztrdy, ztrdz )
347         CALL wrk_dealloc( jpi, jpj, z2d )
348      ENDIF
349      IF( cdtype == 'TRA' .AND. ln_diaptr ) CALL wrk_dealloc( jpi, jpj, jpk, zptry )
350>>>>>>> .merge-right.r7923
351      !
352      IF( nn_timing == 1 )  CALL timing_stop('tra_adv_tvd')
353      !
354   END SUBROUTINE tra_adv_tvd
355
356   SUBROUTINE tra_adv_tvd_zts ( kt, kit000, cdtype, p2dt, pun, pvn, pwn,      &
357      &                                       ptb, ptn, pta, kjpt )
358      !!----------------------------------------------------------------------
359      !!                  ***  ROUTINE tra_adv_tvd_zts  ***
360      !!
361      !! **  Purpose :   Compute the now trend due to total advection of
362      !!       tracers and add it to the general trend of tracer equations
363      !!
364      !! **  Method  :   TVD ZTS scheme, i.e. 2nd order centered scheme with
365      !!       corrected flux (monotonic correction). This version use sub-
366      !!       timestepping for the vertical advection which increases stability
367      !!       when vertical metrics are small.
368      !!       note: - this advection scheme needs a leap-frog time scheme
369      !!
370      !! ** Action : - update (pta) with the now advective tracer trends
371      !!             - save the trends
372      !!----------------------------------------------------------------------
373      USE oce     , ONLY:   zwx => ua        , zwy => va          ! (ua,va) used as workspace
374      !
375      INTEGER                              , INTENT(in   ) ::   kt              ! ocean time-step index
376      INTEGER                              , INTENT(in   ) ::   kit000          ! first time step index
377      CHARACTER(len=3)                     , INTENT(in   ) ::   cdtype          ! =TRA or TRC (tracer indicator)
378      INTEGER                              , INTENT(in   ) ::   kjpt            ! number of tracers
379      REAL(wp), DIMENSION(        jpk     ), INTENT(in   ) ::   p2dt            ! vertical profile of tracer time-step
380      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(in   ) ::   pun, pvn, pwn   ! 3 ocean velocity components
381      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in   ) ::   ptb, ptn        ! before and now tracer fields
382      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(inout) ::   pta             ! tracer trend
383      !
384      REAL(wp), DIMENSION( jpk )                           ::   zts             ! length of sub-timestep for vertical advection
385      REAL(wp), DIMENSION( jpk )                           ::   zr_p2dt         ! reciprocal of tracer timestep
386      INTEGER  ::   ji, jj, jk, jl, jn       ! dummy loop indices 
387      INTEGER  ::   jnzts = 5       ! number of sub-timesteps for vertical advection
388      INTEGER  ::   jtb, jtn, jta   ! sub timestep pointers for leap-frog/euler forward steps
389      INTEGER  ::   jtaken          ! toggle for collecting appropriate fluxes from sub timesteps
390      REAL(wp) ::   z_rzts          ! Fractional length of Euler forward sub-timestep for vertical advection
391      REAL(wp) ::   z2dtt, zbtr, ztra        ! local scalar
392      REAL(wp) ::   zfp_ui, zfp_vj, zfp_wk   !   -      -
393      REAL(wp) ::   zfm_ui, zfm_vj, zfm_wk   !   -      -
394<<<<<<< .working
395      REAL(wp), ALLOCATABLE, DIMENSION(:,:  ) :: zwx_sav , zwy_sav
396      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: zwi, zwz, zhdiv, zwz_sav, zwzts
397      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: ztrdx, ztrdy, ztrdz
398      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: zptry
399      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) :: ztrs
400=======
401      REAL(wp), POINTER, DIMENSION(:,:  ) :: zwx_sav , zwy_sav
402      REAL(wp), POINTER, DIMENSION(:,:,:) :: zwi, zwz, zhdiv, zwz_sav, zwzts
403      REAL(wp), POINTER, DIMENSION(:,:,:) :: ztrdx, ztrdy, ztrdz
404      REAL(wp), POINTER, DIMENSION(:,:,:) :: zptry
405      REAL(wp), POINTER, DIMENSION(:,:,:,:) :: ztrs
406>>>>>>> .merge-right.r7923
407      !!----------------------------------------------------------------------
408      !
409      IF( nn_timing == 1 )  CALL timing_start('tra_adv_tvd_zts')
410      !
411      ALLOCATE(zwx_sav(1:jpi, 1:jpj))
412      ALLOCATE(zwy_sav(1:jpi, 1:jpj))
413      ALLOCATE(zwi(1:jpi, 1:jpj, 1:jpk))
414      ALLOCATE(zwz(1:jpi, 1:jpj, 1:jpk))       
415      ALLOCATE(zhdiv(1:jpi, 1:jpj, 1:jpk))       
416      ALLOCATE(zwz_sav(1:jpi, 1:jpj, 1:jpk))       
417      ALLOCATE(zwzts(1:jpi, 1:jpj, 1:jpk)) 
418      ALLOCATE(ztrs(1:jpi, 1:jpj, 1:jpk, 1:kjpt+1))
419      !
420      IF( kt == kit000 )  THEN
421         IF(lwp) WRITE(numout,*)
422         IF(lwp) WRITE(numout,*) 'tra_adv_tvd_zts : TVD ZTS advection scheme on ', cdtype
423         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
424      ENDIF
425      !
426      l_trd = .FALSE.
427      IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE.
428      !
429      IF( l_trd )  THEN
430         ALLOCATE(ztrdx(1:jpi, 1:jpj, 1:jpk))       
431         ALLOCATE(ztrdy(1:jpi, 1:jpj, 1:jpk))       
432         ALLOCATE(ztrdz(1:jpi, 1:jpj, 1:jpk))       
433         ztrdx(:,:,:) = 0._wp  ;    ztrdy(:,:,:) = 0._wp  ;   ztrdz(:,:,:) = 0._wp
434      ENDIF
435      !
436<<<<<<< .working
437      IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
438         ALLOCATE(zptry(1:jpi, 1:jpj, 1:jpk))       
439         zptry(:,:,:) = 0._wp
440      ENDIF
441      !
442=======
443      IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
444         CALL wrk_alloc( jpi, jpj,jpk, zptry )
445         zptry(:,:,:) = 0._wp
446      ENDIF
447      !
448>>>>>>> .merge-right.r7923
449      zwi(:,:,:) = 0._wp
450      z_rzts = 1._wp / REAL( jnzts, wp )
451      zr_p2dt(:) = 1._wp / p2dt(:)
452      !
453      !                                                          ! ===========
454      DO jn = 1, kjpt                                            ! tracer loop
455         !                                                       ! ===========
456         ! 1. Bottom value : flux set to zero
457         ! ----------------------------------
458         zwx(:,:,jpk) = 0._wp   ;    zwz(:,:,jpk) = 0._wp
459         zwy(:,:,jpk) = 0._wp   ;    zwi(:,:,jpk) = 0._wp
460
461         ! 2. upstream advection with initial mass fluxes & intermediate update
462         ! --------------------------------------------------------------------
463         ! upstream tracer flux in the i and j direction
464         DO jk = 1, jpkm1
465            DO jj = 1, jpjm1
466               DO ji = 1, fs_jpim1   ! vector opt.
467                  ! upstream scheme
468                  zfp_ui = pun(ji,jj,jk) + ABS( pun(ji,jj,jk) )
469                  zfm_ui = pun(ji,jj,jk) - ABS( pun(ji,jj,jk) )
470                  zfp_vj = pvn(ji,jj,jk) + ABS( pvn(ji,jj,jk) )
471                  zfm_vj = pvn(ji,jj,jk) - ABS( pvn(ji,jj,jk) )
472                  zwx(ji,jj,jk) = 0.5_wp * ( zfp_ui * ptb(ji,jj,jk,jn) + zfm_ui * ptb(ji+1,jj  ,jk,jn) )
473                  zwy(ji,jj,jk) = 0.5_wp * ( zfp_vj * ptb(ji,jj,jk,jn) + zfm_vj * ptb(ji  ,jj+1,jk,jn) )
474               END DO
475            END DO
476         END DO
477
478         ! upstream tracer flux in the k direction
479         ! Interior value
480         DO jk = 2, jpkm1
481            DO jj = 1, jpj
482               DO ji = 1, jpi
483                  zfp_wk = pwn(ji,jj,jk) + ABS( pwn(ji,jj,jk) )
484                  zfm_wk = pwn(ji,jj,jk) - ABS( pwn(ji,jj,jk) )
485                  zwz(ji,jj,jk) = 0.5_wp * ( zfp_wk * ptb(ji,jj,jk,jn) + zfm_wk * ptb(ji,jj,jk-1,jn) )
486               END DO
487            END DO
488         END DO
489         ! Surface value
490         IF( lk_vvl ) THEN
491            IF ( ln_isfcav ) THEN
492               DO jj = 1, jpj
493                  DO ji = 1, jpi
494                     zwz(ji,jj, mikt(ji,jj) ) = 0.e0          ! volume variable +    isf
495                  END DO
496               END DO
497            ELSE
498               zwz(:,:,1) = 0.e0                              ! volume variable + no isf
499            END IF
500         ELSE
501            IF ( ln_isfcav ) THEN
502               DO jj = 1, jpj
503                  DO ji = 1, jpi
504                     zwz(ji,jj, mikt(ji,jj) ) = pwn(ji,jj,mikt(ji,jj)) * ptb(ji,jj,mikt(ji,jj),jn)   ! linear free surface +    isf
505                  END DO
506               END DO
507            ELSE
508               zwz(:,:,1) = pwn(:,:,1) * ptb(:,:,1,jn)                                               ! linear free surface + no isf
509            END IF
510         ENDIF
511
512         ! total advective trend
513         DO jk = 1, jpkm1
514            z2dtt = p2dt(jk)
515            DO jj = 2, jpjm1
516               DO ji = fs_2, fs_jpim1   ! vector opt.
517                  ! total intermediate advective trends
518                  ztra = - (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk  )   &
519                     &      + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk  )   &
520                     &      + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) ) / e1e2t(ji,jj)
521                  ! update and guess with monotonic sheme
522                  pta(ji,jj,jk,jn) =                       pta(ji,jj,jk,jn) +         ztra   / fse3t_n(ji,jj,jk) * tmask(ji,jj,jk)
523                  zwi(ji,jj,jk)    = ( fse3t_b(ji,jj,jk) * ptb(ji,jj,jk,jn) + z2dtt * ztra ) / fse3t_a(ji,jj,jk) * tmask(ji,jj,jk)
524               END DO
525            END DO
526         END DO
527         !                             ! Lateral boundary conditions on zwi  (unchanged sign)
528         CALL lbc_lnk( zwi, 'T', 1. ) 
529
530         !                                 ! trend diagnostics (contribution of upstream fluxes)
531         IF( l_trd )  THEN 
532            ! store intermediate advective trends
533            ztrdx(:,:,:) = zwx(:,:,:)   ;    ztrdy(:,:,:) = zwy(:,:,:)  ;   ztrdz(:,:,:) = zwz(:,:,:)
534         END IF
535         !                                 ! "Poleward" heat and salt transports (contribution of upstream fluxes)
536         IF( cdtype == 'TRA' .AND. ln_diaptr )  zptry(:,:,:) = zwy(:,:,:)
537
538         ! 3. antidiffusive flux : high order minus low order
539         ! --------------------------------------------------
540         ! antidiffusive flux on i and j
541         !
542         DO jk = 1, jpkm1
543            !
544            DO jj = 1, jpjm1
545               DO ji = 1, fs_jpim1   ! vector opt.
546                  zwx_sav(ji,jj) = zwx(ji,jj,jk)
547                  zwy_sav(ji,jj) = zwy(ji,jj,jk)
548
549                  zwx(ji,jj,jk) = 0.5_wp * pun(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji+1,jj,jk,jn) )
550                  zwy(ji,jj,jk) = 0.5_wp * pvn(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji,jj+1,jk,jn) )
551               END DO
552            END DO
553
554            DO jj = 2, jpjm1         ! partial horizontal divergence
555               DO ji = fs_2, fs_jpim1
556                  zhdiv(ji,jj,jk) = (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk)   &
557                     &               + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk)  )
558               END DO
559            END DO
560
561            DO jj = 1, jpjm1
562               DO ji = 1, fs_jpim1   ! vector opt.
563                  zwx(ji,jj,jk) = zwx(ji,jj,jk)  - zwx_sav(ji,jj)
564                  zwy(ji,jj,jk) = zwy(ji,jj,jk)  - zwy_sav(ji,jj)
565               END DO
566            END DO
567         END DO
568     
569         ! antidiffusive flux on k
570         zwz(:,:,1) = 0._wp        ! Surface value
571         zwz_sav(:,:,:) = zwz(:,:,:)
572         !
573         ztrs(:,:,:,1) = ptb(:,:,:,jn)
574         ztrs(:,:,1,2) = ptb(:,:,1,jn)
575         ztrs(:,:,1,3) = ptb(:,:,1,jn)
576         zwzts(:,:,:) = 0._wp
577
578         DO jl = 1, jnzts                   ! Start of sub timestepping loop
579
580            IF( jl == 1 ) THEN              ! Euler forward to kick things off
581              jtb = 1   ;   jtn = 1   ;   jta = 2
582              zts(:) = p2dt(:) * z_rzts
583              jtaken = MOD( jnzts + 1 , 2)  ! Toggle to collect every second flux
584                                            ! starting at jl =1 if jnzts is odd;
585                                            ! starting at jl =2 otherwise
586            ELSEIF( jl == 2 ) THEN          ! First leapfrog step
587              jtb = 1   ;   jtn = 2   ;   jta = 3
588              zts(:) = 2._wp * p2dt(:) * z_rzts
589            ELSE                            ! Shuffle pointers for subsequent leapfrog steps
590              jtb = MOD(jtb,3) + 1
591              jtn = MOD(jtn,3) + 1
592              jta = MOD(jta,3) + 1
593            ENDIF
594            DO jk = 2, jpkm1          ! Interior value
595               DO jj = 2, jpjm1
596                  DO ji = fs_2, fs_jpim1
597                     zwz(ji,jj,jk) = 0.5_wp * pwn(ji,jj,jk) * ( ztrs(ji,jj,jk,jtn) + ztrs(ji,jj,jk-1,jtn) )
598                     IF( jtaken == 0 ) zwzts(ji,jj,jk) = zwzts(ji,jj,jk) + zwz(ji,jj,jk)*zts(jk)           ! Accumulate time-weighted vertcal flux
599                  END DO
600               END DO
601            END DO
602
603            jtaken = MOD( jtaken + 1 , 2 )
604
605            DO jk = 2, jpkm1          ! Interior value
606               DO jj = 2, jpjm1
607                  DO ji = fs_2, fs_jpim1
608                     zbtr = 1._wp / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) )
609                     ! total advective trends
610                     ztra = - zbtr * (  zhdiv(ji,jj,jk) + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) )
611                     ztrs(ji,jj,jk,jta) = ztrs(ji,jj,jk,jtb) + zts(jk) * ztra
612                  END DO
613               END DO
614            END DO
615
616         END DO
617
618         DO jk = 2, jpkm1          ! Anti-diffusive vertical flux using average flux from the sub-timestepping
619            DO jj = 2, jpjm1
620               DO ji = fs_2, fs_jpim1
621                  zwz(ji,jj,jk) = zwzts(ji,jj,jk) * zr_p2dt(jk) - zwz_sav(ji,jj,jk)
622               END DO
623            END DO
624         END DO
625         CALL lbc_lnk( zwx, 'U', -1. )   ;   CALL lbc_lnk( zwy, 'V', -1. )         ! Lateral bondary conditions
626         CALL lbc_lnk( zwz, 'W',  1. )
627
628         ! 4. monotonicity algorithm
629         ! -------------------------
630         CALL nonosc( ptb(:,:,:,jn), zwx, zwy, zwz, zwi, p2dt )
631
632
633         ! 5. final trend with corrected fluxes
634         ! ------------------------------------
635         DO jk = 1, jpkm1
636            DO jj = 2, jpjm1
637               DO ji = fs_2, fs_jpim1   ! vector opt. 
638                  zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) )
639                  ! total advective trends
640                  ztra = - zbtr * (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk  )   &
641                     &             + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk  )   &
642                     &             + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) )
643                  ! add them to the general tracer trends
644                  pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) + ztra
645               END DO
646            END DO
647         END DO
648
649         !                                 ! trend diagnostics (contribution of upstream fluxes)
650         IF( l_trd )  THEN
651            ztrdx(:,:,:) = ztrdx(:,:,:) + zwx(:,:,:)  ! <<< Add to previously computed
652            ztrdy(:,:,:) = ztrdy(:,:,:) + zwy(:,:,:)  ! <<< Add to previously computed
653            ztrdz(:,:,:) = ztrdz(:,:,:) + zwz(:,:,:)  ! <<< Add to previously computed
654           
655            CALL trd_tra( kt, cdtype, jn, jptra_xad, ztrdx, pun, ptn(:,:,:,jn) )   
656            CALL trd_tra( kt, cdtype, jn, jptra_yad, ztrdy, pvn, ptn(:,:,:,jn) ) 
657            CALL trd_tra( kt, cdtype, jn, jptra_zad, ztrdz, pwn, ptn(:,:,:,jn) ) 
658         END IF
659         !                                 ! "Poleward" heat and salt transports (contribution of upstream fluxes)
660         IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
661            zptry(:,:,:) = zptry(:,:,:) + zwy(:,:,:) 
662            CALL dia_ptr_ohst_components( jn, 'adv', zptry(:,:,:) )
663         ENDIF
664         !
665      END DO
666      !
667      DEALLOCATE(zwi) 
668      DEALLOCATE(zwz) 
669      DEALLOCATE(zhdiv) 
670      DEALLOCATE(zwz_sav) 
671      DEALLOCATE(zwzts)
672      DEALLOCATE(ztrs )
673      DEALLOCATE(zwx_sav) 
674      DEALLOCATE(zwy_sav )
675
676      IF( l_trd )  THEN
677          DEALLOCATE(ztrdx) 
678          DEALLOCATE(ztrdy) 
679          DEALLOCATE(ztrdz)
680      END IF
681
682      IF( cdtype == 'TRA' .AND. ln_diaptr ) DEALLOCATE(zptry )
683      IF( cdtype == 'TRA' .AND. ln_diaptr ) CALL wrk_dealloc( jpi, jpj, jpk, zptry )
684      !
685      IF( nn_timing == 1 )  CALL timing_stop('tra_adv_tvd_zts')
686      !
687   END SUBROUTINE tra_adv_tvd_zts
688
689
690   SUBROUTINE nonosc( pbef, paa, pbb, pcc, paft, p2dt )
691      !!---------------------------------------------------------------------
692      !!                    ***  ROUTINE nonosc  ***
693      !!     
694      !! **  Purpose :   compute monotonic tracer fluxes from the upstream
695      !!       scheme and the before field by a nonoscillatory algorithm
696      !!
697      !! **  Method  :   ... ???
698      !!       warning : pbef and paft must be masked, but the boundaries
699      !!       conditions on the fluxes are not necessary zalezak (1979)
700      !!       drange (1995) multi-dimensional forward-in-time and upstream-
701      !!       in-space based differencing for fluid
702      !!----------------------------------------------------------------------
703      REAL(wp), DIMENSION(jpk)         , INTENT(in   ) ::   p2dt            ! vertical profile of tracer time-step
704      REAL(wp), DIMENSION (jpi,jpj,jpk), INTENT(in   ) ::   pbef, paft      ! before & after field
705      REAL(wp), DIMENSION (jpi,jpj,jpk), INTENT(inout) ::   paa, pbb, pcc   ! monotonic fluxes in the 3 directions
706      !
707      INTEGER  ::   ji, jj, jk   ! dummy loop indices
708      INTEGER  ::   ikm1         ! local integer
709      REAL(wp) ::   zpos, zneg, zbt, za, zb, zc, zbig, zrtrn, z2dtt   ! local scalars
710      REAL(wp) ::   zau, zbu, zcu, zav, zbv, zcv, zup, zdo            !   -      -
711      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: zbetup, zbetdo, zbup, zbdo
712      !!----------------------------------------------------------------------
713      !
714      IF( nn_timing == 1 )  CALL timing_start('nonosc')
715      !
716      ALLOCATE(zbetup(1:jpi, 1:jpj, 1:jpk))
717      ALLOCATE(zbetdo(1:jpi, 1:jpj, 1:jpk))
718      ALLOCATE(zbup(1:jpi, 1:jpj, 1:jpk))
719      ALLOCATE(zbdo(1:jpi, 1:jpj, 1:jpk))
720      !
721      zbig  = 1.e+40_wp
722      zrtrn = 1.e-15_wp
723      zbetup(:,:,:) = 0._wp   ;   zbetdo(:,:,:) = 0._wp
724
725      ! Search local extrema
726      ! --------------------
727      ! max/min of pbef & paft with large negative/positive value (-/+zbig) inside land
728      zbup = MAX( pbef * tmask - zbig * ( 1._wp - tmask ),   &
729         &        paft * tmask - zbig * ( 1._wp - tmask )  )
730      zbdo = MIN( pbef * tmask + zbig * ( 1._wp - tmask ),   &
731         &        paft * tmask + zbig * ( 1._wp - tmask )  )
732
733      DO jk = 1, jpkm1
734         ikm1 = MAX(jk-1,1)
735         z2dtt = p2dt(jk)
736         DO jj = 2, jpjm1
737            DO ji = fs_2, fs_jpim1   ! vector opt.
738
739               ! search maximum in neighbourhood
740               zup = MAX(  zbup(ji  ,jj  ,jk  ),   &
741                  &        zbup(ji-1,jj  ,jk  ), zbup(ji+1,jj  ,jk  ),   &
742                  &        zbup(ji  ,jj-1,jk  ), zbup(ji  ,jj+1,jk  ),   &
743                  &        zbup(ji  ,jj  ,ikm1), zbup(ji  ,jj  ,jk+1)  )
744
745               ! search minimum in neighbourhood
746               zdo = MIN(  zbdo(ji  ,jj  ,jk  ),   &
747                  &        zbdo(ji-1,jj  ,jk  ), zbdo(ji+1,jj  ,jk  ),   &
748                  &        zbdo(ji  ,jj-1,jk  ), zbdo(ji  ,jj+1,jk  ),   &
749                  &        zbdo(ji  ,jj  ,ikm1), zbdo(ji  ,jj  ,jk+1)  )
750
751               ! positive part of the flux
752               zpos = MAX( 0., paa(ji-1,jj  ,jk  ) ) - MIN( 0., paa(ji  ,jj  ,jk  ) )   &
753                  & + MAX( 0., pbb(ji  ,jj-1,jk  ) ) - MIN( 0., pbb(ji  ,jj  ,jk  ) )   &
754                  & + MAX( 0., pcc(ji  ,jj  ,jk+1) ) - MIN( 0., pcc(ji  ,jj  ,jk  ) )
755
756               ! negative part of the flux
757               zneg = MAX( 0., paa(ji  ,jj  ,jk  ) ) - MIN( 0., paa(ji-1,jj  ,jk  ) )   &
758                  & + MAX( 0., pbb(ji  ,jj  ,jk  ) ) - MIN( 0., pbb(ji  ,jj-1,jk  ) )   &
759                  & + MAX( 0., pcc(ji  ,jj  ,jk  ) ) - MIN( 0., pcc(ji  ,jj  ,jk+1) )
760
761               ! up & down beta terms
762               zbt = e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) / z2dtt
763               zbetup(ji,jj,jk) = ( zup            - paft(ji,jj,jk) ) / ( zpos + zrtrn ) * zbt
764               zbetdo(ji,jj,jk) = ( paft(ji,jj,jk) - zdo            ) / ( zneg + zrtrn ) * zbt
765            END DO
766         END DO
767      END DO
768      CALL lbc_lnk( zbetup, 'T', 1. )   ;   CALL lbc_lnk( zbetdo, 'T', 1. )   ! lateral boundary cond. (unchanged sign)
769
770      ! 3. monotonic flux in the i & j direction (paa & pbb)
771      ! ----------------------------------------
772      DO jk = 1, jpkm1
773         DO jj = 2, jpjm1
774            DO ji = fs_2, fs_jpim1   ! vector opt.
775               zau = MIN( 1._wp, zbetdo(ji,jj,jk), zbetup(ji+1,jj,jk) )
776               zbu = MIN( 1._wp, zbetup(ji,jj,jk), zbetdo(ji+1,jj,jk) )
777               zcu =       ( 0.5  + SIGN( 0.5 , paa(ji,jj,jk) ) )
778               paa(ji,jj,jk) = paa(ji,jj,jk) * ( zcu * zau + ( 1._wp - zcu) * zbu )
779
780               zav = MIN( 1._wp, zbetdo(ji,jj,jk), zbetup(ji,jj+1,jk) )
781               zbv = MIN( 1._wp, zbetup(ji,jj,jk), zbetdo(ji,jj+1,jk) )
782               zcv =       ( 0.5  + SIGN( 0.5 , pbb(ji,jj,jk) ) )
783               pbb(ji,jj,jk) = pbb(ji,jj,jk) * ( zcv * zav + ( 1._wp - zcv) * zbv )
784
785      ! monotonic flux in the k direction, i.e. pcc
786      ! -------------------------------------------
787               za = MIN( 1., zbetdo(ji,jj,jk+1), zbetup(ji,jj,jk) )
788               zb = MIN( 1., zbetup(ji,jj,jk+1), zbetdo(ji,jj,jk) )
789               zc =       ( 0.5  + SIGN( 0.5 , pcc(ji,jj,jk+1) ) )
790               pcc(ji,jj,jk+1) = pcc(ji,jj,jk+1) * ( zc * za + ( 1._wp - zc) * zb )
791            END DO
792         END DO
793      END DO
794      CALL lbc_lnk( paa, 'U', -1. )   ;   CALL lbc_lnk( pbb, 'V', -1. )   ! lateral boundary condition (changed sign)
795      !
796      DEALLOCATE(zbetup)
797      DEALLOCATE(zbetdo) 
798      DEALLOCATE(zbup)
799      DEALLOCATE(zbdo)
800      !
801      IF( nn_timing == 1 )  CALL timing_stop('nonosc')
802      !
803   END SUBROUTINE nonosc
804
805   !!======================================================================
806END MODULE traadv_tvd
Note: See TracBrowser for help on using the repository browser.