MODULE traadv_cen !!====================================================================== !! *** MODULE traadv_cen *** !! Ocean tracers: advective trend (2nd/4th order centered) !!====================================================================== !! History : 3.7 ! 2014-05 (G. Madec) original code !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! tra_adv_cen : update the tracer trend with the advection trends using a centered or scheme (2nd or 4th order) !! NB: on the vertical it is actually a 4th order COMPACT scheme which is used !!---------------------------------------------------------------------- USE dom_oce ! ocean space and time domain ! TEMP: This change not necessary after trd_tra is tiled USE domain, ONLY : dom_tile USE eosbn2 ! equation of state USE traadv_fct ! acces to routine interp_4th_cpt USE trd_oce ! trends: ocean variables USE trdtra ! trends manager: tracers USE diaptr ! poleward transport diagnostics USE diaar5 ! AR5 diagnostics ! USE in_out_manager ! I/O manager USE iom ! IOM library USE trc_oce ! share passive tracers/Ocean variables USE lib_mpp ! MPP library IMPLICIT NONE PRIVATE PUBLIC tra_adv_cen ! called by traadv.F90 REAL(wp) :: r1_6 = 1._wp / 6._wp ! =1/6 LOGICAL :: l_trd ! flag to compute trends LOGICAL :: l_ptr ! flag to compute poleward transport LOGICAL :: l_hst ! flag to compute heat/salt transport !! * Substitutions # include "do_loop_substitute.h90" # include "domzgr_substitute.h90" !!---------------------------------------------------------------------- !! NEMO/OCE 4.0 , NEMO Consortium (2018) !! $Id$ !! Software governed by the CeCILL license (see ./LICENSE) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE tra_adv_cen( kt, kit000, cdtype, pU, pV, pW, & & Kmm, pt, kjpt, Krhs, kn_cen_h, kn_cen_v ) !!---------------------------------------------------------------------- !! *** ROUTINE tra_adv_cen *** !! !! ** Purpose : Compute the now trend due to the advection of tracers !! and add it to the general trend of passive tracer equations. !! !! ** Method : The advection is evaluated by a 2nd or 4th order scheme !! using now fields (leap-frog scheme). !! kn_cen_h = 2 ==>> 2nd order centered scheme on the horizontal !! = 4 ==>> 4th order - - - - !! kn_cen_v = 2 ==>> 2nd order centered scheme on the vertical !! = 4 ==>> 4th order COMPACT scheme - - !! !! ** Action : - update pt(:,:,:,:,Krhs) with the now advective tracer trends !! - send trends to trdtra module for further diagnostcs (l_trdtra=T) !! - poleward advective heat and salt transport (l_diaptr=T) !!---------------------------------------------------------------------- INTEGER , INTENT(in ) :: kt ! ocean time-step index INTEGER , INTENT(in ) :: Kmm, Krhs ! ocean time level indices INTEGER , INTENT(in ) :: kit000 ! first time step index CHARACTER(len=3) , INTENT(in ) :: cdtype ! =TRA or TRC (tracer indicator) INTEGER , INTENT(in ) :: kjpt ! number of tracers INTEGER , INTENT(in ) :: kn_cen_h ! =2/4 (2nd or 4th order scheme) INTEGER , INTENT(in ) :: kn_cen_v ! =2/4 (2nd or 4th order scheme) ! TEMP: This can be ST_2D(nn_hls) after trd_tra is tiled REAL(wp), DIMENSION(jpi,jpj,jpk ), INTENT(in ) :: pU, pV, pW ! 3 ocean volume flux components REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt,jpt), INTENT(inout) :: pt ! tracers and RHS of tracer equation ! INTEGER :: ji, jj, jk, jn ! dummy loop indices INTEGER :: ierr ! local integer ! TEMP: This change not necessary after trd_tra is tiled INTEGER :: itile REAL(wp) :: zC2t_u, zC2t_v ! local scalars REAL(wp), DIMENSION(ST_2D(nn_hls),jpk) :: zwx, zwy, zwz, ztu, ztv, ztw, zltu, zltv ! TEMP: This change not necessary after trd_tra is tiled REAL(wp), DIMENSION(:,:,:,:), SAVE, ALLOCATABLE :: ztrdx, ztrdy, ztrdz !!---------------------------------------------------------------------- ! TEMP: This change not necessary after trd_tra is tiled itile = ntile ! IF( ntile == 0 .OR. ntile == 1 ) THEN ! Do only on the first tile IF( kt == kit000 ) THEN IF(lwp) WRITE(numout,*) IF(lwp) WRITE(numout,*) 'tra_adv_cen : centered advection scheme on ', cdtype, ' order h/v =', kn_cen_h,'/', kn_cen_v IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~ ' ENDIF ! ! set local switches l_trd = .FALSE. l_hst = .FALSE. l_ptr = .FALSE. IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE. IF( cdtype == 'TRA' .AND. ( iom_use( 'sophtadv' ) .OR. iom_use( 'sophtadv' ) ) ) l_ptr = .TRUE. IF( cdtype == 'TRA' .AND. ( iom_use("uadv_heattr") .OR. iom_use("vadv_heattr") .OR. & & iom_use("uadv_salttr") .OR. iom_use("vadv_salttr") ) ) l_hst = .TRUE. ! TEMP: This can be ST_2D(nn_hls) after trd_tra is tiled IF( kt == kit000 .AND. l_trd ) THEN ALLOCATE( ztrdx(jpi,jpj,jpk,jpts), ztrdy(jpi,jpj,jpk,jpts), ztrdz(jpi,jpj,jpk,jpts) ) ENDIF ENDIF ! ! zwz(:,:, 1 ) = 0._wp ! surface & bottom vertical flux set to zero for all tracers zwz(:,:,jpk) = 0._wp ! DO jn = 1, kjpt !== loop over the tracers ==! ! SELECT CASE( kn_cen_h ) !-- Horizontal fluxes --! ! CASE( 2 ) !* 2nd order centered DO_3D( 1, 0, 1, 0, 1, jpkm1 ) zwx(ji,jj,jk) = 0.5_wp * pU(ji,jj,jk) * ( pt(ji,jj,jk,jn,Kmm) + pt(ji+1,jj ,jk,jn,Kmm) ) zwy(ji,jj,jk) = 0.5_wp * pV(ji,jj,jk) * ( pt(ji,jj,jk,jn,Kmm) + pt(ji ,jj+1,jk,jn,Kmm) ) END_3D ! CASE( 4 ) !* 4th order centered zltu(:,:,jpk) = 0._wp ! Bottom value : flux set to zero zltv(:,:,jpk) = 0._wp DO jk = 1, jpkm1 ! Laplacian DO_2D( 1, 0, 1, 0 ) ztu(ji,jj,jk) = ( pt(ji+1,jj ,jk,jn,Kmm) - pt(ji,jj,jk,jn,Kmm) ) * umask(ji,jj,jk) ztv(ji,jj,jk) = ( pt(ji ,jj+1,jk,jn,Kmm) - pt(ji,jj,jk,jn,Kmm) ) * vmask(ji,jj,jk) END_2D DO_2D( 0, 0, 0, 0 ) zltu(ji,jj,jk) = ztu(ji,jj,jk) + ztu(ji-1,jj,jk) zltv(ji,jj,jk) = ztv(ji,jj,jk) + ztv(ji,jj-1,jk) END_2D END DO CALL lbc_lnk_multi( 'traadv_cen', zltu, 'T', 1. , zltv, 'T', 1. ) ! Lateral boundary cond. (unchanged sgn) ! DO_3D( 1, 0, 1, 0, 1, jpkm1 ) zC2t_u = pt(ji,jj,jk,jn,Kmm) + pt(ji+1,jj ,jk,jn,Kmm) ! C2 interpolation of T at u- & v-points (x2) zC2t_v = pt(ji,jj,jk,jn,Kmm) + pt(ji ,jj+1,jk,jn,Kmm) ! ! C4 fluxes zwx(ji,jj,jk) = 0.5_wp * pU(ji,jj,jk) * ( zC2t_u + r1_6 * (zltu(ji,jj,jk) - zltu(ji+1,jj,jk)) ) zwy(ji,jj,jk) = 0.5_wp * pV(ji,jj,jk) * ( zC2t_v + r1_6 * (zltv(ji,jj,jk) - zltv(ji,jj+1,jk)) ) END_3D ! CASE DEFAULT CALL ctl_stop( 'traadv_fct: wrong value for nn_fct' ) END SELECT ! SELECT CASE( kn_cen_v ) !-- Vertical fluxes --! (interior) ! CASE( 2 ) !* 2nd order centered DO_3D( 0, 0, 0, 0, 2, jpk ) zwz(ji,jj,jk) = 0.5 * pW(ji,jj,jk) * ( pt(ji,jj,jk,jn,Kmm) + pt(ji,jj,jk-1,jn,Kmm) ) * wmask(ji,jj,jk) END_3D ! CASE( 4 ) !* 4th order compact CALL interp_4th_cpt( pt(:,:,:,jn,Kmm) , ztw ) ! ztw = interpolated value of T at w-point DO_3D( 0, 0, 0, 0, 2, jpkm1 ) zwz(ji,jj,jk) = pW(ji,jj,jk) * ztw(ji,jj,jk) * wmask(ji,jj,jk) END_3D ! END SELECT ! IF( ln_linssh ) THEN !* top value (linear free surf. only as zwz is multiplied by wmask) ! TODO: NOT TESTED- requires isf IF( ln_isfcav ) THEN ! ice-shelf cavities (top of the ocean) DO_2D( 1, 1, 1, 1 ) zwz(ji,jj, mikt(ji,jj) ) = pW(ji,jj,mikt(ji,jj)) * pt(ji,jj,mikt(ji,jj),jn,Kmm) END_2D ELSE ! no ice-shelf cavities (only ocean surface) DO_2D( 1, 1, 1, 1 ) zwz(ji,jj,1) = pW(ji,jj,1) * pt(ji,jj,1,jn,Kmm) END_2D ENDIF ENDIF ! DO_3D( 0, 0, 0, 0, 1, jpkm1 ) pt(ji,jj,jk,jn,Krhs) = pt(ji,jj,jk,jn,Krhs) & & - ( zwx(ji,jj,jk) - zwx(ji-1,jj ,jk ) & & + zwy(ji,jj,jk) - zwy(ji ,jj-1,jk ) & & + zwz(ji,jj,jk) - zwz(ji ,jj ,jk+1) ) & & * r1_e1e2t(ji,jj) / e3t(ji,jj,jk,Kmm) END_3D ! ! trend diagnostics ! TEMP: These changes not necessary after trd_tra is tiled IF( l_trd ) THEN DO_3D( 1, 0, 1, 0, 1, jpk ) ztrdx(ji,jj,jk,jn) = zwx(ji,jj,jk) ztrdy(ji,jj,jk,jn) = zwy(ji,jj,jk) ztrdz(ji,jj,jk,jn) = zwz(ji,jj,jk) END_3D IF( ntile == 0 .OR. ntile == nijtile ) THEN ! Do only for the full domain IF( ln_tile ) CALL dom_tile( ntsi, ntsj, ntei, ntej, ktile = 0 ) ! Use full domain ! TODO: TO BE TILED- trd_tra CALL trd_tra( kt, Kmm, Krhs, cdtype, jn, jptra_xad, ztrdx(:,:,:,jn), pU, pt(:,:,:,jn,Kmm) ) CALL trd_tra( kt, Kmm, Krhs, cdtype, jn, jptra_yad, ztrdy(:,:,:,jn), pV, pt(:,:,:,jn,Kmm) ) CALL trd_tra( kt, Kmm, Krhs, cdtype, jn, jptra_zad, ztrdz(:,:,:,jn), pW, pt(:,:,:,jn,Kmm) ) IF( ln_tile ) CALL dom_tile( ntsi, ntsj, ntei, ntej, ktile = itile ) ! Revert to tile domain ENDIF ENDIF ! ! "Poleward" heat and salt transports IF( l_ptr ) CALL dia_ptr_hst( jn, 'adv', zwy(:,:,:) ) ! ! heat and salt transport IF( l_hst ) CALL dia_ar5_hst( jn, 'adv', zwx(:,:,:), zwy(:,:,:) ) ! END DO ! END SUBROUTINE tra_adv_cen !!====================================================================== END MODULE traadv_cen