[5770] | 1 | MODULE traadv_mus |
---|
[503] | 2 | !!====================================================================== |
---|
[5770] | 3 | !! *** MODULE traadv_mus *** |
---|
[2528] | 4 | !! Ocean tracers: horizontal & vertical advective trend |
---|
[503] | 5 | !!====================================================================== |
---|
[2528] | 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 |
---|
[3680] | 10 | !! 3.4 ! 2012-06 (P. Oddo, M. Vichi) include the upstream where needed |
---|
[5770] | 11 | !! 3.7 ! 2015-09 (G. Madec) add the ice-shelf cavities boundary condition |
---|
[503] | 12 | !!---------------------------------------------------------------------- |
---|
[3] | 13 | |
---|
| 14 | !!---------------------------------------------------------------------- |
---|
[5770] | 15 | !! tra_adv_mus : update the tracer trend with the horizontal |
---|
[3] | 16 | !! and vertical advection trends using MUSCL scheme |
---|
| 17 | !!---------------------------------------------------------------------- |
---|
[3625] | 18 | USE oce ! ocean dynamics and active tracers |
---|
[4990] | 19 | USE trc_oce ! share passive tracers/Ocean variables |
---|
[3625] | 20 | USE dom_oce ! ocean space and time domain |
---|
[4990] | 21 | USE trd_oce ! trends: ocean variables |
---|
| 22 | USE trdtra ! tracers trends manager |
---|
[5147] | 23 | USE sbcrnf ! river runoffs |
---|
[3625] | 24 | USE diaptr ! poleward transport diagnostics |
---|
[7646] | 25 | USE diaar5 ! AR5 diagnostics |
---|
| 26 | |
---|
[4990] | 27 | ! |
---|
[9019] | 28 | USE iom ! XIOS library |
---|
[4990] | 29 | USE in_out_manager ! I/O manager |
---|
| 30 | USE lib_mpp ! distribued memory computing |
---|
[14072] | 31 | USE lbclnk ! ocean lateral boundary condition (or mpp link) |
---|
| 32 | USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) |
---|
[3] | 33 | |
---|
| 34 | IMPLICIT NONE |
---|
| 35 | PRIVATE |
---|
| 36 | |
---|
[5770] | 37 | PUBLIC tra_adv_mus ! routine called by traadv.F90 |
---|
[14072] | 38 | |
---|
[4990] | 39 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) :: upsmsk !: mixed upstream/centered scheme near some straits |
---|
[7646] | 40 | ! ! and in closed seas (orca 2 and 1 configurations) |
---|
[4990] | 41 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: xind !: mixed upstream/centered index |
---|
[14072] | 42 | |
---|
[7646] | 43 | LOGICAL :: l_trd ! flag to compute trends |
---|
| 44 | LOGICAL :: l_ptr ! flag to compute poleward transport |
---|
| 45 | LOGICAL :: l_hst ! flag to compute heat/salt transport |
---|
| 46 | |
---|
[3] | 47 | !! * Substitutions |
---|
[12377] | 48 | # include "do_loop_substitute.h90" |
---|
[13237] | 49 | # include "domzgr_substitute.h90" |
---|
[3] | 50 | !!---------------------------------------------------------------------- |
---|
[9598] | 51 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[14072] | 52 | !! $Id$ |
---|
[10068] | 53 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[3] | 54 | !!---------------------------------------------------------------------- |
---|
| 55 | CONTAINS |
---|
| 56 | |
---|
[12377] | 57 | SUBROUTINE tra_adv_mus( kt, kit000, cdtype, p2dt, pU, pV, pW, & |
---|
| 58 | & Kbb, Kmm, pt, kjpt, Krhs, ld_msc_ups ) |
---|
[3] | 59 | !!---------------------------------------------------------------------- |
---|
[5770] | 60 | !! *** ROUTINE tra_adv_mus *** |
---|
[216] | 61 | !! |
---|
[5770] | 62 | !! ** Purpose : Compute the now trend due to total advection of tracers |
---|
| 63 | !! using a MUSCL scheme (Monotone Upstream-centered Scheme for |
---|
| 64 | !! Conservation Laws) and add it to the general tracer trend. |
---|
[3] | 65 | !! |
---|
[216] | 66 | !! ** Method : MUSCL scheme plus centered scheme at ocean boundaries |
---|
[14072] | 67 | !! ld_msc_ups=T : |
---|
[3] | 68 | !! |
---|
[12377] | 69 | !! ** Action : - update pt(:,:,:,:,Krhs) with the now advective tracer trends |
---|
[6140] | 70 | !! - send trends to trdtra module for further diagnostcs (l_trdtra=T) |
---|
[12377] | 71 | !! - poleward advective heat and salt transport (ln_diaptr=T) |
---|
[3] | 72 | !! |
---|
[503] | 73 | !! References : Estubier, A., and M. Levy, Notes Techn. Pole de Modelisation |
---|
| 74 | !! IPSL, Sept. 2000 (http://www.lodyc.jussieu.fr/opa) |
---|
| 75 | !!---------------------------------------------------------------------- |
---|
[12377] | 76 | INTEGER , INTENT(in ) :: kt ! ocean time-step index |
---|
| 77 | INTEGER , INTENT(in ) :: Kbb, Kmm, Krhs ! ocean time level indices |
---|
| 78 | INTEGER , INTENT(in ) :: kit000 ! first time step index |
---|
| 79 | CHARACTER(len=3) , INTENT(in ) :: cdtype ! =TRA or TRC (tracer indicator) |
---|
| 80 | INTEGER , INTENT(in ) :: kjpt ! number of tracers |
---|
| 81 | LOGICAL , INTENT(in ) :: ld_msc_ups ! use upstream scheme within muscl |
---|
| 82 | REAL(wp) , INTENT(in ) :: p2dt ! tracer time-step |
---|
[13982] | 83 | ! TEMP: [tiling] This can be A2D(nn_hls) if using XIOS (subdomain support) |
---|
[12377] | 84 | REAL(wp), DIMENSION(jpi,jpj,jpk ), INTENT(in ) :: pU, pV, pW ! 3 ocean volume flux components |
---|
| 85 | REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt,jpt), INTENT(inout) :: pt ! tracers and RHS of tracer equation |
---|
[2715] | 86 | ! |
---|
[9019] | 87 | INTEGER :: ji, jj, jk, jn ! dummy loop indices |
---|
| 88 | INTEGER :: ierr ! local integer |
---|
| 89 | REAL(wp) :: zu, z0u, zzwx, zw , zalpha ! local scalars |
---|
| 90 | REAL(wp) :: zv, z0v, zzwy, z0w ! - - |
---|
[13982] | 91 | REAL(wp), DIMENSION(A2D(nn_hls),jpk) :: zwx, zslpx ! 3D workspace |
---|
| 92 | REAL(wp), DIMENSION(A2D(nn_hls),jpk) :: zwy, zslpy ! - - |
---|
[3] | 93 | !!---------------------------------------------------------------------- |
---|
[3294] | 94 | ! |
---|
[13982] | 95 | IF( ntile == 0 .OR. ntile == 1 ) THEN ! Do only on the first tile |
---|
| 96 | IF( kt == kit000 ) THEN |
---|
| 97 | IF(lwp) WRITE(numout,*) |
---|
| 98 | IF(lwp) WRITE(numout,*) 'tra_adv : MUSCL advection scheme on ', cdtype |
---|
| 99 | IF(lwp) WRITE(numout,*) ' : mixed up-stream ', ld_msc_ups |
---|
| 100 | IF(lwp) WRITE(numout,*) '~~~~~~~' |
---|
| 101 | IF(lwp) WRITE(numout,*) |
---|
[5770] | 102 | ! |
---|
[13982] | 103 | ! Upstream / MUSCL scheme indicator |
---|
| 104 | ! |
---|
| 105 | ALLOCATE( xind(jpi,jpj,jpk), STAT=ierr ) |
---|
| 106 | xind(:,:,:) = 1._wp ! set equal to 1 where up-stream is not needed |
---|
| 107 | ! |
---|
| 108 | IF( ld_msc_ups ) THEN ! define the upstream indicator (if asked) |
---|
| 109 | ALLOCATE( upsmsk(jpi,jpj), STAT=ierr ) |
---|
| 110 | upsmsk(:,:) = 0._wp ! not upstream by default |
---|
| 111 | ! |
---|
| 112 | DO jk = 1, jpkm1 |
---|
| 113 | xind(:,:,jk) = 1._wp & ! =>1 where up-stream is not needed |
---|
| 114 | & - MAX ( rnfmsk(:,:) * rnfmsk_z(jk), & ! =>0 near runoff mouths (& closed sea outflows) |
---|
| 115 | & upsmsk(:,:) ) * tmask(:,:,jk) ! =>0 in some user defined area |
---|
| 116 | END DO |
---|
| 117 | ENDIF |
---|
| 118 | ! |
---|
| 119 | ENDIF |
---|
[3718] | 120 | ! |
---|
[13982] | 121 | l_trd = .FALSE. |
---|
| 122 | l_hst = .FALSE. |
---|
| 123 | l_ptr = .FALSE. |
---|
| 124 | IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE. |
---|
| 125 | IF( cdtype == 'TRA' .AND. ( iom_use( 'sophtadv' ) .OR. iom_use( 'sophtadv' ) ) ) l_ptr = .TRUE. |
---|
| 126 | IF( cdtype == 'TRA' .AND. ( iom_use("uadv_heattr") .OR. iom_use("vadv_heattr") .OR. & |
---|
| 127 | & iom_use("uadv_salttr") .OR. iom_use("vadv_salttr") ) ) l_hst = .TRUE. |
---|
| 128 | ENDIF |
---|
[7646] | 129 | ! |
---|
[6140] | 130 | DO jn = 1, kjpt !== loop over the tracers ==! |
---|
| 131 | ! |
---|
| 132 | ! !* Horizontal advective fluxes |
---|
| 133 | ! |
---|
| 134 | ! !-- first guess of the slopes |
---|
[7753] | 135 | zwx(:,:,jpk) = 0._wp ! bottom values |
---|
[14072] | 136 | zwy(:,:,jpk) = 0._wp |
---|
[13982] | 137 | DO_3D( nn_hls, nn_hls-1, nn_hls, nn_hls-1, 1, jpkm1 ) |
---|
[12377] | 138 | zwx(ji,jj,jk) = umask(ji,jj,jk) * ( pt(ji+1,jj,jk,jn,Kbb) - pt(ji,jj,jk,jn,Kbb) ) |
---|
| 139 | zwy(ji,jj,jk) = vmask(ji,jj,jk) * ( pt(ji,jj+1,jk,jn,Kbb) - pt(ji,jj,jk,jn,Kbb) ) |
---|
| 140 | END_3D |
---|
[9094] | 141 | ! lateral boundary conditions (changed sign) |
---|
[13982] | 142 | IF ( nn_hls.EQ.1 ) CALL lbc_lnk_multi( 'traadv_mus', zwx, 'U', -1.0_wp , zwy, 'V', -1.0_wp ) |
---|
[6140] | 143 | ! !-- Slopes of tracer |
---|
[7753] | 144 | zslpx(:,:,jpk) = 0._wp ! bottom values |
---|
| 145 | zslpy(:,:,jpk) = 0._wp |
---|
[13982] | 146 | DO_3D( nn_hls-1, 1, nn_hls-1, 1, 1, jpkm1 ) |
---|
[13226] | 147 | zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji-1,jj ,jk) ) & |
---|
| 148 | & * ( 0.25 + SIGN( 0.25_wp, zwx(ji,jj,jk) * zwx(ji-1,jj ,jk) ) ) |
---|
| 149 | zslpy(ji,jj,jk) = ( zwy(ji,jj,jk) + zwy(ji ,jj-1,jk) ) & |
---|
| 150 | & * ( 0.25 + SIGN( 0.25_wp, zwy(ji,jj,jk) * zwy(ji ,jj-1,jk) ) ) |
---|
[12377] | 151 | END_3D |
---|
[503] | 152 | ! |
---|
[13982] | 153 | DO_3D( nn_hls-1, 1, nn_hls-1, 1, 1, jpkm1 ) !-- Slopes limitation |
---|
[13226] | 154 | zslpx(ji,jj,jk) = SIGN( 1.0_wp, zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji ,jj,jk) ), & |
---|
| 155 | & 2.*ABS( zwx (ji-1,jj,jk) ), & |
---|
| 156 | & 2.*ABS( zwx (ji ,jj,jk) ) ) |
---|
| 157 | zslpy(ji,jj,jk) = SIGN( 1.0_wp, zslpy(ji,jj,jk) ) * MIN( ABS( zslpy(ji,jj ,jk) ), & |
---|
| 158 | & 2.*ABS( zwy (ji,jj-1,jk) ), & |
---|
| 159 | & 2.*ABS( zwy (ji,jj ,jk) ) ) |
---|
[12377] | 160 | END_3D |
---|
[5770] | 161 | ! |
---|
[13982] | 162 | DO_3D( nn_hls-1, 0, nn_hls-1, 0, 1, jpkm1 ) !-- MUSCL horizontal advective fluxes |
---|
[12377] | 163 | ! MUSCL fluxes |
---|
[13226] | 164 | z0u = SIGN( 0.5_wp, pU(ji,jj,jk) ) |
---|
[12377] | 165 | zalpha = 0.5 - z0u |
---|
| 166 | zu = z0u - 0.5 * pU(ji,jj,jk) * p2dt * r1_e1e2u(ji,jj) / e3u(ji,jj,jk,Kmm) |
---|
| 167 | zzwx = pt(ji+1,jj,jk,jn,Kbb) + xind(ji,jj,jk) * zu * zslpx(ji+1,jj,jk) |
---|
| 168 | zzwy = pt(ji ,jj,jk,jn,Kbb) + xind(ji,jj,jk) * zu * zslpx(ji ,jj,jk) |
---|
| 169 | zwx(ji,jj,jk) = pU(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) |
---|
| 170 | ! |
---|
[13226] | 171 | z0v = SIGN( 0.5_wp, pV(ji,jj,jk) ) |
---|
[12377] | 172 | zalpha = 0.5 - z0v |
---|
| 173 | zv = z0v - 0.5 * pV(ji,jj,jk) * p2dt * r1_e1e2v(ji,jj) / e3v(ji,jj,jk,Kmm) |
---|
| 174 | zzwx = pt(ji,jj+1,jk,jn,Kbb) + xind(ji,jj,jk) * zv * zslpy(ji,jj+1,jk) |
---|
| 175 | zzwy = pt(ji,jj ,jk,jn,Kbb) + xind(ji,jj,jk) * zv * zslpy(ji,jj ,jk) |
---|
| 176 | zwy(ji,jj,jk) = pV(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) |
---|
| 177 | END_3D |
---|
[13982] | 178 | IF ( nn_hls.EQ.1 ) CALL lbc_lnk_multi( 'traadv_mus', zwx, 'U', -1.0_wp , zwy, 'V', -1.0_wp ) ! lateral boundary conditions (changed sign) |
---|
[503] | 179 | ! |
---|
[13497] | 180 | DO_3D( 0, 0, 0, 0, 1, jpkm1 ) !-- Tracer advective trend |
---|
[12377] | 181 | pt(ji,jj,jk,jn,Krhs) = pt(ji,jj,jk,jn,Krhs) - ( zwx(ji,jj,jk) - zwx(ji-1,jj ,jk ) & |
---|
| 182 | & + zwy(ji,jj,jk) - zwy(ji ,jj-1,jk ) ) & |
---|
| 183 | & * r1_e1e2t(ji,jj) / e3t(ji,jj,jk,Kmm) |
---|
| 184 | END_3D |
---|
[6140] | 185 | ! ! trend diagnostics |
---|
[7646] | 186 | IF( l_trd ) THEN |
---|
[12377] | 187 | CALL trd_tra( kt, Kmm, Krhs, cdtype, jn, jptra_xad, zwx, pU, pt(:,:,:,jn,Kbb) ) |
---|
| 188 | CALL trd_tra( kt, Kmm, Krhs, cdtype, jn, jptra_yad, zwy, pV, pt(:,:,:,jn,Kbb) ) |
---|
[2528] | 189 | END IF |
---|
[14072] | 190 | ! ! "Poleward" heat and salt transports |
---|
[7646] | 191 | IF( l_ptr ) CALL dia_ptr_hst( jn, 'adv', zwy(:,:,:) ) |
---|
| 192 | ! ! heat transport |
---|
| 193 | IF( l_hst ) CALL dia_ar5_hst( jn, 'adv', zwx(:,:,:), zwy(:,:,:) ) |
---|
[6140] | 194 | ! |
---|
| 195 | ! !* Vertical advective fluxes |
---|
| 196 | ! |
---|
[5770] | 197 | ! !-- first guess of the slopes |
---|
[7753] | 198 | zwx(:,:, 1 ) = 0._wp ! surface & bottom boundary conditions |
---|
| 199 | zwx(:,:,jpk) = 0._wp |
---|
[13982] | 200 | DO_3D( 1, 1, 1, 1, 2, jpkm1 ) ! interior values |
---|
| 201 | zwx(ji,jj,jk) = tmask(ji,jj,jk) * ( pt(ji,jj,jk-1,jn,Kbb) - pt(ji,jj,jk,jn,Kbb) ) |
---|
| 202 | END_3D |
---|
[5770] | 203 | ! !-- Slopes of tracer |
---|
[7753] | 204 | zslpx(:,:,1) = 0._wp ! surface values |
---|
[13295] | 205 | DO_3D( 1, 1, 1, 1, 2, jpkm1 ) |
---|
[13226] | 206 | zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji,jj,jk+1) ) & |
---|
| 207 | & * ( 0.25 + SIGN( 0.25_wp, zwx(ji,jj,jk) * zwx(ji,jj,jk+1) ) ) |
---|
[12377] | 208 | END_3D |
---|
[13497] | 209 | DO_3D( 1, 1, 1, 1, 2, jpkm1 ) !-- Slopes limitation |
---|
[13226] | 210 | zslpx(ji,jj,jk) = SIGN( 1.0_wp, zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji,jj,jk ) ), & |
---|
| 211 | & 2.*ABS( zwx (ji,jj,jk+1) ), & |
---|
| 212 | & 2.*ABS( zwx (ji,jj,jk ) ) ) |
---|
[12377] | 213 | END_3D |
---|
[13497] | 214 | DO_3D( 0, 0, 0, 0, 1, jpk-2 ) !-- vertical advective flux |
---|
[13226] | 215 | z0w = SIGN( 0.5_wp, pW(ji,jj,jk+1) ) |
---|
[12377] | 216 | zalpha = 0.5 + z0w |
---|
| 217 | zw = z0w - 0.5 * pW(ji,jj,jk+1) * p2dt * r1_e1e2t(ji,jj) / e3w(ji,jj,jk+1,Kmm) |
---|
| 218 | zzwx = pt(ji,jj,jk+1,jn,Kbb) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk+1) |
---|
| 219 | zzwy = pt(ji,jj,jk ,jn,Kbb) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk ) |
---|
| 220 | zwx(ji,jj,jk+1) = pW(ji,jj,jk+1) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) * wmask(ji,jj,jk) |
---|
| 221 | END_3D |
---|
[6140] | 222 | IF( ln_linssh ) THEN ! top values, linear free surface only |
---|
| 223 | IF( ln_isfcav ) THEN ! ice-shelf cavities (top of the ocean) |
---|
[13295] | 224 | DO_2D( 1, 1, 1, 1 ) |
---|
[12377] | 225 | zwx(ji,jj, mikt(ji,jj) ) = pW(ji,jj,mikt(ji,jj)) * pt(ji,jj,mikt(ji,jj),jn,Kbb) |
---|
| 226 | END_2D |
---|
[6140] | 227 | ELSE ! no cavities: only at the ocean surface |
---|
[13982] | 228 | DO_2D( 1, 1, 1, 1 ) |
---|
| 229 | zwx(ji,jj,1) = pW(ji,jj,1) * pt(ji,jj,1,jn,Kbb) |
---|
| 230 | END_2D |
---|
[5770] | 231 | ENDIF |
---|
| 232 | ENDIF |
---|
| 233 | ! |
---|
[13497] | 234 | DO_3D( 0, 0, 0, 0, 1, jpkm1 ) !-- vertical advective trend |
---|
[13237] | 235 | pt(ji,jj,jk,jn,Krhs) = pt(ji,jj,jk,jn,Krhs) - ( zwx(ji,jj,jk) - zwx(ji,jj,jk+1) ) & |
---|
| 236 | & * r1_e1e2t(ji,jj) / e3t(ji,jj,jk,Kmm) |
---|
[12377] | 237 | END_3D |
---|
[6140] | 238 | ! ! send trends for diagnostic |
---|
[12377] | 239 | IF( l_trd ) CALL trd_tra( kt, Kmm, Krhs, cdtype, jn, jptra_zad, zwx, pW, pt(:,:,:,jn,Kbb) ) |
---|
[503] | 240 | ! |
---|
[6140] | 241 | END DO ! end of tracer loop |
---|
[503] | 242 | ! |
---|
[5770] | 243 | END SUBROUTINE tra_adv_mus |
---|
[3] | 244 | |
---|
| 245 | !!====================================================================== |
---|
[5770] | 246 | END MODULE traadv_mus |
---|