MODULE usrdef_zgr !!====================================================================== !! *** MODULE usrdef_zgr *** !! !! === SEAMOUNT Test Case === !! !! Ocean domain : user defined vertical coordinate system !!====================================================================== !! History : 4.0 ! 2016-06 (G. Madec) Original code !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! usr_def_zgr : user defined vertical coordinate system (required) !! zgr_z : reference 1D z-coordinate !!--------------------------------------------------------------------- USE oce ! ocean variables USE dom_oce , ONLY: ht_0, mi0, mi1, nimpp, njmpp, & & mj0, mj1, glamt, gphit ! ocean space and time domain USE usrdef_nam ! User defined : namelist variables USE wet_dry , ONLY: rn_wdmin1, rn_wdmin2, rn_wdld ! Wetting and drying ! USE in_out_manager ! I/O manager USE lbclnk ! ocean lateral boundary conditions (or mpp link) USE lib_mpp ! distributed memory computing library IMPLICIT NONE PRIVATE PUBLIC usr_def_zgr ! called by domzgr.F90 !! * Substitutions # include "vectopt_loop_substitute.h90" !!---------------------------------------------------------------------- !! NEMO/OCE 4.0 , NEMO Consortium (2018) !! $Id: usrdef_zgr.F90 10425 2018-12-19 21:54:16Z smasson $ !! Software governed by the CeCILL license (see ./LICENSE) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE usr_def_zgr( ld_zco , ld_zps , ld_sco , ld_isfcav, & ! type of vertical coordinate & pdept_1d, pdepw_1d, pe3t_1d , pe3w_1d , & ! 1D reference vertical coordinate & pdept , pdepw , & ! 3D t & w-points depth & pe3t , pe3u , pe3v , pe3f , & ! vertical scale factors & pe3w , pe3uw , pe3vw , & ! - - - & k_top , k_bot ) ! top & bottom ocean level !!--------------------------------------------------------------------- !! *** ROUTINE usr_def_zgr *** !! !! ** Purpose : User defined the vertical coordinates !! !!---------------------------------------------------------------------- LOGICAL , INTENT(in) :: ld_zco, ld_zps, ld_sco ! vertical coordinate flags LOGICAL , INTENT(out) :: ld_isfcav ! under iceshelf cavity flag REAL(wp), DIMENSION(:) , INTENT(out) :: pdept_1d, pdepw_1d ! 1D grid-point depth [m] REAL(wp), DIMENSION(:) , INTENT(out) :: pe3t_1d , pe3w_1d ! 1D grid-point depth [m] REAL(wp), DIMENSION(:,:,:), INTENT(out) :: pdept, pdepw ! grid-point depth [m] REAL(wp), DIMENSION(:,:,:), INTENT(out) :: pe3t , pe3u , pe3v , pe3f ! vertical scale factors [m] REAL(wp), DIMENSION(:,:,:), INTENT(out) :: pe3w , pe3uw, pe3vw ! i-scale factors INTEGER , DIMENSION(:,:) , INTENT(out) :: k_top, k_bot ! first & last ocean level ! INTEGER :: ji, jj, jk ! dummy indices INTEGER :: ik ! local integers REAL(wp) :: zfact, z1_jpkm1 ! local scalar REAL(wp) :: ze3min ! local scalar REAL(wp) :: zlam_mid, zphi_mid! local scalar REAL(wp), DIMENSION(jpi,jpj) :: zht, zhu, zhv, z2d ! 2D workspace !!---------------------------------------------------------------------- ! IF(lwp) WRITE(numout,*) IF(lwp) WRITE(numout,*) 'usr_def_zgr : SEAMOUNT_TEST_CASE configuration (s-coordinate closed box ocean without cavities)' IF(lwp) WRITE(numout,*) '~~~~~~~~~~~' ! ! ! type of vertical coordinate ==>>> here SEAMOUNT_TEST_CASE : z, z-ps and s-coordinate available ! --------------------------- ld_isfcav = .FALSE. ! ISF Ice Shelves Flag ! ! ! Build the vertical coordinate system ! ------------------------------------ ! ! !== UNmasked meter bathymetry ==! ! ! ! IF(lwp) WRITE(numout,*) IF(lwp) WRITE(numout,*) 'usr_def_zgr (SEAMOUNT) : Isolated 2D Gaussian bump in E-W periodic channel' IF(lwp) WRITE(numout,*) '~~~~~~~~~~' ! zlam_mid = 0.5_wp * 1000._wp * rn_length zphi_mid = 0.5_wp * 1000._wp * rn_width zht = 0._wp DO ji = 1, jpi DO jj = 1, jpj zht(ji,jj) = rn_bathy - rn_seamountheight * EXP( & & - ( ( 1000._wp * glamt(ji,jj) - zlam_mid) ** 2 + ( 1000._wp * gphit(ji,jj) - zphi_mid) ** 2) & & / rn_l ** 2) END DO END DO ! ! at u-point: averaging zht DO ji = 1, jpim1 zhu(ji,:) = 0.5_wp * ( zht(ji,:) + zht(ji+1,:) ) END DO ! CALL lbc_lnk( 'usrdef_zgr', zhu, 'U', 1. ) ! boundary condition: this mask the surrounding grid-points ! ! ==>>> set by hand non-zero value on first/last columns & rows DO ji = mi0(1), mi1(1) ! first row of global domain only zhu(ji,:) = zht(1,:) END DO DO ji = mi0(jpiglo), mi1(jpiglo) ! last row of global domain only zhu(ji,:) = zht(jpi,:) END DO ! at v-point: averaging zht zhv = 0._wp DO jj = 1, jpjm1 zhv(:,jj) = 0.5_wp * ( zht(:,jj) + zht(:,jj+1) ) END DO ! CALL lbc_lnk( 'usrdef_zgr', zhv, 'V', 1. ) ! boundary condition: this mask the surrounding grid-points DO jj = mj0(1), mj1(1) ! first row of global domain only zhv(:,jj) = zht(:,jj) END DO DO jj = mj0(jpjglo), mj1(jpjglo) ! last row of global domain only zhv(:,jj) = zht(:,jj) END DO ! CALL zgr_z( pdept_1d, pdepw_1d, pe3t_1d , pe3w_1d ) ! Reference z-coordinate system ! ! ! !== top masked level bathymetry ==! (all coordinates) ! ! no ocean cavities : top ocean level is ONE, except over land ! the ocean basin surrounnded by land (1 grid-point) set through lbc_lnk call as jperio=0 z2d(:,:) = 1._wp ! surface ocean is the 1st level ! z2d(mi0(1):mi1(1),:) = 0._wp ! z2d(mi0(jpiglo):mi1(jpiglo),:) = 0._wp ! z2d(:,mj0(1):mj1(1)) = 0._wp ! z2d(:,mj0(jpjglo):mj1(jpjglo)) = 0._wp ! ! ! CALL lbc_lnk( 'usrdef_zgr', z2d, 'T', 1. ) ! closed basin since jperio = 0 (see userdef_nam.F90) k_top(:,:) = NINT( z2d(:,:) ) ! ! ! IF ( ld_zco ) THEN !== z-coordinate ==! (step-like topography) ! ! !* bottom ocean compute from the depth of grid-points k_bot(:,:) = jpkm1 * k_top(:,:) ! here use k_top as a land mask DO jk = 1, jpkm1 WHERE( pdept_1d(jk) < zht(:,:) .AND. zht(:,:) <= pdept_1d(jk+1) ) k_bot(:,:) = jk * k_top(:,:) END DO ! !* horizontally uniform coordinate (reference z-co everywhere) DO jk = 1, jpk pdept(:,:,jk) = pdept_1d(jk) pdepw(:,:,jk) = pdepw_1d(jk) pe3t (:,:,jk) = pe3t_1d (jk) pe3u (:,:,jk) = pe3t_1d (jk) pe3v (:,:,jk) = pe3t_1d (jk) pe3f (:,:,jk) = pe3t_1d (jk) pe3w (:,:,jk) = pe3w_1d (jk) pe3uw(:,:,jk) = pe3w_1d (jk) pe3vw(:,:,jk) = pe3w_1d (jk) END DO ENDIF IF ( ld_zps ) THEN !== zps-coordinate ==! (partial bottom-steps) ! ze3min = 0.1_wp * rn_dz IF(lwp) WRITE(numout,*) ' minimum thickness of the partial cells = 10 % of e3 = ', ze3min ! ! ! !* bottom ocean compute from the depth of grid-points k_bot(:,:) = jpkm1 DO jk = jpkm1, 1, -1 WHERE( zht(:,:) < pdepw_1d(jk) + ze3min ) k_bot(:,:) = jk-1 END DO ! ! !* vertical coordinate system DO jk = 1, jpk ! initialization to the reference z-coordinate pdept(:,:,jk) = pdept_1d(jk) pdepw(:,:,jk) = pdepw_1d(jk) pe3t (:,:,jk) = pe3t_1d (jk) pe3u (:,:,jk) = pe3t_1d (jk) pe3v (:,:,jk) = pe3t_1d (jk) pe3f (:,:,jk) = pe3t_1d (jk) pe3w (:,:,jk) = pe3w_1d (jk) pe3uw(:,:,jk) = pe3w_1d (jk) pe3vw(:,:,jk) = pe3w_1d (jk) END DO DO jj = 1, jpj ! bottom scale factors and depth at T- and W-points DO ji = 1, jpi ik = k_bot(ji,jj) pdepw(ji,jj,ik+1) = MIN( zht(ji,jj) , pdepw_1d(ik+1) ) pe3t (ji,jj,ik ) = pdepw(ji,jj,ik+1) - pdepw(ji,jj,ik) pe3t (ji,jj,ik+1) = pe3t (ji,jj,ik ) ! pdept(ji,jj,ik ) = pdepw(ji,jj,ik ) + pe3t (ji,jj,ik ) * 0.5_wp pdept(ji,jj,ik+1) = pdepw(ji,jj,ik+1) + pe3t (ji,jj,ik+1) * 0.5_wp pe3w (ji,jj,ik+1) = pdept(ji,jj,ik+1) - pdept(ji,jj,ik) ! = pe3t (ji,jj,ik ) END DO END DO ! ! bottom scale factors and depth at U-, V-, UW and VW-points ! ! usually Computed as the minimum of neighbooring scale factors pe3u (:,:,:) = pe3t(:,:,:) ! HERE OVERFLOW configuration : pe3v (:,:,:) = pe3t(:,:,:) ! e3 increases with i-index and identical with j-index pe3f (:,:,:) = pe3t(:,:,:) ! so e3 minimum of (i,i+1) points is (i) point pe3uw(:,:,:) = pe3w(:,:,:) ! in j-direction e3v=e3t and e3f=e3v pe3vw(:,:,:) = pe3w(:,:,:) ! ==>> no need of lbc_lnk calls ! ENDIF ! IF ( ld_sco ) THEN !== s-coordinate ==! (terrain-following coordinate) ! ht_0 = zht k_bot(:,:) = jpkm1 * k_top(:,:) !* bottom ocean = jpk-1 (here use k_top as a land mask) ! !* terrain-following coordinate with e3.(k)=cst) ! ! OVERFLOW case : identical with j-index (T=V, U=F) DO jj = 1, jpjm1 DO ji = 1, jpim1 z1_jpkm1 = 1._wp / REAL( k_bot(ji,jj) - k_top(ji,jj) + 1 , wp) DO jk = 1, jpk pdept(ji,jj,jk) = zht(ji,jj) * z1_jpkm1 * ( REAL( jk , wp ) - 0.5_wp ) pdepw(ji,jj,jk) = zht(ji,jj) * z1_jpkm1 * ( REAL( jk-1 , wp ) ) pe3t (ji,jj,jk) = zht(ji,jj) * z1_jpkm1 pe3w (ji,jj,jk) = zht(ji,jj) * z1_jpkm1 pe3u (ji,jj,jk) = zhu(ji,jj) * z1_jpkm1 pe3uw(ji,jj,jk) = zhu(ji,jj) * z1_jpkm1 pe3f (ji,jj,jk) = zhu(ji,jj) * z1_jpkm1 pe3v (ji,jj,jk) = zhv(ji,jj) * z1_jpkm1 pe3vw(ji,jj,jk) = zhv(ji,jj) * z1_jpkm1 END DO END DO END DO CALL lbc_lnk( 'usrdef_zgr', pdept, 'T', 1. ) CALL lbc_lnk( 'usrdef_zgr', pdepw, 'T', 1. ) CALL lbc_lnk( 'usrdef_zgr', pe3t , 'T', 1. ) CALL lbc_lnk( 'usrdef_zgr', pe3w , 'T', 1. ) CALL lbc_lnk( 'usrdef_zgr', pe3u , 'U', 1. ) CALL lbc_lnk( 'usrdef_zgr', pe3uw, 'U', 1. ) CALL lbc_lnk( 'usrdef_zgr', pe3f , 'F', 1. ) CALL lbc_lnk( 'usrdef_zgr', pe3v , 'V', 1. ) CALL lbc_lnk( 'usrdef_zgr', pe3vw, 'V', 1. ) WHERE( pe3t (:,:,:) == 0._wp ) pe3t (:,:,:) = 1._wp WHERE( pe3u (:,:,:) == 0._wp ) pe3u (:,:,:) = 1._wp WHERE( pe3v (:,:,:) == 0._wp ) pe3v (:,:,:) = 1._wp WHERE( pe3f (:,:,:) == 0._wp ) pe3f (:,:,:) = 1._wp WHERE( pe3w (:,:,:) == 0._wp ) pe3w (:,:,:) = 1._wp WHERE( pe3uw(:,:,:) == 0._wp ) pe3uw(:,:,:) = 1._wp WHERE( pe3vw(:,:,:) == 0._wp ) pe3vw(:,:,:) = 1._wp ENDIF ! ! ! END SUBROUTINE usr_def_zgr SUBROUTINE zgr_z( pdept_1d, pdepw_1d, pe3t_1d , pe3w_1d ) ! 1D reference vertical coordinate !!---------------------------------------------------------------------- !! *** ROUTINE zgr_z *** !! !! ** Purpose : set the depth of model levels and the resulting !! vertical scale factors. !! !! ** Method : 1D z-coordinate system (use in all type of coordinate) !! The depth of model levels is set from dep(k), an analytical function: !! w-level: depw_1d = dep(k) !! t-level: dept_1d = dep(k+0.5) !! The scale factors are the discrete derivative of the depth: !! e3w_1d(jk) = dk[ dept_1d ] !! e3t_1d(jk) = dk[ depw_1d ] !! !! === Here constant vertical resolution === !! !! ** Action : - pdept_1d, pdepw_1d : depth of T- and W-point (m) !! - pe3t_1d , pe3w_1d : scale factors at T- and W-levels (m) !!---------------------------------------------------------------------- REAL(wp), DIMENSION(:), INTENT(out) :: pdept_1d, pdepw_1d ! 1D grid-point depth [m] REAL(wp), DIMENSION(:), INTENT(out) :: pe3t_1d , pe3w_1d ! 1D vertical scale factors [m] ! INTEGER :: jk ! dummy loop indices REAL(wp) :: zt, zw ! local scalar !!---------------------------------------------------------------------- ! IF(lwp) THEN ! Parameter print WRITE(numout,*) WRITE(numout,*) ' zgr_z : Reference vertical z-coordinates: uniform dz = ', rn_dz WRITE(numout,*) ' ~~~~~~~' ENDIF ! ! Reference z-coordinate (depth - scale factor at T- and W-points) ! Madec & Imbard 1996 function ! ---------------------- DO jk = 1, jpk zw = REAL( jk , wp ) zt = REAL( jk , wp ) + 0.5_wp pdepw_1d(jk) = rn_dz * REAL( jk-1 , wp ) pdept_1d(jk) = rn_dz * ( REAL( jk-1 , wp ) + 0.5_wp ) pe3w_1d (jk) = rn_dz pe3t_1d (jk) = rn_dz END DO ! IF(lwp) THEN ! control print WRITE(numout,*) WRITE(numout,*) ' Reference 1D z-coordinate depth and scale factors:' WRITE(numout, "(9x,' level gdept_1d gdepw_1d e3t_1d e3w_1d ')" ) WRITE(numout, "(10x, i4, 4f9.2)" ) ( jk, pdept_1d(jk), pdepw_1d(jk), pe3t_1d(jk), pe3w_1d(jk), jk = 1, jpk ) ENDIF ! END SUBROUTINE zgr_z !!====================================================================== END MODULE usrdef_zgr