MODULE iscplrst !!====================================================================== !! *** MODULE iscplrst*** !! Ocean forcing: update the restart file in case of ice sheet/ocean coupling !!===================================================================== !! History : NEMO ! 2015-01 P. Mathiot: original !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! iscpl_stp : step management !! iscpl_rst_interpol : restart interpolation in case of coupling with ice sheet !!---------------------------------------------------------------------- USE dom_oce ! ocean space and time domain USE domwri ! ocean space and time domain USE domvvl, ONLY : dom_vvl_interpol USE phycst ! physical constants USE sbc_oce ! surface boundary condition variables USE oce ! global tra/dyn variable USE in_out_manager ! I/O manager USE iom ! I/O module USE lib_mpp ! MPP library USE lib_fortran ! MPP library USE wrk_nemo ! Memory allocation USE lbclnk ! communication USE iscplini ! ice sheet coupling: initialisation !USE iscplhsb ! ice sheet coupling: conservation USE iscpldiv IMPLICIT NONE PRIVATE PUBLIC iscpl_stp ! step management !! !! * Substitutions # include "domzgr_substitute.h90" # include "vectopt_loop_substitute.h90" !!---------------------------------------------------------------------- !! NEMO/OPA 3.3 , NEMO Consortium (2010) !! $Id: sbcrnf.F90 4666 2014-06-11 12:52:23Z mathiot $ !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE iscpl_stp !!---------------------------------------------------------------------- !! *** ROUTINE iscpl_stp *** !! !! ** Purpose : compute initialisation !! compute extrapolation of restart variable un, vn, tsn, sshn (wetting/drying) !! compute correction term if needed !! !!---------------------------------------------------------------------- INTEGER :: inum0 REAL(wp), DIMENSION(:,: ), POINTER :: zsmask_b REAL(wp), DIMENSION(:,:,:), POINTER :: ztmask_b, zumask_b, zvmask_b REAL(wp), DIMENSION(:,:,:), POINTER :: ze3t_b , ze3u_b , ze3v_b REAL(wp), DIMENSION(:,:,:), POINTER :: zdepw_b CHARACTER(20) :: cfile !!---------------------------------------------------------------------- CALL wrk_alloc(jpi,jpj,jpk, ztmask_b, zumask_b, zvmask_b) ! mask before CALL wrk_alloc(jpi,jpj,jpk, ze3t_b , ze3u_b , ze3v_b ) ! e3 before CALL wrk_alloc(jpi,jpj,jpk, zdepw_b ) CALL wrk_alloc(jpi,jpj, zsmask_b ) !! get restart variable CALL iom_get( numror, jpdom_autoglo, 'tmask' , ztmask_b ) ! need to extrapolate T/S CALL iom_get( numror, jpdom_autoglo, 'umask' , zumask_b ) ! need to correct barotropic velocity CALL iom_get( numror, jpdom_autoglo, 'vmask' , zvmask_b ) ! need to correct barotropic velocity CALL iom_get( numror, jpdom_autoglo, 'smask' , zsmask_b ) ! need to correct barotropic velocity CALL iom_get( numror, jpdom_autoglo, 'fse3t_n' , ze3t_b(:,:,:) ) ! need to compute temperature correction CALL iom_get( numror, jpdom_autoglo, 'fse3u_n' , ze3u_b(:,:,:) ) ! need to correct barotropic velocity CALL iom_get( numror, jpdom_autoglo, 'fse3v_n' , ze3v_b(:,:,:) ) ! need to correct barotropic velocity CALL iom_get( numror, jpdom_autoglo, 'fsdepw_n', zdepw_b(:,:,:) ) ! need to interpol vertical profile (vvl) !! read namelist CALL iscpl_init() !! ! Extrapolation/interpolation of modify cell and new cells ... (maybe do it later after domvvl) CALL iscpl_rst_interpol( ztmask_b, zumask_b, zvmask_b, zsmask_b, ze3t_b, ze3u_b, ze3v_b, zdepw_b ) !! print mesh/mask IF( nmsh /= 0 .AND. ln_iscpl ) CALL dom_wri ! Create a domain file CALL wrk_dealloc(jpi,jpj,jpk, ztmask_b,zumask_b,zvmask_b ) CALL wrk_dealloc(jpi,jpj,jpk, ze3t_b ,ze3u_b ,ze3v_b ) CALL wrk_dealloc(jpi,jpj,jpk, zdepw_b ) CALL wrk_dealloc(jpi,jpj, zsmask_b ) !! next step is an euler time step neuler = 0 !! set _b and _n variables equal tsb (:,:,:,:) = tsn (:,:,:,:) ub (:,:,: ) = un (:,:,: ) vb (:,:,: ) = vn (:,:,: ) sshb(:,: ) = sshn(:,:) !! set _b and _n vertical scale factor equal fse3t_b (:,:,:) = fse3t_n (:,:,:) fse3u_b (:,:,:) = fse3u_n (:,:,:) fse3v_b (:,:,:) = fse3v_n (:,:,:) IF ( lk_vvl ) THEN fse3uw_b(:,:,:) = fse3uw_n(:,:,:) fse3vw_b(:,:,:) = fse3vw_n(:,:,:) fsdept_b(:,:,:) = fsdept_n(:,:,:) fsdepw_b(:,:,:) = fsdepw_n(:,:,:) hu_b (:,:) = hu(:,:) hv_b (:,:) = hv(:,:) hur_b(:,:) = hur(:,:) hvr_b(:,:) = hvr(:,:) END IF ! END SUBROUTINE iscpl_stp SUBROUTINE iscpl_rst_interpol (ptmask_b, pumask_b, pvmask_b, psmask_b, pe3t_b, pe3u_b, pe3v_b, pdepw_b) !!---------------------------------------------------------------------- !! *** ROUTINE iscpl_rst_interpol *** !! !! ** Purpose : compute new tn, sn, un, vn and sshn in case of evolving geometry of ice shelves !! compute 2d fields of heat, salt and volume correction !! !! ** Method : tn, sn : extrapolation from neigbourg cells !! un, vn : fill with 0 velocity and keep barotropic transport by modifing surface velocity or adjacent velocity !!---------------------------------------------------------------------- REAL(wp), DIMENSION(:,:,: ), INTENT(in ) :: ptmask_b, pumask_b, pvmask_b !! mask before REAL(wp), DIMENSION(:,:,: ), INTENT(in ) :: pe3t_b , pe3u_b , pe3v_b !! scale factor before REAL(wp), DIMENSION(:,:,: ), INTENT(in ) :: pdepw_b !! depth w before REAL(wp), DIMENSION(:,: ), INTENT(in ) :: psmask_b !! mask before !! INTEGER :: ji, jj, jk, iz !! loop index INTEGER :: jip1, jim1, jjp1, jjm1, jkp1, jkm1, jtop !! REAL(wp):: summsk, zsum, zsum1, zarea, zsumn, zsumb, zhdivdiff, zfp_ui, zfm_ui, zfp_vi, zfm_vi REAL(wp):: zdz, zdzm1, zdzp1, zvol, zuflux_sum, zvflux_sum REAL(wp),DIMENSION(2)::ztrdtsb !! REAL(wp), DIMENSION(:,: ), POINTER :: zdmask , zdsmask, zvcorr, zucorr, zde3t REAL(wp), DIMENSION(:,: ), POINTER :: zbub , zbvb , zbun , zbvn REAL(wp), DIMENSION(:,: ), POINTER :: zssh0 , zssh1, zhu1, zhv1 REAL(wp), DIMENSION(:,: ), POINTER :: zsmask0, zsmask1, isfmask REAL(wp), DIMENSION(:,:,: ), POINTER :: ztmask0, ztmask1, ztrp, zuflux, zvflux, zhdiv, zhdiv2 REAL(wp), DIMENSION(:,:,: ), POINTER :: zwmaskn, zwmaskb, ztmp3d REAL(wp), DIMENSION(:,:,:,:), POINTER :: zts0 !!---------------------------------------------------------------------- !! allocate variables CALL wrk_alloc(jpi,jpj,jpk,2, zts0 ) CALL wrk_alloc(jpi,jpj,jpk, ztmask0, ztmask1 , ztrp, ztmp3d ) CALL wrk_alloc(jpi,jpj,jpk, zwmaskn, zwmaskb, zuflux, zvflux, zhdiv, zhdiv2 ) CALL wrk_alloc(jpi,jpj, zsmask0, zsmask1, isfmask ) CALL wrk_alloc(jpi,jpj, zdmask , zdsmask, zvcorr, zucorr, zde3t) CALL wrk_alloc(jpi,jpj, zbub , zbvb , zbun , zbvn ) CALL wrk_alloc(jpi,jpj, zssh0 , zssh1, zhu1, zhv1 ) !! mask value to be sure tsn(:,:,:,jp_tem) = tsn(:,:,:,jp_tem) * ptmask_b(:,:,:) tsn(:,:,:,jp_sal) = tsn(:,:,:,jp_sal) * ptmask_b(:,:,:) ! compute wmask zwmaskn(:,:,1) = tmask (:,:,1) zwmaskb(:,:,1) = ptmask_b(:,:,1) DO jk = 2,jpk zwmaskn(:,:,jk) = tmask (:,:,jk) * tmask (:,:,jk-1) zwmaskb(:,:,jk) = ptmask_b(:,:,jk) * ptmask_b(:,:,jk-1) END DO ! compute new ssh if we open a full water column (average of the closest neigbourgs) sshb (:,:)=sshn(:,:) zssh0(:,:)=sshn(:,:) zsmask0(:,:) = psmask_b(:,:) zsmask1(:,:) = psmask_b(:,:) DO iz = 1,nn_drown ! need to be tuned (configuration dependent) (OK for ISOMIP+) zdsmask(:,:) = ssmask(:,:)-zsmask0(:,:) DO jj = 2,jpj-1 DO ji = fs_2, fs_jpim1 ! vector opt. jip1=ji+1; jim1=ji-1; jjp1=jj+1; jjm1=jj-1; summsk=(zsmask0(jip1,jj)+zsmask0(jim1,jj)+zsmask0(ji,jjp1)+zsmask0(ji,jjm1)) IF (zdsmask(ji,jj) == 1._wp .AND. summsk /= 0._wp) THEN sshn(ji,jj)=( zssh0(jip1,jj)*zsmask0(jip1,jj) & & + zssh0(jim1,jj)*zsmask0(jim1,jj) & & + zssh0(ji,jjp1)*zsmask0(ji,jjp1) & & + zssh0(ji,jjm1)*zsmask0(ji,jjm1))/summsk zsmask1(ji,jj)=1._wp END IF END DO END DO CALL lbc_lnk(sshn,'T',1._wp) CALL lbc_lnk(zsmask1,'T',1._wp) zssh0 = sshn zsmask0 = zsmask1 END DO sshn(:,:) = sshn(:,:) * ssmask(:,:) !============================================================================= IF ( lk_vvl ) THEN ! Reconstruction of all vertical scale factors at now time steps ! ============================================================================= ! Horizontal scale factor interpolations ! -------------------------------------- DO jk = 1,jpk DO jj=1,jpj DO ji=1,jpi IF (tmask(ji,jj,1) == 0._wp .OR. ptmask_b(ji,jj,1) == 0._wp) THEN fse3t_n(ji,jj,jk) = e3t_0(ji,jj,jk) * ( 1._wp + sshn(ji,jj) / ( ht_0(ji,jj) + 1._wp - ssmask(ji,jj) ) * tmask(ji,jj,jk) ) ENDIF END DO END DO END DO CALL dom_vvl_interpol( fse3t_n(:,:,:), fse3u_n(:,:,:), 'U' ) CALL dom_vvl_interpol( fse3t_n(:,:,:), fse3v_n(:,:,:), 'V' ) CALL dom_vvl_interpol( fse3u_n(:,:,:), fse3f_n(:,:,:), 'F' ) ! Vertical scale factor interpolations ! ------------------------------------ CALL dom_vvl_interpol( fse3t_n(:,:,:), fse3w_n (:,:,:), 'W' ) CALL dom_vvl_interpol( fse3u_n(:,:,:), fse3uw_n(:,:,:), 'UW' ) CALL dom_vvl_interpol( fse3v_n(:,:,:), fse3vw_n(:,:,:), 'VW' ) ! t- and w- points depth ! ---------------------- fsdept_n(:,:,1) = 0.5_wp * fse3w_n(:,:,1) fsdepw_n(:,:,1) = 0.0_wp fsde3w_n(:,:,1) = fsdept_n(:,:,1) - sshn(:,:) DO jj = 1,jpj DO ji = 1,jpi DO jk = 2,mikt(ji,jj)-1 fsdept_n(ji,jj,jk) = gdept_0(ji,jj,jk) fsdepw_n(ji,jj,jk) = gdepw_0(ji,jj,jk) fsde3w_n(ji,jj,jk) = gdept_0(ji,jj,jk) - sshn(ji,jj) END DO IF (mikt(ji,jj) > 1) THEN jk = mikt(ji,jj) fsdept_n(ji,jj,jk) = gdepw_0(ji,jj,jk) + 0.5_wp * fse3w_n(ji,jj,jk) fsdepw_n(ji,jj,jk) = gdepw_0(ji,jj,jk) fsde3w_n(ji,jj,jk) = fsdept_n(ji,jj,jk ) - sshn (ji,jj) END IF DO jk = mikt(ji,jj)+1, jpk fsdept_n(ji,jj,jk) = fsdept_n(ji,jj,jk-1) + fse3w_n(ji,jj,jk) fsdepw_n(ji,jj,jk) = fsdepw_n(ji,jj,jk-1) + fse3t_n(ji,jj,jk-1) fsde3w_n(ji,jj,jk) = fsdept_n(ji,jj,jk ) - sshn (ji,jj) END DO END DO END DO ! t-, u- and v- water column thickness ! ------------------------------------ ht(:,:) = 0._wp ; hu(:,:) = 0._wp ; hv(:,:) = 0._wp DO jk = 1, jpkm1 hu(:,:) = hu(:,:) + fse3u_n(:,:,jk) * umask(:,:,jk) hv(:,:) = hv(:,:) + fse3v_n(:,:,jk) * vmask(:,:,jk) ht(:,:) = ht(:,:) + fse3t_n(:,:,jk) * tmask(:,:,jk) END DO ! ! Inverse of the local depth hur(:,:) = 1._wp / ( hu(:,:) + 1._wp - umask_i(:,:) ) * umask_i(:,:) hvr(:,:) = 1._wp / ( hv(:,:) + 1._wp - vmask_i(:,:) ) * vmask_i(:,:) END IF !----compute and save the divergence difference (before and after remeshing) CALL iscpl_div_corr(ptmask_b, pe3t_b, pe3u_b, pe3v_b) ! compute temp and salt ! compute new tn and sn if we open a new cell tsb (:,:,:,:) = tsn(:,:,:,:) zts0(:,:,:,:) = tsn(:,:,:,:) ztmask1(:,:,:) = ptmask_b(:,:,:) ztmask0(:,:,:) = ptmask_b(:,:,:) DO iz = 1,nn_drown ! resolution dependent (OK for ISOMIP+ case) DO jk = 1,jpk-1 zdmask=tmask(:,:,jk)-ztmask0(:,:,jk); DO jj = 2,jpj-1 DO ji = fs_2,fs_jpim1 jip1=ji+1; jim1=ji-1; jjp1=jj+1; jjm1=jj-1; summsk= (ztmask0(jip1,jj ,jk)+ztmask0(jim1,jj ,jk)+ztmask0(ji ,jjp1,jk)+ztmask0(ji ,jjm1,jk)) IF (zdmask(ji,jj) == 1._wp .AND. summsk /= 0._wp) THEN !! horizontal basic extrapolation tsn(ji,jj,jk,1)=( zts0(jip1,jj ,jk,1)*ztmask0(jip1,jj ,jk) & & +zts0(jim1,jj ,jk,1)*ztmask0(jim1,jj ,jk) & & +zts0(ji ,jjp1,jk,1)*ztmask0(ji ,jjp1,jk) & & +zts0(ji ,jjm1,jk,1)*ztmask0(ji ,jjm1,jk) ) / summsk tsn(ji,jj,jk,2)=( zts0(jip1,jj ,jk,2)*ztmask0(jip1,jj ,jk) & & +zts0(jim1,jj ,jk,2)*ztmask0(jim1,jj ,jk) & & +zts0(ji ,jjp1,jk,2)*ztmask0(ji ,jjp1,jk) & & +zts0(ji ,jjm1,jk,2)*ztmask0(ji ,jjm1,jk) ) / summsk ztmask1(ji,jj,jk)=1 ELSEIF (zdmask(ji,jj) == 1._wp .AND. summsk == 0._wp) THEN !! vertical extrapolation if horizontal extrapolation failed jkm1=max(1,jk-1) ; jkp1=min(jpk,jk+1) summsk=(ztmask0(ji,jj,jkm1)+ztmask0(ji,jj,jkp1)) IF (zdmask(ji,jj) == 1._wp .AND. summsk /= 0._wp ) THEN tsn(ji,jj,jk,1)=( zts0(ji,jj,jkp1,1)*ztmask0(ji,jj,jkp1) & & +zts0(ji,jj,jkm1,1)*ztmask0(ji,jj,jkm1))/summsk tsn(ji,jj,jk,2)=( zts0(ji,jj,jkp1,2)*ztmask0(ji,jj,jkp1) & & +zts0(ji,jj,jkm1,2)*ztmask0(ji,jj,jkm1))/summsk ztmask1(ji,jj,jk)=1._wp END IF END IF END DO END DO END DO CALL lbc_lnk(tsn(:,:,:,1),'T',1._wp) CALL lbc_lnk(tsn(:,:,:,2),'T',1._wp) CALL lbc_lnk(ztmask1, 'T',1._wp) ! update zts0(:,:,:,:) = tsn(:,:,:,:) ztmask0 = ztmask1 END DO ! mask new tsn field tsn(:,:,:,jp_tem) = tsn(:,:,:,jp_tem) * tmask(:,:,:) tsn(:,:,:,jp_sal) = tsn(:,:,:,jp_sal) * tmask(:,:,:) ! compute new T/S (interpolation) if vvl only for common wet cell in before and after wmask ! IF ( lk_vvl ) THEN ! DO jk = 2,jpk-1 ! DO jj = 1,jpj ! DO ji = 1,jpi ! IF (zwmaskn(ji,jj,jk) * zwmaskb(ji,jj,jk) == 1._wp .AND. (tmask(ji,jj,1)==0._wp .OR. ptmask_b(ji,jj,1)==0._wp) ) THEN ! !compute weight ! zdzp1 = MAX(0._wp,pdepw_b(ji,jj,jk+1) - gdepw_n(ji,jj,jk+1)) ! zdzm1 = MAX(0._wp,gdepw_n(ji,jj,jk ) - pdepw_b(ji,jj,jk )) ! zdz = e3t_n(ji,jj,jk) - zdzp1 - zdzm1 ! if isf : e3t = gdepw_n(ji,jj,jk+1)- gdepw_n(ji,jj,jk) ! ! ! IF (zdz .LT. 0._wp) THEN ! CALL ctl_stop( 'STOP', 'rst_iscpl : unable to compute the interpolation' ) ! END IF ! tsn(ji,jj,jk,jp_tem) = ( zdzp1*tsb(ji,jj,jk+1,jp_tem) & ! & + zdz *tsb(ji,jj,jk ,jp_tem) & ! & + zdzm1*tsb(ji,jj,jk-1,jp_tem) )/e3t_n(ji,jj,jk) ! tsn(ji,jj,jk,jp_sal) = ( zdzp1*tsb(ji,jj,jk+1,jp_sal) & ! & + zdz *tsb(ji,jj,jk ,jp_sal) & ! & + zdzm1*tsb(ji,jj,jk-1,jp_sal) )/e3t_n(ji,jj,jk) ! END IF ! END DO ! END DO ! END DO ! END IF ! closed pool ! ----------------------------------------------------------------------------------------- ! case we open a cell but no neigbour cells available to get an estimate of T and S WHERE (tmask(:,:,:) == 1._wp .AND. tsn(:,:,:,2) == 0._wp) tsn(:,:,:,2) = -99._wp ! Special value for closed pool (checking purpose in output.init) tmask(:,:,:) = 0._wp ! set mask to 0 to run umask(:,:,:) = 0._wp vmask(:,:,:) = 0._wp END WHERE ! set mbkt and mikt to 1 in thiese location WHERE (SUM(tmask,dim=3) == 0) mbkt(:,:)=1 ; mbku(:,:)=1 ; mbkv(:,:)=1 mikt(:,:)=1 ; miku(:,:)=1 ; mikv(:,:)=1 END WHERE ! ------------------------------------------------------------------------------------------- ! compute new tn and sn if we close cell ! nothing to do ! ! deallocation tmp arrays CALL wrk_dealloc(jpi,jpj,jpk,2, zts0 ) CALL wrk_dealloc(jpi,jpj,jpk, ztmask0, ztmask1 , ztrp ) CALL wrk_dealloc(jpi,jpj,jpk, zwmaskn, zwmaskb , ztmp3d, zuflux, zvflux, zhdiv, zhdiv2 ) CALL wrk_dealloc(jpi,jpj, zsmask0, zsmask1, isfmask ) CALL wrk_dealloc(jpi,jpj, zdmask , zdsmask, zvcorr, zucorr, zde3t) CALL wrk_dealloc(jpi,jpj, zbub , zbvb , zbun , zbvn ) CALL wrk_dealloc(jpi,jpj, zssh0 , zssh1 , zhu1 , zhv1 ) END SUBROUTINE iscpl_rst_interpol END MODULE iscplrst