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

source: branches/UKMO/dev_r5518_GO6_package_OMP/NEMOGCM/NEMO/OPA_SRC/TRA/traadv_tvd.F90 @ 9176

Last change on this file since 9176 was 9176, checked in by andmirek, 6 years ago

#2001: OMP directives
File size: 33.9 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
37   IMPLICIT NONE
38   PRIVATE
39
40   PUBLIC   tra_adv_tvd        ! routine called by traadv.F90
41   PUBLIC   tra_adv_tvd_zts    ! routine called by traadv.F90
42
43   LOGICAL ::   l_trd   ! flag to compute trends
44
45   !! * Substitutions
46#  include "domzgr_substitute.h90"
47#  include "vectopt_loop_substitute.h90"
48   !!----------------------------------------------------------------------
49   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
50   !! $Id$
51   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
52   !!----------------------------------------------------------------------
53CONTAINS
54
55   SUBROUTINE tra_adv_tvd ( kt, kit000, cdtype, p2dt, pun, pvn, pwn,      &
56      &                                       ptb, ptn, pta, kjpt )
57      !!----------------------------------------------------------------------
58      !!                  ***  ROUTINE tra_adv_tvd  ***
59      !!
60      !! **  Purpose :   Compute the now trend due to total advection of
61      !!       tracers and add it to the general trend of tracer equations
62      !!
63      !! **  Method  :   TVD scheme, i.e. 2nd order centered scheme with
64      !!       corrected flux (monotonic correction)
65      !!       note: - this advection scheme needs a leap-frog time scheme
66      !!
67      !! ** Action : - update (pta) with the now advective tracer trends
68      !!             - save the trends
69      !!----------------------------------------------------------------------
70      USE oce     , ONLY:   zwx => ua        , zwy => va          ! (ua,va) used as workspace
71      !
72      INTEGER                              , INTENT(in   ) ::   kt              ! ocean time-step index
73      INTEGER                              , INTENT(in   ) ::   kit000          ! first time step index
74      CHARACTER(len=3)                     , INTENT(in   ) ::   cdtype          ! =TRA or TRC (tracer indicator)
75      INTEGER                              , INTENT(in   ) ::   kjpt            ! number of tracers
76      REAL(wp), DIMENSION(        jpk     ), INTENT(in   ) ::   p2dt            ! vertical profile of tracer time-step
77      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(in   ) ::   pun, pvn, pwn   ! 3 ocean velocity components
78      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in   ) ::   ptb, ptn        ! before and now tracer fields
79      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(inout) ::   pta             ! tracer trend
80      !
81      INTEGER  ::   ji, jj, jk, jn           ! dummy loop indices
82      INTEGER  ::   ik 
83      REAL(wp) ::   z2dtt, zbtr, ztra        ! local scalar
84      REAL(wp) ::   zfp_ui, zfp_vj, zfp_wk   !   -      -
85      REAL(wp) ::   zfm_ui, zfm_vj, zfm_wk   !   -      -
86      REAL(wp), POINTER, DIMENSION(:,:,:) :: zwi, zwz
87      REAL(wp), POINTER, DIMENSION(:,:,:) :: ztrdx, ztrdy, ztrdz
88      !!----------------------------------------------------------------------
89      !
90      IF( nn_timing == 1 )  CALL timing_start('tra_adv_tvd')
91      !
92      CALL wrk_alloc( jpi, jpj, jpk, zwi, zwz )
93      !
94      IF( kt == kit000 )  THEN
95         IF(lwp) WRITE(numout,*)
96         IF(lwp) WRITE(numout,*) 'tra_adv_tvd : TVD advection scheme on ', cdtype
97         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
98         !
99         l_trd = .FALSE.
100         IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE.
101      ENDIF
102      !
103      IF( l_trd )  THEN
104         CALL wrk_alloc( jpi, jpj, jpk, ztrdx, ztrdy, ztrdz )
105         ztrdx(:,:,:) = 0.e0   ;    ztrdy(:,:,:) = 0.e0   ;   ztrdz(:,:,:) = 0.e0
106      ENDIF
107      !
108      zwi(:,:,:) = 0.e0 ; 
109      !
110      !                                                          ! ===========
111      DO jn = 1, kjpt                                            ! tracer loop
112         !                                                       ! ===========
113         ! 1. Bottom and k=1 value : flux set to zero
114         ! ----------------------------------
115         zwx(:,:,jpk) = 0.e0    ;    zwz(:,:,jpk) = 0.e0
116         zwy(:,:,jpk) = 0.e0    ;    zwi(:,:,jpk) = 0.e0
117         
118         zwz(:,:,1  ) = 0._wp
119         ! 2. upstream advection with initial mass fluxes & intermediate update
120         ! --------------------------------------------------------------------
121         ! upstream tracer flux in the i and j direction
122!$OMP PARALLEL DO PRIVATE(zfp_ui, zfm_ui, zfp_vj, zfm_vj)
123         DO jk = 1, jpkm1
124            DO jj = 1, jpjm1
125               DO ji = 1, fs_jpim1   ! vector opt.
126                  ! upstream scheme
127                  zfp_ui = pun(ji,jj,jk) + ABS( pun(ji,jj,jk) )
128                  zfm_ui = pun(ji,jj,jk) - ABS( pun(ji,jj,jk) )
129                  zfp_vj = pvn(ji,jj,jk) + ABS( pvn(ji,jj,jk) )
130                  zfm_vj = pvn(ji,jj,jk) - ABS( pvn(ji,jj,jk) )
131                  zwx(ji,jj,jk) = 0.5 * ( zfp_ui * ptb(ji,jj,jk,jn) + zfm_ui * ptb(ji+1,jj  ,jk,jn) )
132                  zwy(ji,jj,jk) = 0.5 * ( zfp_vj * ptb(ji,jj,jk,jn) + zfm_vj * ptb(ji  ,jj+1,jk,jn) )
133               END DO
134            END DO
135         END DO
136!$OMP END PARALLEL DO
137         ! upstream tracer flux in the k direction
138         ! Interior value
139!$OMP PARALLEL DO PRIVATE(zfp_wk, zfm_wk)
140         DO jk = 2, jpkm1
141            DO jj = 1, jpj
142               DO ji = 1, jpi
143                  zfp_wk = pwn(ji,jj,jk) + ABS( pwn(ji,jj,jk) )
144                  zfm_wk = pwn(ji,jj,jk) - ABS( pwn(ji,jj,jk) )
145                  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)
146               END DO
147            END DO
148         END DO
149!$OMP END PARALLEL DO
150         ! Surface value
151         IF( lk_vvl ) THEN   
152            IF ( ln_isfcav ) THEN
153               DO jj = 1, jpj
154                  DO ji = 1, jpi
155                     zwz(ji,jj, mikt(ji,jj) ) = 0.e0          ! volume variable
156                  END DO
157               END DO
158            ELSE
159               zwz(:,:,1) = 0.e0          ! volume variable
160            END IF
161         ELSE               
162            IF ( ln_isfcav ) THEN
163!$OMP PARALLEL DO
164               DO jj = 1, jpj
165                  DO ji = 1, jpi
166                     zwz(ji,jj, mikt(ji,jj) ) = pwn(ji,jj,mikt(ji,jj)) * ptb(ji,jj,mikt(ji,jj),jn)   ! linear free surface
167                  END DO
168               END DO
169!$OMP END PARALLEL DO   
170            ELSE
171               zwz(:,:,1) = pwn(:,:,1) * ptb(:,:,1,jn)   ! linear free surface
172            END IF
173         ENDIF
174
175         ! total advective trend
176!$OMP PARALLEL DO PRIVATE(z2dtt, ztra)
177         DO jk = 1, jpkm1
178            z2dtt = p2dt(jk)
179            DO jj = 2, jpjm1
180               DO ji = fs_2, fs_jpim1   ! vector opt.
181                  ! total intermediate advective trends
182                  ztra = - (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk  )   &
183                     &      + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk  )   &
184                     &      + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) ) / e1e2t(ji,jj)
185                  ! update and guess with monotonic sheme
186                  pta(ji,jj,jk,jn) =                       pta(ji,jj,jk,jn) +         ztra   / fse3t_n(ji,jj,jk) * tmask(ji,jj,jk)
187                  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)
188               END DO
189            END DO
190         END DO
191!$OMP END PARALLEL DO
192         !                             ! Lateral boundary conditions on zwi  (unchanged sign)
193         CALL lbc_lnk( zwi, 'T', 1. ) 
194
195         !                                 ! trend diagnostics (contribution of upstream fluxes)
196         IF( l_trd )  THEN 
197            ! store intermediate advective trends
198            ztrdx(:,:,:) = zwx(:,:,:)   ;    ztrdy(:,:,:) = zwy(:,:,:)  ;   ztrdz(:,:,:) = zwz(:,:,:)
199         END IF
200         !                                 ! "Poleward" heat and salt transports (contribution of upstream fluxes)
201         IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
202           IF( jn == jp_tem )  htr_adv(:) = ptr_sj( zwy(:,:,:) )
203           IF( jn == jp_sal )  str_adv(:) = ptr_sj( zwy(:,:,:) )
204         ENDIF
205
206         ! 3. antidiffusive flux : high order minus low order
207         ! --------------------------------------------------
208         ! antidiffusive flux on i and j
209!$OMP PARALLEL DO
210         DO jk = 1, jpkm1
211            DO jj = 1, jpjm1
212               DO ji = 1, fs_jpim1   ! vector opt.
213                  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)
214                  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)
215               END DO
216            END DO
217         END DO
218!$OMP END PARALLEL DO
219         ! antidiffusive flux on k
220         ! Interior value
221!$OMP PARALLEL DO
222         DO jk = 2, jpkm1                   
223            DO jj = 1, jpj
224               DO ji = 1, jpi
225                  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)
226               END DO
227            END DO
228         END DO
229!$OMP END PARALLEL DO
230         ! surface value
231         IF ( ln_isfcav ) THEN
232            DO jj = 1, jpj
233               DO ji = 1, jpi
234                  zwz(ji,jj,mikt(ji,jj)) = 0.e0
235               END DO
236            END DO
237         ELSE
238            zwz(:,:,1) = 0.e0
239         END IF
240         CALL lbc_lnk( zwx, 'U', -1. )   ;   CALL lbc_lnk( zwy, 'V', -1. )         ! Lateral bondary conditions
241         CALL lbc_lnk( zwz, 'W',  1. )
242
243         ! 4. monotonicity algorithm
244         ! -------------------------
245         CALL nonosc( ptb(:,:,:,jn), zwx, zwy, zwz, zwi, p2dt )
246
247
248         ! 5. final trend with corrected fluxes
249         ! ------------------------------------
250!$OMP PARALLEL DO PRIVATE(zbtr, ztra)
251         DO jk = 1, jpkm1
252            DO jj = 2, jpjm1
253               DO ji = fs_2, fs_jpim1   ! vector opt. 
254                  zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) )
255                  ! total advective trends
256                  ztra = - zbtr * (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk  )   &
257                     &             + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk  )   &
258                     &             + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) )
259                  ! add them to the general tracer trends
260                  pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) + ztra * tmask(ji,jj,jk)
261               END DO
262            END DO
263         END DO
264!$OMP END PARALLEL DO
265         !                                 ! trend diagnostics (contribution of upstream fluxes)
266         IF( l_trd )  THEN
267            ztrdx(:,:,:) = ztrdx(:,:,:) + zwx(:,:,:)  ! <<< Add to previously computed
268            ztrdy(:,:,:) = ztrdy(:,:,:) + zwy(:,:,:)  ! <<< Add to previously computed
269            ztrdz(:,:,:) = ztrdz(:,:,:) + zwz(:,:,:)  ! <<< Add to previously computed
270           
271            CALL trd_tra( kt, cdtype, jn, jptra_xad, ztrdx, pun, ptn(:,:,:,jn) )   
272            CALL trd_tra( kt, cdtype, jn, jptra_yad, ztrdy, pvn, ptn(:,:,:,jn) ) 
273            CALL trd_tra( kt, cdtype, jn, jptra_zad, ztrdz, pwn, ptn(:,:,:,jn) ) 
274         END IF
275         !                                 ! "Poleward" heat and salt transports (contribution of upstream fluxes)
276         IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
277           IF( jn == jp_tem )  htr_adv(:) = ptr_sj( zwy(:,:,:) ) + htr_adv(:)
278           IF( jn == jp_sal )  str_adv(:) = ptr_sj( zwy(:,:,:) ) + str_adv(:)
279         ENDIF
280         !
281      END DO
282      !
283                   CALL wrk_dealloc( jpi, jpj, jpk, zwi, zwz )
284      IF( l_trd )  CALL wrk_dealloc( jpi, jpj, jpk, ztrdx, ztrdy, ztrdz )
285      !
286      IF( nn_timing == 1 )  CALL timing_stop('tra_adv_tvd')
287      !
288   END SUBROUTINE tra_adv_tvd
289
290   SUBROUTINE tra_adv_tvd_zts ( kt, kit000, cdtype, p2dt, pun, pvn, pwn,      &
291      &                                       ptb, ptn, pta, kjpt )
292      !!----------------------------------------------------------------------
293      !!                  ***  ROUTINE tra_adv_tvd_zts  ***
294      !!
295      !! **  Purpose :   Compute the now trend due to total advection of
296      !!       tracers and add it to the general trend of tracer equations
297      !!
298      !! **  Method  :   TVD ZTS scheme, i.e. 2nd order centered scheme with
299      !!       corrected flux (monotonic correction). This version use sub-
300      !!       timestepping for the vertical advection which increases stability
301      !!       when vertical metrics are small.
302      !!       note: - this advection scheme needs a leap-frog time scheme
303      !!
304      !! ** Action : - update (pta) with the now advective tracer trends
305      !!             - save the trends
306      !!----------------------------------------------------------------------
307      USE oce     , ONLY:   zwx => ua        , zwy => va          ! (ua,va) used as workspace
308      !
309      INTEGER                              , INTENT(in   ) ::   kt              ! ocean time-step index
310      INTEGER                              , INTENT(in   ) ::   kit000          ! first time step index
311      CHARACTER(len=3)                     , INTENT(in   ) ::   cdtype          ! =TRA or TRC (tracer indicator)
312      INTEGER                              , INTENT(in   ) ::   kjpt            ! number of tracers
313      REAL(wp), DIMENSION(        jpk     ), INTENT(in   ) ::   p2dt            ! vertical profile of tracer time-step
314      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(in   ) ::   pun, pvn, pwn   ! 3 ocean velocity components
315      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in   ) ::   ptb, ptn        ! before and now tracer fields
316      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(inout) ::   pta             ! tracer trend
317      !
318      REAL(wp), DIMENSION( jpk )                           ::   zts             ! length of sub-timestep for vertical advection
319      REAL(wp), DIMENSION( jpk )                           ::   zr_p2dt         ! reciprocal of tracer timestep
320      INTEGER  ::   ji, jj, jk, jl, jn       ! dummy loop indices 
321      INTEGER  ::   jnzts = 5       ! number of sub-timesteps for vertical advection
322      INTEGER  ::   jtb, jtn, jta   ! sub timestep pointers for leap-frog/euler forward steps
323      INTEGER  ::   jtaken          ! toggle for collecting appropriate fluxes from sub timesteps
324      REAL(wp) ::   z_rzts          ! Fractional length of Euler forward sub-timestep for vertical advection
325      REAL(wp) ::   z2dtt, zbtr, ztra        ! local scalar
326      REAL(wp) ::   zfp_ui, zfp_vj, zfp_wk   !   -      -
327      REAL(wp) ::   zfm_ui, zfm_vj, zfm_wk   !   -      -
328      REAL(wp), POINTER, DIMENSION(:,:  ) :: zwx_sav , zwy_sav
329      REAL(wp), POINTER, DIMENSION(:,:,:) :: zwi, zwz, zhdiv, zwz_sav, zwzts
330      REAL(wp), POINTER, DIMENSION(:,:,:) :: ztrdx, ztrdy, ztrdz
331      REAL(wp), POINTER, DIMENSION(:,:,:,:) :: ztrs
332      !!----------------------------------------------------------------------
333      !
334      IF( nn_timing == 1 )  CALL timing_start('tra_adv_tvd_zts')
335      !
336      CALL wrk_alloc( jpi, jpj, zwx_sav, zwy_sav )
337      CALL wrk_alloc( jpi, jpj, jpk, zwi, zwz , zhdiv, zwz_sav, zwzts )
338      CALL wrk_alloc( jpi, jpj, jpk, kjpt+1, ztrs )
339      !
340      IF( kt == kit000 )  THEN
341         IF(lwp) WRITE(numout,*)
342         IF(lwp) WRITE(numout,*) 'tra_adv_tvd_zts : TVD ZTS advection scheme on ', cdtype
343         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
344      ENDIF
345      !
346      l_trd = .FALSE.
347      IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE.
348      !
349      IF( l_trd )  THEN
350         CALL wrk_alloc( jpi, jpj, jpk, ztrdx, ztrdy, ztrdz )
351         ztrdx(:,:,:) = 0._wp  ;    ztrdy(:,:,:) = 0._wp  ;   ztrdz(:,:,:) = 0._wp
352      ENDIF
353      !
354      zwi(:,:,:) = 0._wp
355      z_rzts = 1._wp / REAL( jnzts, wp )
356      zr_p2dt(:) = 1._wp / p2dt(:)
357      !
358      !                                                          ! ===========
359      DO jn = 1, kjpt                                            ! tracer loop
360         !                                                       ! ===========
361         ! 1. Bottom value : flux set to zero
362         ! ----------------------------------
363         zwx(:,:,jpk) = 0._wp   ;    zwz(:,:,jpk) = 0._wp
364         zwy(:,:,jpk) = 0._wp   ;    zwi(:,:,jpk) = 0._wp
365
366         ! 2. upstream advection with initial mass fluxes & intermediate update
367         ! --------------------------------------------------------------------
368         ! upstream tracer flux in the i and j direction
369!$OMP PARALLEL DO PRIVATE(zfp_ui, zfm_ui, zfp_vj, zfm_vj)
370         DO jk = 1, jpkm1
371            DO jj = 1, jpjm1
372               DO ji = 1, fs_jpim1   ! vector opt.
373                  ! upstream scheme
374                  zfp_ui = pun(ji,jj,jk) + ABS( pun(ji,jj,jk) )
375                  zfm_ui = pun(ji,jj,jk) - ABS( pun(ji,jj,jk) )
376                  zfp_vj = pvn(ji,jj,jk) + ABS( pvn(ji,jj,jk) )
377                  zfm_vj = pvn(ji,jj,jk) - ABS( pvn(ji,jj,jk) )
378                  zwx(ji,jj,jk) = 0.5_wp * ( zfp_ui * ptb(ji,jj,jk,jn) + zfm_ui * ptb(ji+1,jj  ,jk,jn) )
379                  zwy(ji,jj,jk) = 0.5_wp * ( zfp_vj * ptb(ji,jj,jk,jn) + zfm_vj * ptb(ji  ,jj+1,jk,jn) )
380               END DO
381            END DO
382         END DO
383!$OMP END PARALLEL DO
384         ! upstream tracer flux in the k direction
385         ! Interior value
386!$OMP PARALLEL DO PRIVATE(zfp_wk, zfm_wk)
387         DO jk = 2, jpkm1
388            DO jj = 1, jpj
389               DO ji = 1, jpi
390                  zfp_wk = pwn(ji,jj,jk) + ABS( pwn(ji,jj,jk) )
391                  zfm_wk = pwn(ji,jj,jk) - ABS( pwn(ji,jj,jk) )
392                  zwz(ji,jj,jk) = 0.5_wp * ( zfp_wk * ptb(ji,jj,jk,jn) + zfm_wk * ptb(ji,jj,jk-1,jn) )
393               END DO
394            END DO
395         END DO
396!$OMP END PARALLEL DO
397         ! Surface value
398         IF( lk_vvl ) THEN
399            IF ( ln_isfcav ) THEN
400               DO jj = 1, jpj
401                  DO ji = 1, jpi
402                     zwz(ji,jj, mikt(ji,jj) ) = 0.e0          ! volume variable +    isf
403                  END DO
404               END DO
405            ELSE
406               zwz(:,:,1) = 0.e0                              ! volume variable + no isf
407            END IF
408         ELSE
409            IF ( ln_isfcav ) THEN
410!$OMP PARALLEL DO
411               DO jj = 1, jpj
412                  DO ji = 1, jpi
413                     zwz(ji,jj, mikt(ji,jj) ) = pwn(ji,jj,mikt(ji,jj)) * ptb(ji,jj,mikt(ji,jj),jn)   ! linear free surface +    isf
414                  END DO
415               END DO
416!$OMP END PARALLEL DO
417            ELSE
418               zwz(:,:,1) = pwn(:,:,1) * ptb(:,:,1,jn)                                               ! linear free surface + no isf
419            END IF
420         ENDIF
421
422         ! total advective trend
423!$OMP PARALLEL DO PRIVATE(z2dtt, ztra)
424         DO jk = 1, jpkm1
425            z2dtt = p2dt(jk)
426            DO jj = 2, jpjm1
427               DO ji = fs_2, fs_jpim1   ! vector opt.
428                  ! total intermediate advective trends
429                  ztra = - (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk  )   &
430                     &      + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk  )   &
431                     &      + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) ) / e1e2t(ji,jj)
432                  ! update and guess with monotonic sheme
433                  pta(ji,jj,jk,jn) =                       pta(ji,jj,jk,jn) +         ztra   / fse3t_n(ji,jj,jk) * tmask(ji,jj,jk)
434                  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)
435               END DO
436            END DO
437         END DO
438!$OMP END PARALLEL DO
439         !                             ! Lateral boundary conditions on zwi  (unchanged sign)
440         CALL lbc_lnk( zwi, 'T', 1. ) 
441
442         !                                 ! trend diagnostics (contribution of upstream fluxes)
443         IF( l_trd )  THEN 
444            ! store intermediate advective trends
445            ztrdx(:,:,:) = zwx(:,:,:)   ;    ztrdy(:,:,:) = zwy(:,:,:)  ;   ztrdz(:,:,:) = zwz(:,:,:)
446         END IF
447         !                                 ! "Poleward" heat and salt transports (contribution of upstream fluxes)
448         IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
449           IF( jn == jp_tem )  htr_adv(:) = ptr_sj( zwy(:,:,:) )
450           IF( jn == jp_sal )  str_adv(:) = ptr_sj( zwy(:,:,:) )
451         ENDIF
452
453         ! 3. antidiffusive flux : high order minus low order
454         ! --------------------------------------------------
455         ! antidiffusive flux on i and j
456         !
457!$OMP PARALLEL DO
458         DO jk = 1, jpkm1
459            !
460            DO jj = 1, jpjm1
461               DO ji = 1, fs_jpim1   ! vector opt.
462                  zwx_sav(ji,jj) = zwx(ji,jj,jk)
463                  zwy_sav(ji,jj) = zwy(ji,jj,jk)
464
465                  zwx(ji,jj,jk) = 0.5_wp * pun(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji+1,jj,jk,jn) )
466                  zwy(ji,jj,jk) = 0.5_wp * pvn(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji,jj+1,jk,jn) )
467               END DO
468            END DO
469
470            DO jj = 2, jpjm1         ! partial horizontal divergence
471               DO ji = fs_2, fs_jpim1
472                  zhdiv(ji,jj,jk) = (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk)   &
473                     &               + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk)  )
474               END DO
475            END DO
476
477            DO jj = 1, jpjm1
478               DO ji = 1, fs_jpim1   ! vector opt.
479                  zwx(ji,jj,jk) = zwx(ji,jj,jk)  - zwx_sav(ji,jj)
480                  zwy(ji,jj,jk) = zwy(ji,jj,jk)  - zwy_sav(ji,jj)
481               END DO
482            END DO
483         END DO
484!$OMP END PARALLEL DO     
485         ! antidiffusive flux on k
486         zwz(:,:,1) = 0._wp        ! Surface value
487         zwz_sav(:,:,:) = zwz(:,:,:)
488         !
489         ztrs(:,:,:,1) = ptb(:,:,:,jn)
490         ztrs(:,:,1,2) = ptb(:,:,1,jn)
491         ztrs(:,:,1,3) = ptb(:,:,1,jn)
492         zwzts(:,:,:) = 0._wp
493
494         DO jl = 1, jnzts                   ! Start of sub timestepping loop
495
496            IF( jl == 1 ) THEN              ! Euler forward to kick things off
497              jtb = 1   ;   jtn = 1   ;   jta = 2
498              zts(:) = p2dt(:) * z_rzts
499              jtaken = MOD( jnzts + 1 , 2)  ! Toggle to collect every second flux
500                                            ! starting at jl =1 if jnzts is odd;
501                                            ! starting at jl =2 otherwise
502            ELSEIF( jl == 2 ) THEN          ! First leapfrog step
503              jtb = 1   ;   jtn = 2   ;   jta = 3
504              zts(:) = 2._wp * p2dt(:) * z_rzts
505            ELSE                            ! Shuffle pointers for subsequent leapfrog steps
506              jtb = MOD(jtb,3) + 1
507              jtn = MOD(jtn,3) + 1
508              jta = MOD(jta,3) + 1
509            ENDIF
510!$OMP PARALLEL DO
511            DO jk = 2, jpkm1          ! Interior value
512               DO jj = 2, jpjm1
513                  DO ji = fs_2, fs_jpim1
514                     zwz(ji,jj,jk) = 0.5_wp * pwn(ji,jj,jk) * ( ztrs(ji,jj,jk,jtn) + ztrs(ji,jj,jk-1,jtn) )
515                     IF( jtaken == 0 ) zwzts(ji,jj,jk) = zwzts(ji,jj,jk) + zwz(ji,jj,jk)*zts(jk)           ! Accumulate time-weighted vertcal flux
516                  END DO
517               END DO
518            END DO
519!$OMP END PARALLEL DO
520            jtaken = MOD( jtaken + 1 , 2 )
521!$OMP PARALLEL DO PRIVATE (zbtr, ztra)
522            DO jk = 2, jpkm1          ! Interior value
523               DO jj = 2, jpjm1
524                  DO ji = fs_2, fs_jpim1
525                     zbtr = 1._wp / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) )
526                     ! total advective trends
527                     ztra = - zbtr * (  zhdiv(ji,jj,jk) + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) )
528                     ztrs(ji,jj,jk,jta) = ztrs(ji,jj,jk,jtb) + zts(jk) * ztra
529                  END DO
530               END DO
531            END DO
532!$OMP END PARALLEL DO
533         END DO
534!$OMP PARALLEL DO
535         DO jk = 2, jpkm1          ! Anti-diffusive vertical flux using average flux from the sub-timestepping
536            DO jj = 2, jpjm1
537               DO ji = fs_2, fs_jpim1
538                  zwz(ji,jj,jk) = zwzts(ji,jj,jk) * zr_p2dt(jk) - zwz_sav(ji,jj,jk)
539               END DO
540            END DO
541         END DO
542!$OMP END PARALLEL DO
543         CALL lbc_lnk( zwx, 'U', -1. )   ;   CALL lbc_lnk( zwy, 'V', -1. )         ! Lateral bondary conditions
544         CALL lbc_lnk( zwz, 'W',  1. )
545
546         ! 4. monotonicity algorithm
547         ! -------------------------
548         CALL nonosc( ptb(:,:,:,jn), zwx, zwy, zwz, zwi, p2dt )
549
550
551         ! 5. final trend with corrected fluxes
552         ! ------------------------------------
553!$OMP PARALLEL DO PRIVATE(zbtr, ztra)
554         DO jk = 1, jpkm1
555            DO jj = 2, jpjm1
556               DO ji = fs_2, fs_jpim1   ! vector opt. 
557                  zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) )
558                  ! total advective trends
559                  ztra = - zbtr * (  zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk  )   &
560                     &             + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk  )   &
561                     &             + zwz(ji,jj,jk) - zwz(ji  ,jj  ,jk+1) )
562                  ! add them to the general tracer trends
563                  pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) + ztra
564               END DO
565            END DO
566         END DO
567!$OMP END PARALLEL DO
568         !                                 ! trend diagnostics (contribution of upstream fluxes)
569         IF( l_trd )  THEN
570            ztrdx(:,:,:) = ztrdx(:,:,:) + zwx(:,:,:)  ! <<< Add to previously computed
571            ztrdy(:,:,:) = ztrdy(:,:,:) + zwy(:,:,:)  ! <<< Add to previously computed
572            ztrdz(:,:,:) = ztrdz(:,:,:) + zwz(:,:,:)  ! <<< Add to previously computed
573           
574            CALL trd_tra( kt, cdtype, jn, jptra_xad, ztrdx, pun, ptn(:,:,:,jn) )   
575            CALL trd_tra( kt, cdtype, jn, jptra_yad, ztrdy, pvn, ptn(:,:,:,jn) ) 
576            CALL trd_tra( kt, cdtype, jn, jptra_zad, ztrdz, pwn, ptn(:,:,:,jn) ) 
577         END IF
578         !                                 ! "Poleward" heat and salt transports (contribution of upstream fluxes)
579         IF( cdtype == 'TRA' .AND. ln_diaptr ) THEN 
580           IF( jn == jp_tem )  htr_adv(:) = ptr_sj( zwy(:,:,:) ) + htr_adv(:)
581           IF( jn == jp_sal )  str_adv(:) = ptr_sj( zwy(:,:,:) ) + str_adv(:)
582         ENDIF
583         !
584      END DO
585      !
586                   CALL wrk_dealloc( jpi, jpj, jpk, zwi, zwz, zhdiv, zwz_sav, zwzts )
587                   CALL wrk_dealloc( jpi, jpj, jpk, kjpt+1, ztrs )
588                   CALL wrk_dealloc( jpi, jpj, zwx_sav, zwy_sav )
589      IF( l_trd )  CALL wrk_dealloc( jpi, jpj, jpk, ztrdx, ztrdy, ztrdz )
590      !
591      IF( nn_timing == 1 )  CALL timing_stop('tra_adv_tvd_zts')
592      !
593   END SUBROUTINE tra_adv_tvd_zts
594
595
596   SUBROUTINE nonosc( pbef, paa, pbb, pcc, paft, p2dt )
597      !!---------------------------------------------------------------------
598      !!                    ***  ROUTINE nonosc  ***
599      !!     
600      !! **  Purpose :   compute monotonic tracer fluxes from the upstream
601      !!       scheme and the before field by a nonoscillatory algorithm
602      !!
603      !! **  Method  :   ... ???
604      !!       warning : pbef and paft must be masked, but the boundaries
605      !!       conditions on the fluxes are not necessary zalezak (1979)
606      !!       drange (1995) multi-dimensional forward-in-time and upstream-
607      !!       in-space based differencing for fluid
608      !!----------------------------------------------------------------------
609      REAL(wp), DIMENSION(jpk)         , INTENT(in   ) ::   p2dt            ! vertical profile of tracer time-step
610      REAL(wp), DIMENSION (jpi,jpj,jpk), INTENT(in   ) ::   pbef, paft      ! before & after field
611      REAL(wp), DIMENSION (jpi,jpj,jpk), INTENT(inout) ::   paa, pbb, pcc   ! monotonic fluxes in the 3 directions
612      !
613      INTEGER  ::   ji, jj, jk   ! dummy loop indices
614      INTEGER  ::   ikm1         ! local integer
615      REAL(wp) ::   zpos, zneg, zbt, za, zb, zc, zbig, zrtrn, z2dtt   ! local scalars
616      REAL(wp) ::   zau, zbu, zcu, zav, zbv, zcv, zup, zdo            !   -      -
617      REAL(wp), POINTER, DIMENSION(:,:,:) :: zbetup, zbetdo, zbup, zbdo
618      !!----------------------------------------------------------------------
619      !
620      IF( nn_timing == 1 )  CALL timing_start('nonosc')
621      !
622      CALL wrk_alloc( jpi, jpj, jpk, zbetup, zbetdo, zbup, zbdo )
623      !
624      zbig  = 1.e+40_wp
625      zrtrn = 1.e-15_wp
626      zbetup(:,:,:) = 0._wp   ;   zbetdo(:,:,:) = 0._wp
627
628      ! Search local extrema
629      ! --------------------
630      ! max/min of pbef & paft with large negative/positive value (-/+zbig) inside land
631      zbup = MAX( pbef * tmask - zbig * ( 1._wp - tmask ),   &
632         &        paft * tmask - zbig * ( 1._wp - tmask )  )
633      zbdo = MIN( pbef * tmask + zbig * ( 1._wp - tmask ),   &
634         &        paft * tmask + zbig * ( 1._wp - tmask )  )
635
636!$OMP PARALLEL DO PRIVATE(ikm1, z2dtt, zup, zdo, zpos, zneg, zbt)
637      DO jk = 1, jpkm1
638         ikm1 = MAX(jk-1,1)
639         z2dtt = p2dt(jk)
640         DO jj = 2, jpjm1
641            DO ji = fs_2, fs_jpim1   ! vector opt.
642
643               ! search maximum in neighbourhood
644               zup = MAX(  zbup(ji  ,jj  ,jk  ),   &
645                  &        zbup(ji-1,jj  ,jk  ), zbup(ji+1,jj  ,jk  ),   &
646                  &        zbup(ji  ,jj-1,jk  ), zbup(ji  ,jj+1,jk  ),   &
647                  &        zbup(ji  ,jj  ,ikm1), zbup(ji  ,jj  ,jk+1)  )
648
649               ! search minimum in neighbourhood
650               zdo = MIN(  zbdo(ji  ,jj  ,jk  ),   &
651                  &        zbdo(ji-1,jj  ,jk  ), zbdo(ji+1,jj  ,jk  ),   &
652                  &        zbdo(ji  ,jj-1,jk  ), zbdo(ji  ,jj+1,jk  ),   &
653                  &        zbdo(ji  ,jj  ,ikm1), zbdo(ji  ,jj  ,jk+1)  )
654
655               ! positive part of the flux
656               zpos = MAX( 0., paa(ji-1,jj  ,jk  ) ) - MIN( 0., paa(ji  ,jj  ,jk  ) )   &
657                  & + MAX( 0., pbb(ji  ,jj-1,jk  ) ) - MIN( 0., pbb(ji  ,jj  ,jk  ) )   &
658                  & + MAX( 0., pcc(ji  ,jj  ,jk+1) ) - MIN( 0., pcc(ji  ,jj  ,jk  ) )
659
660               ! negative part of the flux
661               zneg = MAX( 0., paa(ji  ,jj  ,jk  ) ) - MIN( 0., paa(ji-1,jj  ,jk  ) )   &
662                  & + MAX( 0., pbb(ji  ,jj  ,jk  ) ) - MIN( 0., pbb(ji  ,jj-1,jk  ) )   &
663                  & + MAX( 0., pcc(ji  ,jj  ,jk  ) ) - MIN( 0., pcc(ji  ,jj  ,jk+1) )
664
665               ! up & down beta terms
666               zbt = e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) / z2dtt
667               zbetup(ji,jj,jk) = ( zup            - paft(ji,jj,jk) ) / ( zpos + zrtrn ) * zbt
668               zbetdo(ji,jj,jk) = ( paft(ji,jj,jk) - zdo            ) / ( zneg + zrtrn ) * zbt
669            END DO
670         END DO
671      END DO
672!$OMP END PARALLEL DO
673      CALL lbc_lnk( zbetup, 'T', 1. )   ;   CALL lbc_lnk( zbetdo, 'T', 1. )   ! lateral boundary cond. (unchanged sign)
674
675      ! 3. monotonic flux in the i & j direction (paa & pbb)
676      ! ----------------------------------------
677!$OMP PARALLEL DO PRIVATE(zau, zbu, zcu, zav, zbv, zcv, za, zb, zc)
678      DO jk = 1, jpkm1
679         DO jj = 2, jpjm1
680            DO ji = fs_2, fs_jpim1   ! vector opt.
681               zau = MIN( 1._wp, zbetdo(ji,jj,jk), zbetup(ji+1,jj,jk) )
682               zbu = MIN( 1._wp, zbetup(ji,jj,jk), zbetdo(ji+1,jj,jk) )
683               zcu =       ( 0.5  + SIGN( 0.5 , paa(ji,jj,jk) ) )
684               paa(ji,jj,jk) = paa(ji,jj,jk) * ( zcu * zau + ( 1._wp - zcu) * zbu )
685
686               zav = MIN( 1._wp, zbetdo(ji,jj,jk), zbetup(ji,jj+1,jk) )
687               zbv = MIN( 1._wp, zbetup(ji,jj,jk), zbetdo(ji,jj+1,jk) )
688               zcv =       ( 0.5  + SIGN( 0.5 , pbb(ji,jj,jk) ) )
689               pbb(ji,jj,jk) = pbb(ji,jj,jk) * ( zcv * zav + ( 1._wp - zcv) * zbv )
690
691      ! monotonic flux in the k direction, i.e. pcc
692      ! -------------------------------------------
693               za = MIN( 1., zbetdo(ji,jj,jk+1), zbetup(ji,jj,jk) )
694               zb = MIN( 1., zbetup(ji,jj,jk+1), zbetdo(ji,jj,jk) )
695               zc =       ( 0.5  + SIGN( 0.5 , pcc(ji,jj,jk+1) ) )
696               pcc(ji,jj,jk+1) = pcc(ji,jj,jk+1) * ( zc * za + ( 1._wp - zc) * zb )
697            END DO
698         END DO
699      END DO
700!$OMP END PARALLEL DO
701      CALL lbc_lnk( paa, 'U', -1. )   ;   CALL lbc_lnk( pbb, 'V', -1. )   ! lateral boundary condition (changed sign)
702      !
703      CALL wrk_dealloc( jpi, jpj, jpk, zbetup, zbetdo, zbup, zbdo )
704      !
705      IF( nn_timing == 1 )  CALL timing_stop('nonosc')
706      !
707   END SUBROUTINE nonosc
708
709   !!======================================================================
710END MODULE traadv_tvd
Note: See TracBrowser for help on using the repository browser.