MODULE agrif_top_interp !!====================================================================== !! *** MODULE agrif_top_interp *** !! AGRIF: interpolation package for TOP !!====================================================================== !! History : 2.0 ! ??? !!---------------------------------------------------------------------- #if defined key_agrif && defined key_top !!---------------------------------------------------------------------- !! 'key_agrif' AGRIF zoom !! 'key_top' on-line tracers !!---------------------------------------------------------------------- USE par_oce USE oce USE dom_oce USE agrif_oce USE agrif_top_sponge USE par_trc USE trc ! USE lib_mpp ! MPP library IMPLICIT NONE PRIVATE PUBLIC Agrif_trc, interptrn !!---------------------------------------------------------------------- !! NEMO/NST 4.0 , NEMO Consortium (2018) !! $Id$ !! Software governed by the CeCILL licence (./LICENSE) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE Agrif_trc !!---------------------------------------------------------------------- !! *** ROUTINE Agrif_trc *** !!---------------------------------------------------------------------- ! IF( Agrif_Root() ) RETURN ! Agrif_SpecialValue = 0._wp Agrif_UseSpecialValue = .TRUE. ! CALL Agrif_Bc_variable( trn_id, procname=interptrn ) Agrif_UseSpecialValue = .FALSE. ! END SUBROUTINE Agrif_trc SUBROUTINE interptrn( ptab, i1, i2, j1, j2, k1, k2, n1, n2, before, nb, ndir ) !!---------------------------------------------------------------------- !! *** ROUTINE interptrn *** !!---------------------------------------------------------------------- REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) :: ptab INTEGER , INTENT(in ) :: i1, i2, j1, j2, k1, k2, n1, n2 LOGICAL , INTENT(in ) :: before INTEGER , INTENT(in ) :: nb , ndir !! INTEGER :: ji, jj, jk, jn ! dummy loop indices INTEGER :: imin, imax, jmin, jmax LOGICAL :: ll_west, ll_east, ll_north, ll_south REAL(wp) :: zrhox, z1, z2, z3, z4, z5, z6, z7 !!---------------------------------------------------------------------- ! INTEGER :: ji, jj, jk, jn ! dummy loop indices INTEGER :: imin, imax, jmin, jmax, N_in, N_out REAL(wp) :: zrhox , zalpha1, zalpha2, zalpha3 REAL(wp) :: zalpha4, zalpha5, zalpha6, zalpha7 LOGICAL :: western_side, eastern_side,northern_side,southern_side ! vertical interpolation: REAL(wp), DIMENSION(i1:i2,j1:j2,1:jpk,n1:n2) :: ptab_child REAL(wp), DIMENSION(k1:k2,n1:n2-1) :: tabin REAL(wp), DIMENSION(k1:k2) :: h_in REAL(wp), DIMENSION(1:jpk) :: h_out(1:jpk) REAL(wp) :: h_diff, zrhoxy zrhoxy = Agrif_rhox()*Agrif_rhoy() IF (before) THEN DO jn = 1,jpts DO jk=k1,k2 DO jj=j1,j2 DO ji=i1,i2 ptab(ji,jj,jk,jn) = trn(ji,jj,jk,jn) END DO END DO END DO END DO # if defined key_vertical DO jk=k1,k2 DO jj=j1,j2 DO ji=i1,i2 ptab(ji,jj,jk,jpts+1) = tmask(ji,jj,jk) * e3t_n(ji,jj,jk) END DO END DO END DO # endif ELSE ! western_side = (nb == 1).AND.(ndir == 1) eastern_side = (nb == 1).AND.(ndir == 2) southern_side = (nb == 2).AND.(ndir == 1) northern_side = (nb == 2).AND.(ndir == 2) # if defined key_vertical DO jj=j1,j2 DO ji=i1,i2 iref = ji jref = jj if(western_side) iref=MAX(2,ji) if(eastern_side) iref=MIN(nlci-1,ji) if(southern_side) jref=MAX(2,jj) if(northern_side) jref=MIN(nlcj-1,jj) N_in = 0 DO jk=k1,k2 !k2 = jpk of parent grid IF (ptab(ji,jj,jk,n2) == 0) EXIT N_in = N_in + 1 tabin(jk,:) = ptab(ji,jj,jk,n1:n2-1) h_in(N_in) = ptab(ji,jj,jk,n2) END DO N_out = 0 DO jk=1,jpk ! jpk of child grid IF (tmask(iref,jref,jk) == 0) EXIT N_out = N_out + 1 h_out(jk) = e3t_n(iref,jref,jk) ENDDO IF (N_in > 0) THEN h_diff = sum(h_out(1:N_out))-sum(h_in(1:N_in)) DO jn=1,jptra call reconstructandremap(tabin(1:N_in,jn),h_in,ptab_child(ji,jj,1:N_out,jn),h_out,N_in,N_out) ENDDO ENDIF ENDDO ENDDO # else ptab_child(i1:i2,j1:j2,1:jpk,1:jptra) = ptab(i1:i2,j1:j2,1:jpk,1:jptra) # endif ! zrhox = Agrif_Rhox() ! zalpha1 = ( zrhox - 1. ) * 0.5 zalpha2 = 1. - zalpha1 ! zalpha3 = ( zrhox - 1. ) / ( zrhox + 1. ) zalpha4 = 1. - zalpha3 ! zalpha6 = 2. * ( zrhox - 1. ) / ( zrhox + 1. ) zalpha7 = - ( zrhox - 1. ) / ( zrhox + 3. ) zalpha5 = 1. - zalpha6 - zalpha7 ! imin = i1 imax = i2 jmin = j1 jmax = j2 ! ! Remove CORNERS IF((nbondj == -1).OR.(nbondj == 2)) jmin = 3 IF((nbondj == +1).OR.(nbondj == 2)) jmax = nlcj-2 IF((nbondi == -1).OR.(nbondi == 2)) imin = 3 IF((nbondi == +1).OR.(nbondi == 2)) imax = nlci-2 ! IF( eastern_side) THEN DO jn = 1, jptra tra(nlci,j1:j2,1:jpk,jn) = zalpha1 * ptab_child(nlci,j1:j2,1:jpk,jn) + zalpha2 * ptab_child(nlci-1,j1:j2,1:jpk,jn) DO jk = 1, jpkm1 DO jj = jmin,jmax IF( umask(nlci-2,jj,jk) == 0.e0 ) THEN tra(nlci-1,jj,jk,jn) = tra(nlci,jj,jk,jn) * tmask(nlci-1,jj,jk) ELSE tra(nlci-1,jj,jk,jn)=(zalpha4*tra(nlci,jj,jk,jn)+zalpha3*tra(nlci-2,jj,jk,jn))*tmask(nlci-1,jj,jk) IF( un(nlci-2,jj,jk) > 0.e0 ) THEN tra(nlci-1,jj,jk,jn)=( zalpha6*tra(nlci-2,jj,jk,jn)+zalpha5*tra(nlci,jj,jk,jn) & + zalpha7*tra(nlci-3,jj,jk,jn) ) * tmask(nlci-1,jj,jk) ENDIF END DO END DO END DO ENDDO ENDIF ! IF( northern_side ) THEN DO jn = 1, jptra tra(i1:i2,nlcj,1:jpk,jn) = zalpha1 * ptab_child(i1:i2,nlcj,1:jpk,jn) + zalpha2 * ptab_child(i1:i2,nlcj-1,1:jpk,jn) DO jk = 1, jpkm1 DO ji = imin,imax IF( vmask(ji,nlcj-2,jk) == 0.e0 ) THEN tra(ji,nlcj-1,jk,jn) = tra(ji,nlcj,jk,jn) * tmask(ji,nlcj-1,jk) ELSE tra(ji,nlcj-1,jk,jn)=(zalpha4*tra(ji,nlcj,jk,jn)+zalpha3*tra(ji,nlcj-2,jk,jn))*tmask(ji,nlcj-1,jk) IF (vn(ji,nlcj-2,jk) > 0.e0 ) THEN tra(ji,nlcj-1,jk,jn)=( zalpha6*tra(ji,nlcj-2,jk,jn)+zalpha5*tra(ji,nlcj,jk,jn) & + zalpha7*tra(ji,nlcj-3,jk,jn) ) * tmask(ji,nlcj-1,jk) ENDIF END DO END DO END DO ENDDO ENDIF ! IF( western_side) THEN DO jn = 1, jptra tra(1,j1:j2,1:jpk,jn) = zalpha1 * ptab_child(1,j1:j2,1:jpk,jn) + zalpha2 * ptab_child(2,j1:j2,1:jpk,jn) DO jk = 1, jpkm1 DO jj = jmin,jmax IF( umask(2,jj,jk) == 0.e0 ) THEN tra(2,jj,jk,jn) = tra(1,jj,jk,jn) * tmask(2,jj,jk) ELSE tra(2,jj,jk,jn)=(zalpha4*tra(1,jj,jk,jn)+zalpha3*tra(3,jj,jk,jn))*tmask(2,jj,jk) IF( un(2,jj,jk) < 0.e0 ) THEN tra(2,jj,jk,jn)=(zalpha6*tra(3,jj,jk,jn)+zalpha5*tra(1,jj,jk,jn)+zalpha7*tra(4,jj,jk,jn))*tmask(2,jj,jk) ENDIF END DO END DO END DO END DO ENDIF ! IF( southern_side ) THEN DO jn = 1, jptra tra(i1:i2,1,1:jpk,jn) = zalpha1 * ptab_child(i1:i2,1,1:jpk,jn) + zalpha2 * ptab_child(i1:i2,2,1:jpk,jn) DO jk=1,jpkm1 DO ji=imin,imax IF( vmask(ji,2,jk) == 0.e0 ) THEN tra(ji,2,jk,jn)=tra(ji,1,jk,jn) * tmask(ji,2,jk) ELSE tra(ji,2,jk,jn)=(zalpha4*tra(ji,1,jk,jn)+zalpha3*tra(ji,3,jk,jn))*tmask(ji,2,jk) IF( vn(ji,2,jk) < 0.e0 ) THEN tra(ji,2,jk,jn)=(zalpha6*tra(ji,3,jk,jn)+zalpha5*tra(ji,1,jk,jn)+zalpha7*tra(ji,4,jk,jn))*tmask(ji,2,jk) ENDIF END DO END DO END DO ENDIF ! ! Treatment of corners IF( ll_east .AND.((nbondj == -1).OR.(nbondj == 2)) ) tra(nlci-1, 2 ,:,:) = ptab(nlci-1, 2 ,:,:) ! East south IF( ll_east .AND.((nbondj == 1).OR.(nbondj == 2)) ) tra(nlci-1,nlcj-1,:,:) = ptab(nlci-1,nlcj-1,:,:) ! East north IF( ll_west .AND.((nbondj == -1).OR.(nbondj == 2)) ) tra( 2 , 2 ,:,:) = ptab( 2 , 2 ,:,:) ! West south IF( ll_west .AND.((nbondj == 1).OR.(nbondj == 2)) ) tra( 2 ,nlcj-1,:,:) = ptab( 2 ,nlcj-1,:,:) ! West north ! ENDIF ! ! Treatment of corners ! ! East south IF ((eastern_side).AND.((nbondj == -1).OR.(nbondj == 2))) THEN tra(nlci-1,2,:,:) = ptab_child(nlci-1,2,:,:) ENDIF ! East north IF ((eastern_side).AND.((nbondj == 1).OR.(nbondj == 2))) THEN tra(nlci-1,nlcj-1,:,:) = ptab_child(nlci-1,nlcj-1,:,:) ENDIF ! West south IF ((western_side).AND.((nbondj == -1).OR.(nbondj == 2))) THEN tra(2,2,:,:) = ptab_child(2,2,:,:) ENDIF ! West north IF ((western_side).AND.((nbondj == 1).OR.(nbondj == 2))) THEN tra(2,nlcj-1,:,:) = ptab_child(2,nlcj-1,:,:) ENDIF ! ENDIF ! END SUBROUTINE interptrn #else !!---------------------------------------------------------------------- !! Empty module no TOP AGRIF !!---------------------------------------------------------------------- CONTAINS SUBROUTINE Agrif_TOP_Interp_empty !!--------------------------------------------- !! *** ROUTINE agrif_Top_Interp_empty *** !!--------------------------------------------- WRITE(*,*) 'agrif_top_interp : You should not have seen this print! error?' END SUBROUTINE Agrif_TOP_Interp_empty #endif !!====================================================================== END MODULE agrif_top_interp