MODULE traadv_muscl !!====================================================================== !! *** MODULE traadv_muscl *** !! Ocean tracers: horizontal & vertical advective trend !!====================================================================== !! History : ! 2000-06 (A.Estublier) for passive tracers !! ! 2001-08 (E.Durand, G.Madec) adapted for T & S !! NEMO 1.0 ! 2002-06 (G. Madec) F90: Free form and module !! 3.2 ! 2010-05 (C. Ethe, G. Madec) merge TRC-TRA + switch from velocity to transport !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! tra_adv_muscl : update the tracer trend with the horizontal !! and vertical advection trends using MUSCL scheme !!---------------------------------------------------------------------- USE oce ! ocean dynamics and active tracers USE dom_oce ! ocean space and time domain USE trdmod_oce ! tracers trends USE trdtra ! tracers trends USE in_out_manager ! I/O manager USE dynspg_oce ! choice/control of key cpp for surface pressure gradient USE trabbl ! tracers: bottom boundary layer USE lib_mpp ! distribued memory computing USE lbclnk ! ocean lateral boundary condition (or mpp link) USE diaptr ! poleward transport diagnostics USE trc_oce ! share passive tracers/Ocean variables IMPLICIT NONE PRIVATE PUBLIC tra_adv_muscl ! routine called by step.F90 LOGICAL :: l_trd ! flag to compute trends !! * Control permutation of array indices # include "oce_ftrans.h90" # include "dom_oce_ftrans.h90" # include "trc_oce_ftrans.h90" !! * Substitutions # include "domzgr_substitute.h90" # include "vectopt_loop_substitute.h90" !!---------------------------------------------------------------------- !! NEMO/OPA 3.3 , NEMO Consortium (2010) !! $Id$ !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE tra_adv_muscl( kt, cdtype, p2dt, pun, pvn, pwn, & & ptb, pta, kjpt ) !!---------------------------------------------------------------------- !! *** ROUTINE tra_adv_muscl *** !! !! ** Purpose : Compute the now trend due to total advection of T and !! S using a MUSCL scheme (Monotone Upstream-centered Scheme for !! Conservation Laws) and add it to the general tracer trend. !! !! ** Method : MUSCL scheme plus centered scheme at ocean boundaries !! !! ** Action : - update (ta,sa) with the now advective tracer trends !! - save trends !! !! References : Estubier, A., and M. Levy, Notes Techn. Pole de Modelisation !! IPSL, Sept. 2000 (http://www.lodyc.jussieu.fr/opa) !!---------------------------------------------------------------------- USE wrk_nemo, ONLY: wrk_in_use, wrk_not_released USE oce , ONLY: zwx => ua , zwy => va ! (ua,va) used as workspace USE wrk_nemo, ONLY: zslpx => wrk_3d_1 , zslpy => wrk_3d_2 ! 3D workspace !! DCSE_NEMO: need additional directives for renamed module variables !FTRANS zwx zwy zslpx zslpy :I :I :z ! INTEGER , INTENT(in ) :: kt ! ocean time-step index CHARACTER(len=3) , INTENT(in ) :: cdtype ! =TRA or TRC (tracer indicator) INTEGER , INTENT(in ) :: kjpt ! number of tracers REAL(wp), DIMENSION( jpkorig ), INTENT(in ) :: p2dt ! vertical profile of tracer time-step !! DCSE_NEMO: This style defeats ftrans ! REAL(wp), DIMENSION(jpi,jpj,jpk ), INTENT(in ) :: pun, pvn, pwn ! 3 ocean velocity components ! REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in ) :: ptb ! before tracer field ! REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(inout) :: pta ! tracer trend !FTRANS pun pvn pwn :I :I :z !FTRANS ptb :I :I :z : !FTRANS pta :I :I :z : REAL(wp), INTENT(in ) :: pun(jpi,jpj,jpkorig) ! ocean velocity component (u) REAL(wp), INTENT(in ) :: pvn(jpi,jpj,jpkorig) ! ocean velocity component (v) REAL(wp), INTENT(in ) :: pwn(jpi,jpj,jpkorig) ! ocean velocity component (w) REAL(wp), INTENT(in ) :: ptb(jpi,jpj,jpkorig,kjpt) ! tracer fields (before) REAL(wp), INTENT(inout) :: pta(jpi,jpj,jpkorig,kjpt) ! tracer trend ! INTEGER :: ji, jj, jk, jn ! dummy loop indices REAL(wp) :: zu, z0u, zzwx, zw ! local scalars REAL(wp) :: zv, z0v, zzwy, z0w ! - - REAL(wp) :: ztra, zbtr, zdt, zalpha ! - - !!---------------------------------------------------------------------- IF( wrk_in_use(3, 1,2) ) THEN CALL ctl_stop('tra_adv_muscl: requested workspace arrays unavailable') ; RETURN ENDIF IF( kt == nit000 ) THEN IF(lwp) WRITE(numout,*) IF(lwp) WRITE(numout,*) 'tra_adv : MUSCL advection scheme on ', cdtype IF(lwp) WRITE(numout,*) '~~~~~~~' ! l_trd = .FALSE. IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE. ENDIF ! ! =========== DO jn = 1, kjpt ! tracer loop ! ! =========== ! I. Horizontal advective fluxes ! ------------------------------ ! first guess of the slopes zwx(:,:,jpk) = 0.e0 ; zwy(:,:,jpk) = 0.e0 ! bottom values ! interior values #if defined key_z_first DO jj = 1, jpjm1 DO ji = 1, jpim1 DO jk = 1, jpkm1 #else DO jk = 1, jpkm1 DO jj = 1, jpjm1 DO ji = 1, fs_jpim1 ! vector opt. #endif zwx(ji,jj,jk) = umask(ji,jj,jk) * ( ptb(ji+1,jj,jk,jn) - ptb(ji,jj,jk,jn) ) zwy(ji,jj,jk) = vmask(ji,jj,jk) * ( ptb(ji,jj+1,jk,jn) - ptb(ji,jj,jk,jn) ) END DO END DO END DO ! CALL lbc_lnk( zwx, 'U', -1. ) ! lateral boundary conditions on zwx, zwy (changed sign) CALL lbc_lnk( zwy, 'V', -1. ) ! !-- Slopes of tracer zslpx(:,:,jpk) = 0.e0 ; zslpy(:,:,jpk) = 0.e0 ! bottom values #if defined key_z_first DO jj = 2, jpj ! interior values DO ji = 2, jpi DO jk = 1, jpkm1 #else DO jk = 1, jpkm1 ! interior values DO jj = 2, jpj DO ji = fs_2, jpi ! vector opt. #endif zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji-1,jj ,jk) ) & & * ( 0.25 + SIGN( 0.25, zwx(ji,jj,jk) * zwx(ji-1,jj ,jk) ) ) zslpy(ji,jj,jk) = ( zwy(ji,jj,jk) + zwy(ji ,jj-1,jk) ) & & * ( 0.25 + SIGN( 0.25, zwy(ji,jj,jk) * zwy(ji ,jj-1,jk) ) ) END DO END DO END DO ! #if defined key_z_first DO jj = 2, jpj ! Slopes limitation DO ji = 2, jpi DO jk = 1, jpkm1 #else DO jk = 1, jpkm1 ! Slopes limitation DO jj = 2, jpj DO ji = fs_2, jpi ! vector opt. #endif zslpx(ji,jj,jk) = SIGN( 1., zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji ,jj,jk) ), & & 2.*ABS( zwx (ji-1,jj,jk) ), & & 2.*ABS( zwx (ji ,jj,jk) ) ) zslpy(ji,jj,jk) = SIGN( 1., zslpy(ji,jj,jk) ) * MIN( ABS( zslpy(ji,jj ,jk) ), & & 2.*ABS( zwy (ji,jj-1,jk) ), & & 2.*ABS( zwy (ji,jj ,jk) ) ) END DO END DO END DO ! interior values ! !-- MUSCL horizontal advective fluxes #if defined key_z_first DO jj = 2, jpjm1 ! interior values DO ji = 2, jpim1 DO jk = 1, jpkm1 zdt = p2dt(jk) #else DO jk = 1, jpkm1 ! interior values zdt = p2dt(jk) DO jj = 2, jpjm1 DO ji = fs_2, fs_jpim1 ! vector opt. #endif ! MUSCL fluxes z0u = SIGN( 0.5, pun(ji,jj,jk) ) zalpha = 0.5 - z0u zu = z0u - 0.5 * pun(ji,jj,jk) * zdt / ( e1u(ji,jj) * e2u(ji,jj) * fse3u(ji,jj,jk) ) zzwx = ptb(ji+1,jj,jk,jn) + zu * zslpx(ji+1,jj,jk) zzwy = ptb(ji ,jj,jk,jn) + zu * zslpx(ji ,jj,jk) zwx(ji,jj,jk) = pun(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) ! z0v = SIGN( 0.5, pvn(ji,jj,jk) ) zalpha = 0.5 - z0v zv = z0v - 0.5 * pvn(ji,jj,jk) * zdt / ( e1v(ji,jj) * e2v(ji,jj) * fse3v(ji,jj,jk) ) zzwx = ptb(ji,jj+1,jk,jn) + zv * zslpy(ji,jj+1,jk) zzwy = ptb(ji,jj ,jk,jn) + zv * zslpy(ji,jj ,jk) zwy(ji,jj,jk) = pvn(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) END DO END DO END DO ! ! lateral boundary conditions on zwx, zwy (changed sign) CALL lbc_lnk( zwx, 'U', -1. ) ; CALL lbc_lnk( zwy, 'V', -1. ) ! ! Tracer flux divergence at t-point added to the general trend #if defined key_z_first DO jj = 2, jpjm1 DO ji = 2, jpim1 DO jk = 1, jpkm1 #else DO jk = 1, jpkm1 DO jj = 2, jpjm1 DO ji = fs_2, fs_jpim1 ! vector opt. #endif zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) ) ! horizontal advective trends ztra = - zbtr * ( zwx(ji,jj,jk) - zwx(ji-1,jj ,jk ) & & + zwy(ji,jj,jk) - zwy(ji ,jj-1,jk ) ) ! add it to the general tracer trends pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) + ztra END DO END DO END DO ! ! trend diagnostics (contribution of upstream fluxes) IF( l_trd ) THEN CALL trd_tra( kt, cdtype, jn, jptra_trd_xad, zwx, pun, ptb(:,:,:,jn) ) CALL trd_tra( kt, cdtype, jn, jptra_trd_yad, zwy, pvn, ptb(:,:,:,jn) ) END IF ! ! "Poleward" heat and salt transports (contribution of upstream fluxes) IF( cdtype == 'TRA' .AND. ln_diaptr .AND. ( MOD( kt, nn_fptr ) == 0 ) ) THEN IF( jn == jp_tem ) htr_adv(:) = ptr_vj( zwy(:,:,:) ) IF( jn == jp_sal ) str_adv(:) = ptr_vj( zwy(:,:,:) ) ENDIF ! II. Vertical advective fluxes ! ----------------------------- ! !-- first guess of the slopes #if defined key_z_first DO jj = 1, jpj DO ji = 1, jpi zwx(ji,jj,1) = 0.e0 ! surface boundary conditions DO jk = 2, jpkm1 ! interior values zwx(ji,jj,jk) = tmask(ji,jj,jk) * ( ptb(ji,jj,jk-1,jn) - ptb(ji,jj,jk,jn) ) END DO zwx(ji,jj,jpk) = 0.e0 ! bottom boundary conditions END DO END DO #else zwx (:,:, 1 ) = 0.e0 ; zwx (:,:,jpk) = 0.e0 ! surface & bottom boundary conditions DO jk = 2, jpkm1 ! interior values zwx(:,:,jk) = tmask(:,:,jk) * ( ptb(:,:,jk-1,jn) - ptb(:,:,jk,jn) ) END DO #endif ! !-- Slopes of tracer #if defined key_z_first DO jj = 1, jpj DO ji = 1, jpi zslpx(ji,jj,1) = 0.e0 ! surface values DO jk = 2, jpkm1 ! interior value #else zslpx(:,:,1) = 0.e0 ! surface values DO jk = 2, jpkm1 ! interior value DO jj = 1, jpj DO ji = 1, jpi #endif zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji,jj,jk+1) ) & & * ( 0.25 + SIGN( 0.25, zwx(ji,jj,jk) * zwx(ji,jj,jk+1) ) ) END DO END DO END DO ! !-- Slopes limitation #if defined key_z_first DO jj = 1, jpj DO ji = 1, jpi DO jk = 2, jpkm1 ! interior values #else DO jk = 2, jpkm1 ! interior values DO jj = 1, jpj DO ji = 1, jpi #endif zslpx(ji,jj,jk) = SIGN( 1., zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji,jj,jk ) ), & & 2.*ABS( zwx (ji,jj,jk+1) ), & & 2.*ABS( zwx (ji,jj,jk ) ) ) END DO END DO END DO ! !-- vertical advective flux ! ! surface values (bottom already set to zero) IF( lk_vvl ) THEN ; zwx(:,:, 1 ) = 0.e0 ! variable volume ELSE ; zwx(:,:, 1 ) = pwn(:,:,1) * ptb(:,:,1,jn) ! linear free surface ENDIF ! #if defined key_z_first DO jj = 2, jpjm1 ! interior values DO ji = 2, jpim1 DO jk = 1, jpkm1 zdt = p2dt(jk) #else DO jk = 1, jpkm1 ! interior values zdt = p2dt(jk) DO jj = 2, jpjm1 DO ji = fs_2, fs_jpim1 ! vector opt. #endif zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3w(ji,jj,jk+1) ) z0w = SIGN( 0.5, pwn(ji,jj,jk+1) ) zalpha = 0.5 + z0w zw = z0w - 0.5 * pwn(ji,jj,jk+1) * zdt * zbtr zzwx = ptb(ji,jj,jk+1,jn) + zw * zslpx(ji,jj,jk+1) zzwy = ptb(ji,jj,jk ,jn) + zw * zslpx(ji,jj,jk ) zwx(ji,jj,jk+1) = pwn(ji,jj,jk+1) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) END DO END DO END DO ! Compute & add the vertical advective trend #if defined key_z_first DO jj = 2, jpjm1 DO ji = 2, jpim1 DO jk = 1, jpkm1 #else DO jk = 1, jpkm1 DO jj = 2, jpjm1 DO ji = fs_2, fs_jpim1 ! vector opt. #endif zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) ) ! vertical advective trends ztra = - zbtr * ( zwx(ji,jj,jk) - zwx(ji,jj,jk+1) ) ! add it to the general tracer trends pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) + ztra END DO END DO END DO ! ! Save the vertical advective trends for diagnostic IF( l_trd ) CALL trd_tra( kt, cdtype, jn, jptra_trd_zad, zwx, pwn, ptb(:,:,:,jn) ) ! ENDDO ! IF( wrk_not_released(3, 1,2) ) CALL ctl_stop('tra_adv_muscl: requested workspace arrays unavailable') ! END SUBROUTINE tra_adv_muscl !!====================================================================== END MODULE traadv_muscl