[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 |
---|
| 31 | USE lbclnk ! ocean lateral boundary condition (or mpp link) |
---|
[9124] | 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 |
---|
[4990] | 38 | |
---|
| 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 |
---|
| 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 |
---|
| 48 | # include "vectopt_loop_substitute.h90" |
---|
| 49 | !!---------------------------------------------------------------------- |
---|
[9598] | 50 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[1152] | 51 | !! $Id$ |
---|
[10068] | 52 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[3] | 53 | !!---------------------------------------------------------------------- |
---|
| 54 | CONTAINS |
---|
| 55 | |
---|
[10802] | 56 | SUBROUTINE tra_adv_mus( kt, kit000, ktlev, cdtype, p2dt, pu, pv, pwn, & |
---|
| 57 | & pt, pt_rhs, kjpt, ld_msc_ups ) |
---|
[3] | 58 | !!---------------------------------------------------------------------- |
---|
[5770] | 59 | !! *** ROUTINE tra_adv_mus *** |
---|
[216] | 60 | !! |
---|
[5770] | 61 | !! ** Purpose : Compute the now trend due to total advection of tracers |
---|
| 62 | !! using a MUSCL scheme (Monotone Upstream-centered Scheme for |
---|
| 63 | !! Conservation Laws) and add it to the general tracer trend. |
---|
[3] | 64 | !! |
---|
[216] | 65 | !! ** Method : MUSCL scheme plus centered scheme at ocean boundaries |
---|
[5770] | 66 | !! ld_msc_ups=T : |
---|
[3] | 67 | !! |
---|
[10802] | 68 | !! ** Action : - update pt_rhs with the now advective tracer trends |
---|
[6140] | 69 | !! - send trends to trdtra module for further diagnostcs (l_trdtra=T) |
---|
| 70 | !! - htr_adv, str_adv : poleward advective heat and salt transport (ln_diaptr=T) |
---|
[3] | 71 | !! |
---|
[503] | 72 | !! References : Estubier, A., and M. Levy, Notes Techn. Pole de Modelisation |
---|
| 73 | !! IPSL, Sept. 2000 (http://www.lodyc.jussieu.fr/opa) |
---|
| 74 | !!---------------------------------------------------------------------- |
---|
[2528] | 75 | INTEGER , INTENT(in ) :: kt ! ocean time-step index |
---|
[3294] | 76 | INTEGER , INTENT(in ) :: kit000 ! first time step index |
---|
[10802] | 77 | INTEGER , INTENT(in ) :: ktlev ! time level index for source terms |
---|
[2528] | 78 | CHARACTER(len=3) , INTENT(in ) :: cdtype ! =TRA or TRC (tracer indicator) |
---|
| 79 | INTEGER , INTENT(in ) :: kjpt ! number of tracers |
---|
[3718] | 80 | LOGICAL , INTENT(in ) :: ld_msc_ups ! use upstream scheme within muscl |
---|
[6140] | 81 | REAL(wp) , INTENT(in ) :: p2dt ! tracer time-step |
---|
[10802] | 82 | REAL(wp), DIMENSION(jpi,jpj,jpk ), INTENT(in ) :: pu, pv, pwn ! 3 ocean velocity components |
---|
| 83 | REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in ) :: pt ! before tracer field |
---|
| 84 | REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(inout) :: pt_rhs ! tracer trend |
---|
[2715] | 85 | ! |
---|
[9019] | 86 | INTEGER :: ji, jj, jk, jn ! dummy loop indices |
---|
| 87 | INTEGER :: ierr ! local integer |
---|
| 88 | REAL(wp) :: zu, z0u, zzwx, zw , zalpha ! local scalars |
---|
| 89 | REAL(wp) :: zv, z0v, zzwy, z0w ! - - |
---|
| 90 | REAL(wp), DIMENSION(jpi,jpj,jpk) :: zwx, zslpx ! 3D workspace |
---|
| 91 | REAL(wp), DIMENSION(jpi,jpj,jpk) :: zwy, zslpy ! - - |
---|
[3] | 92 | !!---------------------------------------------------------------------- |
---|
[3294] | 93 | ! |
---|
| 94 | IF( kt == kit000 ) THEN |
---|
[2528] | 95 | IF(lwp) WRITE(numout,*) |
---|
| 96 | IF(lwp) WRITE(numout,*) 'tra_adv : MUSCL advection scheme on ', cdtype |
---|
[3718] | 97 | IF(lwp) WRITE(numout,*) ' : mixed up-stream ', ld_msc_ups |
---|
[2528] | 98 | IF(lwp) WRITE(numout,*) '~~~~~~~' |
---|
[3680] | 99 | IF(lwp) WRITE(numout,*) |
---|
[2528] | 100 | ! |
---|
[5770] | 101 | ! Upstream / MUSCL scheme indicator |
---|
[3680] | 102 | ! |
---|
[5770] | 103 | ALLOCATE( xind(jpi,jpj,jpk), STAT=ierr ) |
---|
[7753] | 104 | xind(:,:,:) = 1._wp ! set equal to 1 where up-stream is not needed |
---|
[5770] | 105 | ! |
---|
| 106 | IF( ld_msc_ups ) THEN ! define the upstream indicator (if asked) |
---|
| 107 | ALLOCATE( upsmsk(jpi,jpj), STAT=ierr ) |
---|
[7753] | 108 | upsmsk(:,:) = 0._wp ! not upstream by default |
---|
[5770] | 109 | ! |
---|
[4990] | 110 | DO jk = 1, jpkm1 |
---|
[7753] | 111 | xind(:,:,jk) = 1._wp & ! =>1 where up-stream is not needed |
---|
| 112 | & - MAX ( rnfmsk(:,:) * rnfmsk_z(jk), & ! =>0 near runoff mouths (& closed sea outflows) |
---|
| 113 | & upsmsk(:,:) ) * tmask(:,:,jk) ! =>0 in some user defined area |
---|
[3718] | 114 | END DO |
---|
[3680] | 115 | ENDIF |
---|
[3718] | 116 | ! |
---|
| 117 | ENDIF |
---|
[4990] | 118 | ! |
---|
[7646] | 119 | l_trd = .FALSE. |
---|
| 120 | l_hst = .FALSE. |
---|
| 121 | l_ptr = .FALSE. |
---|
| 122 | IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE. |
---|
| 123 | IF( cdtype == 'TRA' .AND. ln_diaptr ) l_ptr = .TRUE. |
---|
| 124 | IF( cdtype == 'TRA' .AND. ( iom_use("uadv_heattr") .OR. iom_use("vadv_heattr") .OR. & |
---|
| 125 | & iom_use("uadv_salttr") .OR. iom_use("vadv_salttr") ) ) l_hst = .TRUE. |
---|
| 126 | ! |
---|
[6140] | 127 | DO jn = 1, kjpt !== loop over the tracers ==! |
---|
| 128 | ! |
---|
| 129 | ! !* Horizontal advective fluxes |
---|
| 130 | ! |
---|
| 131 | ! !-- first guess of the slopes |
---|
[7753] | 132 | zwx(:,:,jpk) = 0._wp ! bottom values |
---|
| 133 | zwy(:,:,jpk) = 0._wp |
---|
[6140] | 134 | DO jk = 1, jpkm1 ! interior values |
---|
[2528] | 135 | DO jj = 1, jpjm1 |
---|
| 136 | DO ji = 1, fs_jpim1 ! vector opt. |
---|
[10802] | 137 | zwx(ji,jj,jk) = umask(ji,jj,jk) * ( pt(ji+1,jj,jk,jn) - pt(ji,jj,jk,jn) ) |
---|
| 138 | zwy(ji,jj,jk) = vmask(ji,jj,jk) * ( pt(ji,jj+1,jk,jn) - pt(ji,jj,jk,jn) ) |
---|
[2528] | 139 | END DO |
---|
| 140 | END DO |
---|
[3] | 141 | END DO |
---|
[9094] | 142 | ! lateral boundary conditions (changed sign) |
---|
[10425] | 143 | CALL lbc_lnk_multi( 'traadv_mus', zwx, 'U', -1. , zwy, 'V', -1. ) |
---|
[6140] | 144 | ! !-- Slopes of tracer |
---|
[7753] | 145 | zslpx(:,:,jpk) = 0._wp ! bottom values |
---|
| 146 | zslpy(:,:,jpk) = 0._wp |
---|
[6140] | 147 | DO jk = 1, jpkm1 ! interior values |
---|
[2528] | 148 | DO jj = 2, jpj |
---|
| 149 | DO ji = fs_2, jpi ! vector opt. |
---|
| 150 | zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji-1,jj ,jk) ) & |
---|
| 151 | & * ( 0.25 + SIGN( 0.25, zwx(ji,jj,jk) * zwx(ji-1,jj ,jk) ) ) |
---|
| 152 | zslpy(ji,jj,jk) = ( zwy(ji,jj,jk) + zwy(ji ,jj-1,jk) ) & |
---|
| 153 | & * ( 0.25 + SIGN( 0.25, zwy(ji,jj,jk) * zwy(ji ,jj-1,jk) ) ) |
---|
| 154 | END DO |
---|
[3] | 155 | END DO |
---|
| 156 | END DO |
---|
[503] | 157 | ! |
---|
[6140] | 158 | DO jk = 1, jpkm1 !-- Slopes limitation |
---|
[2528] | 159 | DO jj = 2, jpj |
---|
| 160 | DO ji = fs_2, jpi ! vector opt. |
---|
| 161 | zslpx(ji,jj,jk) = SIGN( 1., zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji ,jj,jk) ), & |
---|
| 162 | & 2.*ABS( zwx (ji-1,jj,jk) ), & |
---|
| 163 | & 2.*ABS( zwx (ji ,jj,jk) ) ) |
---|
| 164 | zslpy(ji,jj,jk) = SIGN( 1., zslpy(ji,jj,jk) ) * MIN( ABS( zslpy(ji,jj ,jk) ), & |
---|
| 165 | & 2.*ABS( zwy (ji,jj-1,jk) ), & |
---|
| 166 | & 2.*ABS( zwy (ji,jj ,jk) ) ) |
---|
[503] | 167 | END DO |
---|
[2528] | 168 | END DO |
---|
[5770] | 169 | END DO |
---|
| 170 | ! |
---|
[6140] | 171 | DO jk = 1, jpkm1 !-- MUSCL horizontal advective fluxes |
---|
[503] | 172 | DO jj = 2, jpjm1 |
---|
| 173 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[2528] | 174 | ! MUSCL fluxes |
---|
[10802] | 175 | z0u = SIGN( 0.5, pu(ji,jj,jk) ) |
---|
[2528] | 176 | zalpha = 0.5 - z0u |
---|
[10802] | 177 | zu = z0u - 0.5 * pu(ji,jj,jk) * p2dt * r1_e1e2u(ji,jj) / e3u(ji,jj,jk,ktlev) |
---|
| 178 | zzwx = pt(ji+1,jj,jk,jn) + xind(ji,jj,jk) * zu * zslpx(ji+1,jj,jk) |
---|
| 179 | zzwy = pt(ji ,jj,jk,jn) + xind(ji,jj,jk) * zu * zslpx(ji ,jj,jk) |
---|
| 180 | zwx(ji,jj,jk) = pu(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) |
---|
[2528] | 181 | ! |
---|
[10802] | 182 | z0v = SIGN( 0.5, pv(ji,jj,jk) ) |
---|
[2528] | 183 | zalpha = 0.5 - z0v |
---|
[10802] | 184 | zv = z0v - 0.5 * pv(ji,jj,jk) * p2dt * r1_e1e2v(ji,jj) / e3v(ji,jj,jk,ktlev) |
---|
| 185 | zzwx = pt(ji,jj+1,jk,jn) + xind(ji,jj,jk) * zv * zslpy(ji,jj+1,jk) |
---|
| 186 | zzwy = pt(ji,jj ,jk,jn) + xind(ji,jj,jk) * zv * zslpy(ji,jj ,jk) |
---|
| 187 | zwy(ji,jj,jk) = pv(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) |
---|
[503] | 188 | END DO |
---|
| 189 | END DO |
---|
| 190 | END DO |
---|
[10425] | 191 | CALL lbc_lnk_multi( 'traadv_mus', zwx, 'U', -1. , zwy, 'V', -1. ) ! lateral boundary conditions (changed sign) |
---|
[503] | 192 | ! |
---|
[6140] | 193 | DO jk = 1, jpkm1 !-- Tracer advective trend |
---|
[2528] | 194 | DO jj = 2, jpjm1 |
---|
| 195 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[10802] | 196 | pt_rhs(ji,jj,jk,jn) = pt_rhs(ji,jj,jk,jn) - ( zwx(ji,jj,jk) - zwx(ji-1,jj ,jk ) & |
---|
[5770] | 197 | & + zwy(ji,jj,jk) - zwy(ji ,jj-1,jk ) ) & |
---|
[10802] | 198 | & * r1_e1e2t(ji,jj) / e3t(ji,jj,jk,ktlev) |
---|
[3] | 199 | END DO |
---|
[2528] | 200 | END DO |
---|
| 201 | END DO |
---|
[6140] | 202 | ! ! trend diagnostics |
---|
[7646] | 203 | IF( l_trd ) THEN |
---|
[10802] | 204 | CALL trd_tra( kt, cdtype, jn, jptra_xad, zwx, pu, pt(:,:,:,jn) ) |
---|
| 205 | CALL trd_tra( kt, cdtype, jn, jptra_yad, zwy, pv, pt(:,:,:,jn) ) |
---|
[2528] | 206 | END IF |
---|
[7646] | 207 | ! ! "Poleward" heat and salt transports |
---|
| 208 | IF( l_ptr ) CALL dia_ptr_hst( jn, 'adv', zwy(:,:,:) ) |
---|
| 209 | ! ! heat transport |
---|
| 210 | IF( l_hst ) CALL dia_ar5_hst( jn, 'adv', zwx(:,:,:), zwy(:,:,:) ) |
---|
[6140] | 211 | ! |
---|
| 212 | ! !* Vertical advective fluxes |
---|
| 213 | ! |
---|
[5770] | 214 | ! !-- first guess of the slopes |
---|
[7753] | 215 | zwx(:,:, 1 ) = 0._wp ! surface & bottom boundary conditions |
---|
| 216 | zwx(:,:,jpk) = 0._wp |
---|
[6140] | 217 | DO jk = 2, jpkm1 ! interior values |
---|
[10802] | 218 | zwx(:,:,jk) = tmask(:,:,jk) * ( pt(:,:,jk-1,jn) - pt(:,:,jk,jn) ) |
---|
[3] | 219 | END DO |
---|
[5770] | 220 | ! !-- Slopes of tracer |
---|
[7753] | 221 | zslpx(:,:,1) = 0._wp ! surface values |
---|
[5770] | 222 | DO jk = 2, jpkm1 ! interior value |
---|
[2528] | 223 | DO jj = 1, jpj |
---|
| 224 | DO ji = 1, jpi |
---|
[6140] | 225 | zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji,jj,jk+1) ) & |
---|
| 226 | & * ( 0.25 + SIGN( 0.25, zwx(ji,jj,jk) * zwx(ji,jj,jk+1) ) ) |
---|
[2528] | 227 | END DO |
---|
[3] | 228 | END DO |
---|
| 229 | END DO |
---|
[6140] | 230 | DO jk = 2, jpkm1 !-- Slopes limitation |
---|
| 231 | DO jj = 1, jpj ! interior values |
---|
[2528] | 232 | DO ji = 1, jpi |
---|
| 233 | zslpx(ji,jj,jk) = SIGN( 1., zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji,jj,jk ) ), & |
---|
| 234 | & 2.*ABS( zwx (ji,jj,jk+1) ), & |
---|
| 235 | & 2.*ABS( zwx (ji,jj,jk ) ) ) |
---|
| 236 | END DO |
---|
[3] | 237 | END DO |
---|
| 238 | END DO |
---|
[6140] | 239 | DO jk = 1, jpk-2 !-- vertical advective flux |
---|
[2528] | 240 | DO jj = 2, jpjm1 |
---|
| 241 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
| 242 | z0w = SIGN( 0.5, pwn(ji,jj,jk+1) ) |
---|
| 243 | zalpha = 0.5 + z0w |
---|
[6140] | 244 | zw = z0w - 0.5 * pwn(ji,jj,jk+1) * p2dt * r1_e1e2t(ji,jj) / e3w_n(ji,jj,jk+1) |
---|
[10802] | 245 | zzwx = pt(ji,jj,jk+1,jn) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk+1) |
---|
| 246 | zzwy = pt(ji,jj,jk ,jn) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk ) |
---|
[5770] | 247 | zwx(ji,jj,jk+1) = pwn(ji,jj,jk+1) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) * wmask(ji,jj,jk) |
---|
[2528] | 248 | END DO |
---|
[3] | 249 | END DO |
---|
| 250 | END DO |
---|
[6140] | 251 | IF( ln_linssh ) THEN ! top values, linear free surface only |
---|
| 252 | IF( ln_isfcav ) THEN ! ice-shelf cavities (top of the ocean) |
---|
[5770] | 253 | DO jj = 1, jpj |
---|
| 254 | DO ji = 1, jpi |
---|
[10802] | 255 | zwx(ji,jj, mikt(ji,jj) ) = pwn(ji,jj,mikt(ji,jj)) * pt(ji,jj,mikt(ji,jj),jn) |
---|
[5770] | 256 | END DO |
---|
| 257 | END DO |
---|
[6140] | 258 | ELSE ! no cavities: only at the ocean surface |
---|
[10802] | 259 | zwx(:,:,1) = pwn(:,:,1) * pt(:,:,1,jn) |
---|
[5770] | 260 | ENDIF |
---|
| 261 | ENDIF |
---|
| 262 | ! |
---|
[6140] | 263 | DO jk = 1, jpkm1 !-- vertical advective trend |
---|
[2528] | 264 | DO jj = 2, jpjm1 |
---|
[503] | 265 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[10802] | 266 | pt_rhs(ji,jj,jk,jn) = pt_rhs(ji,jj,jk,jn) - ( zwx(ji,jj,jk) - zwx(ji,jj,jk+1) ) * r1_e1e2t(ji,jj) / e3t(ji,jj,jk,ktlev) |
---|
[503] | 267 | END DO |
---|
| 268 | END DO |
---|
| 269 | END DO |
---|
[6140] | 270 | ! ! send trends for diagnostic |
---|
[10802] | 271 | IF( l_trd ) CALL trd_tra( kt, cdtype, jn, jptra_zad, zwx, pwn, pt(:,:,:,jn) ) |
---|
[503] | 272 | ! |
---|
[6140] | 273 | END DO ! end of tracer loop |
---|
[503] | 274 | ! |
---|
[5770] | 275 | END SUBROUTINE tra_adv_mus |
---|
[3] | 276 | |
---|
| 277 | !!====================================================================== |
---|
[5770] | 278 | END MODULE traadv_mus |
---|