source: branches/UKMO/dev_r5518_GO6_package/NEMOGCM/NEMO/OPA_SRC/TRA/traadv_muscl.F90 @ 7179

Last change on this file since 7179 was 7179, checked in by timgraham, 4 years ago

Manually merge in changes from v3.6_extra_CMIP6_diagnostics branch.
This change also includes a change of the domain_def.xml file so XIOS2 must be used from this revision onwards

File size: 15.8 KB
Line 
1MODULE traadv_muscl
2   !!======================================================================
3   !!                       ***  MODULE  traadv_muscl  ***
4   !! Ocean  tracers:  horizontal & vertical advective trend
5   !!======================================================================
6   !! History :       !  2000-06  (A.Estublier)  for passive tracers
7   !!                 !  2001-08  (E.Durand, G.Madec)  adapted for T & S
8   !!   NEMO     1.0  !  2002-06  (G. Madec)  F90: Free form and module
9   !!            3.2  !  2010-05  (C. Ethe, G. Madec)  merge TRC-TRA + switch from velocity to transport
10   !!            3.4  !  2012-06  (P. Oddo, M. Vichi) include the upstream where needed
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!   tra_adv_muscl : update the tracer trend with the horizontal
15   !!                   and vertical advection trends using MUSCL scheme
16   !!----------------------------------------------------------------------
17   USE oce            ! ocean dynamics and active tracers
18   USE trc_oce        ! share passive tracers/Ocean variables
19   USE dom_oce        ! ocean space and time domain
20   USE trd_oce        ! trends: ocean variables
21   USE trdtra         ! tracers trends manager
22   USE dynspg_oce     ! choice/control of key cpp for surface pressure gradient
23   USE sbcrnf         ! river runoffs
24   USE diaptr         ! poleward transport diagnostics
25   !
26   USE wrk_nemo       ! Memory Allocation
27   USE timing         ! Timing
28   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
29   USE in_out_manager ! I/O manager
30   USE lib_mpp        ! distribued memory computing
31   USE lbclnk         ! ocean lateral boundary condition (or mpp link)
32
33   IMPLICIT NONE
34   PRIVATE
35
36   PUBLIC   tra_adv_muscl   ! routine called by traadv.F90
37   
38   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   upsmsk   !: mixed upstream/centered scheme near some straits
39   !                                                           !  and in closed seas (orca 2 and 4 configurations)
40   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   xind     !: mixed upstream/centered index
41   
42   !! * Substitutions
43#  include "domzgr_substitute.h90"
44#  include "vectopt_loop_substitute.h90"
45   !!----------------------------------------------------------------------
46   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
47   !! $Id$
48   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52   SUBROUTINE tra_adv_muscl( kt, kit000, cdtype, p2dt, pun, pvn, pwn,   &
53      &                                                ptb, pta, kjpt, ld_msc_ups )
54      !!----------------------------------------------------------------------
55      !!                    ***  ROUTINE tra_adv_muscl  ***
56      !!
57      !! ** Purpose :   Compute the now trend due to total advection of T and
58      !!      S using a MUSCL scheme (Monotone Upstream-centered Scheme for
59      !!      Conservation Laws) and add it to the general tracer trend.
60      !!
61      !! ** Method  : MUSCL scheme plus centered scheme at ocean boundaries
62      !!
63      !! ** Action  : - update (ta,sa) with the now advective tracer trends
64      !!              - save trends
65      !!
66      !! References : Estubier, A., and M. Levy, Notes Techn. Pole de Modelisation
67      !!              IPSL, Sept. 2000 (http://www.lodyc.jussieu.fr/opa)
68      !!----------------------------------------------------------------------
69      INTEGER                              , INTENT(in   ) ::   kt              ! ocean time-step index
70      INTEGER                              , INTENT(in   ) ::   kit000          ! first time step index
71      CHARACTER(len=3)                     , INTENT(in   ) ::   cdtype          ! =TRA or TRC (tracer indicator)
72      INTEGER                              , INTENT(in   ) ::   kjpt            ! number of tracers
73      LOGICAL                              , INTENT(in   ) ::   ld_msc_ups      ! use upstream scheme within muscl
74      REAL(wp), DIMENSION(        jpk     ), INTENT(in   ) ::   p2dt            ! vertical profile of tracer time-step
75      REAL(wp), DIMENSION(jpi,jpj,jpk     ), INTENT(in   ) ::   pun, pvn, pwn   ! 3 ocean velocity components
76      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in   ) ::   ptb             ! before tracer field
77      REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(inout) ::   pta             ! tracer trend
78      !
79      INTEGER  ::   ji, jj, jk, jn            ! dummy loop indices
80      INTEGER  ::   ierr                      ! local integer
81      REAL(wp) ::   zu, z0u, zzwx, zw         ! local scalars
82      REAL(wp) ::   zv, z0v, zzwy, z0w        !   -      -
83      REAL(wp) ::   ztra, zbtr, zdt, zalpha   !   -      -
84      REAL(wp), POINTER, DIMENSION(:,:,:) ::   zslpx, zslpy   ! 3D workspace
85      REAL(wp), POINTER, DIMENSION(:,:,:) ::   zwx  , zwy     ! -      -
86      !!----------------------------------------------------------------------
87      !
88      IF( nn_timing == 1 )  CALL timing_start('tra_adv_muscl')
89      !
90      CALL wrk_alloc( jpi, jpj, jpk, zslpx, zslpy, zwx, zwy )
91      !
92      IF( kt == kit000 )  THEN
93         IF(lwp) WRITE(numout,*)
94         IF(lwp) WRITE(numout,*) 'tra_adv : MUSCL advection scheme on ', cdtype
95         IF(lwp) WRITE(numout,*) '        : mixed up-stream           ', ld_msc_ups
96         IF(lwp) WRITE(numout,*) '~~~~~~~'
97         IF(lwp) WRITE(numout,*)
98         !
99         !
100         IF( ld_msc_ups ) THEN
101            IF( .NOT. ALLOCATED( upsmsk ) )  THEN
102                ALLOCATE( upsmsk(jpi,jpj), STAT=ierr )
103                IF( ierr /= 0 )   CALL ctl_stop('STOP', 'tra_adv_muscl: unable to allocate upsmsk array')
104            ENDIF
105            upsmsk(:,:) = 0._wp                             ! not upstream by default
106         ENDIF
107
108         IF( .NOT. ALLOCATED( xind ) ) THEN
109             ALLOCATE( xind(jpi,jpj,jpk), STAT=ierr )
110             IF( ierr /= 0 )   CALL ctl_stop('STOP', 'tra_adv_muscl: unable to allocate zind array')
111         ENDIF
112         !
113
114         !
115         ! Upstream / MUSCL scheme indicator
116         ! ------------------------------------
117!!gm  useless
118         xind(:,:,:) = 1._wp                             ! set equal to 1 where up-stream is not needed
119!!gm
120         !
121         IF( ld_msc_ups )  THEN
122            DO jk = 1, jpkm1
123               xind(:,:,jk) = 1._wp                              &                 ! =>1 where up-stream is not needed
124                  &         - MAX ( rnfmsk(:,:) * rnfmsk_z(jk),  &                 ! =>0 near runoff mouths (& closed sea outflows)
125                  &                 upsmsk(:,:)                ) * tmask(:,:,jk)   ! =>0 near some straits
126            END DO
127         ENDIF 
128         !
129      ENDIF 
130      !     
131      !                                                     ! ===========
132      DO jn = 1, kjpt                                       ! tracer loop
133         !                                                  ! ===========
134         ! I. Horizontal advective fluxes
135         ! ------------------------------
136         ! first guess of the slopes
137         zwx(:,:,jpk) = 0.e0   ;   zwy(:,:,jpk) = 0.e0        ! bottom values
138         ! interior values
139         DO jk = 1, jpkm1
140            DO jj = 1, jpjm1     
141               DO ji = 1, fs_jpim1   ! vector opt.
142                  zwx(ji,jj,jk) = umask(ji,jj,jk) * ( ptb(ji+1,jj,jk,jn) - ptb(ji,jj,jk,jn) )
143                  zwy(ji,jj,jk) = vmask(ji,jj,jk) * ( ptb(ji,jj+1,jk,jn) - ptb(ji,jj,jk,jn) )
144               END DO
145           END DO
146         END DO
147         !
148         CALL lbc_lnk( zwx, 'U', -1. )                        ! lateral boundary conditions on zwx, zwy   (changed sign)
149         CALL lbc_lnk( zwy, 'V', -1. )
150         !                                             !-- Slopes of tracer
151         zslpx(:,:,jpk) = 0.e0   ;   zslpy(:,:,jpk) = 0.e0    ! bottom values
152         DO jk = 1, jpkm1                                     ! interior values
153            DO jj = 2, jpj
154               DO ji = fs_2, jpi   ! vector opt.
155                  zslpx(ji,jj,jk) =                    ( zwx(ji,jj,jk) + zwx(ji-1,jj  ,jk) )   &
156                     &            * ( 0.25 + SIGN( 0.25, zwx(ji,jj,jk) * zwx(ji-1,jj  ,jk) ) )
157                  zslpy(ji,jj,jk) =                    ( zwy(ji,jj,jk) + zwy(ji  ,jj-1,jk) )   &
158                     &            * ( 0.25 + SIGN( 0.25, zwy(ji,jj,jk) * zwy(ji  ,jj-1,jk) ) )
159               END DO
160            END DO
161         END DO
162         !
163         DO jk = 1, jpkm1                                     ! Slopes limitation
164            DO jj = 2, jpj
165               DO ji = fs_2, jpi   ! vector opt.
166                  zslpx(ji,jj,jk) = SIGN( 1., zslpx(ji,jj,jk) ) * MIN(    ABS( zslpx(ji  ,jj,jk) ),   &
167                     &                                                 2.*ABS( zwx  (ji-1,jj,jk) ),   &
168                     &                                                 2.*ABS( zwx  (ji  ,jj,jk) ) )
169                  zslpy(ji,jj,jk) = SIGN( 1., zslpy(ji,jj,jk) ) * MIN(    ABS( zslpy(ji,jj  ,jk) ),   &
170                     &                                                 2.*ABS( zwy  (ji,jj-1,jk) ),   &
171                     &                                                 2.*ABS( zwy  (ji,jj  ,jk) ) )
172               END DO
173           END DO
174         END DO             ! interior values
175
176         !                                             !-- MUSCL horizontal advective fluxes
177         DO jk = 1, jpkm1                                     ! interior values
178            zdt  = p2dt(jk)
179            DO jj = 2, jpjm1
180               DO ji = fs_2, fs_jpim1   ! vector opt.
181                  ! MUSCL fluxes
182                  z0u = SIGN( 0.5, pun(ji,jj,jk) )
183                  zalpha = 0.5 - z0u
184                  zu  = z0u - 0.5 * pun(ji,jj,jk) * zdt / ( e1u(ji,jj) * e2u(ji,jj) * fse3u(ji,jj,jk) )
185                  zzwx = ptb(ji+1,jj,jk,jn) + xind(ji,jj,jk) * zu * zslpx(ji+1,jj,jk)
186                  zzwy = ptb(ji  ,jj,jk,jn) + xind(ji,jj,jk) * zu * zslpx(ji  ,jj,jk)
187                  zwx(ji,jj,jk) = pun(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy )
188                  !
189                  z0v = SIGN( 0.5, pvn(ji,jj,jk) )
190                  zalpha = 0.5 - z0v
191                  zv  = z0v - 0.5 * pvn(ji,jj,jk) * zdt / ( e1v(ji,jj) * e2v(ji,jj) * fse3v(ji,jj,jk) )
192                  zzwx = ptb(ji,jj+1,jk,jn) + xind(ji,jj,jk) * zv * zslpy(ji,jj+1,jk)
193                  zzwy = ptb(ji,jj  ,jk,jn) + xind(ji,jj,jk) * zv * zslpy(ji,jj  ,jk)
194                  zwy(ji,jj,jk) = pvn(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy )
195               END DO
196            END DO
197         END DO
198         !                                                    ! lateral boundary conditions on zwx, zwy   (changed sign)
199         CALL lbc_lnk( zwx, 'U', -1. )   ;   CALL lbc_lnk( zwy, 'V', -1. )
200         !
201         ! Tracer flux divergence at t-point added to the general trend
202         DO jk = 1, jpkm1
203            DO jj = 2, jpjm1     
204               DO ji = fs_2, fs_jpim1   ! vector opt.
205                  zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) )
206                  ! horizontal advective trends
207                  ztra = - zbtr * ( zwx(ji,jj,jk) - zwx(ji-1,jj  ,jk  )   &
208                  &               + zwy(ji,jj,jk) - zwy(ji  ,jj-1,jk  ) )
209                  ! add it to the general tracer trends
210                  pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) + ztra
211               END DO
212           END DO
213         END DO       
214         !                                 ! trend diagnostics (contribution of upstream fluxes)
215         IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR.   &
216            &( cdtype == 'TRC' .AND. l_trdtrc )      )  THEN
217            CALL trd_tra( kt, cdtype, jn, jptra_xad, zwx, pun, ptb(:,:,:,jn) )
218            CALL trd_tra( kt, cdtype, jn, jptra_yad, zwy, pvn, ptb(:,:,:,jn) )
219         END IF
220         !                                 ! "Poleward" heat and salt transports (contribution of upstream fluxes)
221         IF( cdtype == 'TRA' .AND. ln_diaptr )  CALL dia_ptr_ohst_components( jn, 'adv', zwy(:,:,:)  )
222
223         ! II. Vertical advective fluxes
224         ! -----------------------------
225         !                                             !-- first guess of the slopes
226         zwx (:,:, 1 ) = 0.e0    ;    zwx (:,:,jpk) = 0.e0    ! surface & bottom boundary conditions
227         DO jk = 2, jpkm1                                     ! interior values
228            zwx(:,:,jk) = tmask(:,:,jk) * ( ptb(:,:,jk-1,jn) - ptb(:,:,jk,jn) )
229         END DO
230
231         !                                             !-- Slopes of tracer
232         zslpx(:,:,1) = 0.e0                                  ! surface values
233         DO jk = 2, jpkm1                                     ! interior value
234            DO jj = 1, jpj
235               DO ji = 1, jpi
236                  zslpx(ji,jj,jk) =                    ( zwx(ji,jj,jk) + zwx(ji,jj,jk+1) )   &
237                     &            * ( 0.25 + SIGN( 0.25, zwx(ji,jj,jk) * zwx(ji,jj,jk+1) ) )
238               END DO
239            END DO
240         END DO
241         !                                             !-- Slopes limitation
242         DO jk = 2, jpkm1                                     ! interior values
243            DO jj = 1, jpj
244               DO ji = 1, jpi
245                  zslpx(ji,jj,jk) = SIGN( 1., zslpx(ji,jj,jk) ) * MIN(    ABS( zslpx(ji,jj,jk  ) ),   &
246                     &                                                 2.*ABS( zwx  (ji,jj,jk+1) ),   &
247                     &                                                 2.*ABS( zwx  (ji,jj,jk  ) )  )
248               END DO
249            END DO
250         END DO
251         !                                             !-- vertical advective flux
252         !                                                    ! surface values  (bottom already set to zero)
253         IF( lk_vvl ) THEN    ;   zwx(:,:, 1 ) = 0.e0                      !  variable volume
254         ELSE                 ;   zwx(:,:, 1 ) = pwn(:,:,1) * ptb(:,:,1,jn)   ! linear free surface
255         ENDIF 
256         !
257         DO jk = 1, jpkm1                                     ! interior values
258            zdt  = p2dt(jk)
259            DO jj = 2, jpjm1     
260               DO ji = fs_2, fs_jpim1   ! vector opt.
261                  zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3w(ji,jj,jk+1) )
262                  z0w = SIGN( 0.5, pwn(ji,jj,jk+1) )
263                  zalpha = 0.5 + z0w
264                  zw  = z0w - 0.5 * pwn(ji,jj,jk+1) * zdt * zbtr 
265                  zzwx = ptb(ji,jj,jk+1,jn) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk+1)
266                  zzwy = ptb(ji,jj,jk  ,jn) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk  )
267                  zwx(ji,jj,jk+1) = pwn(ji,jj,jk+1) * ( zalpha * zzwx + (1.-zalpha) * zzwy )
268               END DO
269            END DO
270         END DO
271
272         DO jk = 1, jpkm1                    ! Compute & add the vertical advective trend
273            DO jj = 2, jpjm1     
274               DO ji = fs_2, fs_jpim1   ! vector opt.
275                  zbtr = 1. / ( e1e2t(ji,jj) * fse3t(ji,jj,jk) )
276                  ! vertical advective trends
277                  ztra = - zbtr * ( zwx(ji,jj,jk) - zwx(ji,jj,jk+1) )
278                  ! add it to the general tracer trends
279                  pta(ji,jj,jk,jn) =  pta(ji,jj,jk,jn) + ztra
280               END DO
281            END DO
282         END DO
283         !                                 ! Save the vertical advective trends for diagnostic
284         IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR.     &
285            &( cdtype == 'TRC' .AND. l_trdtrc )      )   &
286            CALL trd_tra( kt, cdtype, jn, jptra_zad, zwx, pwn, ptb(:,:,:,jn) )
287         !
288      END DO
289      !
290      CALL wrk_dealloc( jpi, jpj, jpk, zslpx, zslpy, zwx, zwy )
291      !
292      IF( nn_timing == 1 )  CALL timing_stop('tra_adv_muscl')
293      !
294   END SUBROUTINE tra_adv_muscl
295
296   !!======================================================================
297END MODULE traadv_muscl
Note: See TracBrowser for help on using the repository browser.