MODULE bdylib !!====================================================================== !! *** MODULE bdylib *** !! Unstructured Open Boundary Cond. : Library module of generic boundary algorithms. !!====================================================================== !! History : 3.6 ! 2013 (D. Storkey) new module !!---------------------------------------------------------------------- #if defined key_bdy !!---------------------------------------------------------------------- !! 'key_bdy' : Unstructured Open Boundary Condition !!---------------------------------------------------------------------- !! bdy_orlanski_2d !! bdy_orlanski_3d !!---------------------------------------------------------------------- USE timing ! Timing USE oce ! ocean dynamics and tracers USE dom_oce ! ocean space and time domain USE bdy_oce ! ocean open boundary conditions USE phycst ! physical constants USE lbclnk ! ocean lateral boundary conditions (or mpp link) USE in_out_manager ! IMPLICIT NONE PRIVATE PUBLIC bdy_orlanski_2d ! routine called where? PUBLIC bdy_orlanski_3d ! routine called where? !!---------------------------------------------------------------------- !! NEMO/OPA 3.3 , NEMO Consortium (2010) !! $Id: bdydyn.F90 2528 2010-12-27 17:33:53Z rblod $ !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE bdy_orlanski_2d( idx, igrd, phib, phia, phi_ext, mask, ll_npo ) !!---------------------------------------------------------------------- !! *** SUBROUTINE bdy_orlanski_2d *** !! !! - Apply Orlanski radiation condition adaptively to 2D fields: !! - radiation plus weak nudging at outflow points !! - no radiation and strong nudging at inflow points !! !! !! References: Marchesiello, McWilliams and Shchepetkin, Ocean Modelling vol. 3 (2001) !!---------------------------------------------------------------------- TYPE(OBC_INDEX), INTENT(in) :: idx ! BDY indices INTEGER, INTENT(in) :: igrd ! grid index REAL(wp), DIMENSION(:,:), INTENT(in) :: phib ! model before 2D field REAL(wp), DIMENSION(:,:), INTENT(inout) :: phia ! model after 2D field (to be updated) REAL(wp), DIMENSION(:), INTENT(in) :: phi_ext ! external forcing data REAL(wp), DIMENSION(:,:), INTENT(in) :: mask ! land/sea mask LOGICAL, INTENT(in) :: ll_npo ! switch for NPO version INTEGER :: jb ! dummy loop indices INTEGER :: ii, ij, iibm1, iibm2, ijbm1, ijbm2 ! 2D addresses INTEGER :: iijm1, iijp1, ijjm1, ijjp1 ! 2D addresses INTEGER :: iibm1jp1, iibm1jm1, ijbm1jp1, ijbm1jm1 ! 2D addresses INTEGER :: flagu, flagv ! short cuts REAL(wp) :: zdt, zdx, zdy, znor2, zcx, zcy ! intermediate calculations REAL(wp) :: zout, zwgt, zdy_centred, zsign_ups !!---------------------------------------------------------------------- IF( nn_timing == 1 ) CALL timing_start('bdy_orlanski_2d') ! ----------------------------------! ! Orlanski boundary conditions :! ! ----------------------------------! ! DO jb = 1, idx%nblenrim(igrd) ii = idx%nbi(jb,igrd) ij = idx%nbj(jb,igrd) flagu = int( idx%flagu(jb,igrd) ) flagv = int( idx%flagv(jb,igrd) ) ! ! calculate positions of b-1 and b-2 points for this rim point ! also (b-1,j-1) and (b-1,j+1) points iibm1 = ii + flagu ; iibm2 = ii + 2*flagu ijbm1 = ij + flagv ; ijbm2 = ij + 2*flagv ! iijm1 = ii - abs(flagv) ; iijp1 = ii + abs(flagv) ijjm1 = ij - abs(flagu) ; ijjp1 = ij + abs(flagu) ! iibm1jm1 = ii + flagu - abs(flagv) ; iibm1jp1 = ii + flagu + abs(flagv) ijbm1jm1 = ij + flagv - abs(flagu) ; ijbm1jp1 = ij + flagv + abs(flagu) ! ! calculate normal (zcx) and tangential (zcy) components of radiation velocities: zdt = phia(iibm1,ijbm1) - phib(iibm1,ijbm1) zdx = phia(iibm1,ijbm1) - phia(iibm2,ijbm2) zdy_centred = phib(iibm1jp1,ijbm1jp1) - phib(iibm1jm1,ijbm1jm1) ! upstream differencing for tangential derivatives zsign_ups = sign( 1., zdt * zdy_centred ) zsign_ups = 0.5*( zsign_ups + abs(zsign_ups) ) zdy = zsign_ups * ( phib(iibm1 ,ijbm1 ) - phib(iibm1jm1,ijbm1jm1) ) & & + (1. - zsign_ups) * ( phib(iibm1jp1,ijbm1jp1) - phib(iibm1 ,ijbm1 ) ) znor2 = zdx * zdx + zdy * zdy znor2 = max(znor2,rsmall) zcx = zdt * zdx / znor2 zcy = zdt * zdy / znor2 ! ! update boundary value: zout = sign( 1., zcx ) zout = 0.5*( zout + abs(zout) ) zwgt = (1.-zout) * idx%nbd(jb,igrd) + zout * idx%nbdout(jb,igrd) ! only apply radiation on outflow points if( ll_npo ) then !! NPO version !! phia(ii,ij) = (1.-zout) * phia(ii,ij) & & + zout * ( phib(ii,ij) + zcx*phia(iibm1,ijbm1) ) / ( 1. + zcx ) else !! full oblique radiation !! zsign_ups = sign( 1., zcy ) zsign_ups = 0.5*( zsign_ups + abs(zsign_ups) ) phia(ii,ij) = (1.-zout) * phia(ii,ij) & & + zout * ( phib(ii,ij) + zcx*phia(iibm1,ijbm1) & & - zsign_ups * zcy * ( phib(ii ,ij ) - phib(iijm1,ijjm1 ) ) & & - (1.-zsign_ups) * zcy * ( phib(iijp1,ijjp1) - phib(ii ,ij ) ) ) / ( 1. + zcx ) end if phia(ii,ij) = phia(ii,ij) + zwgt * ( phi_ext(jb) - phia(ii,ij) ) phia(ii,ij) = phia(ii,ij) * mask(ii,ij) END DO ! IF( nn_timing == 1 ) CALL timing_stop('bdy_orlanski_2d') END SUBROUTINE bdy_orlanski_2d SUBROUTINE bdy_orlanski_3d( idx, igrd, phib, phia, phi_ext, mask, ll_npo ) !!---------------------------------------------------------------------- !! *** SUBROUTINE bdy_orlanski_3d *** !! !! - Apply Orlanski radiation condition adaptively to 3D fields: !! - radiation plus weak nudging at outflow points !! - no radiation and strong nudging at inflow points !! !! !! References: Marchesiello, McWilliams and Shchepetkin, Ocean Modelling vol. 3 (2001) !!---------------------------------------------------------------------- TYPE(OBC_INDEX), INTENT(in) :: idx ! BDY indices INTEGER, INTENT(in) :: igrd ! grid index REAL(wp), DIMENSION(:,:,:), INTENT(in) :: phib ! model before 3D field REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: phia ! model after 3D field (to be updated) REAL(wp), DIMENSION(:,:), INTENT(in) :: phi_ext ! external forcing data REAL(wp), DIMENSION(:,:,:), INTENT(in) :: mask ! land/sea mask LOGICAL, INTENT(in) :: ll_npo ! switch for NPO version INTEGER :: jb, jk ! dummy loop indices INTEGER :: ii, ij, iibm1, iibm2, ijbm1, ijbm2 ! 2D addresses INTEGER :: iijm1, iijp1, ijjm1, ijjp1 ! 2D addresses INTEGER :: iibm1jp1, iibm1jm1, ijbm1jp1, ijbm1jm1 ! 2D addresses INTEGER :: flagu, flagv ! short cuts REAL(wp) :: zdt, zdx, zdy, znor2, zcx, zcy ! intermediate calculations REAL(wp) :: zout, zwgt, zdy_centred, zsign_ups !!---------------------------------------------------------------------- IF( nn_timing == 1 ) CALL timing_start('bdy_orlanski_3d') ! ----------------------------------! ! Orlanski boundary conditions :! ! ----------------------------------! DO jk = 1, jpk ! DO jb = 1, idx%nblenrim(igrd) ii = idx%nbi(jb,igrd) ij = idx%nbj(jb,igrd) flagu = int( idx%flagu(jb,igrd) ) flagv = int( idx%flagv(jb,igrd) ) ! ! calculate positions of b-1 and b-2 points for this rim point ! also (b-1,j-1) and (b-1,j+1) points iibm1 = ii + flagu ; iibm2 = ii + 2*flagu ijbm1 = ij + flagv ; ijbm2 = ij + 2*flagv ! iijm1 = ii - abs(flagv) ; iijp1 = ii + abs(flagv) ijjm1 = ij - abs(flagu) ; ijjp1 = ij + abs(flagu) ! iibm1jm1 = ii + flagu - abs(flagv) ; iibm1jp1 = ii + flagu + abs(flagv) ijbm1jm1 = ij + flagv - abs(flagu) ; ijbm1jp1 = ij + flagv + abs(flagu) ! ! calculate normal (zcx) and tangential (zcy) components of radiation velocities: zdt = phia(iibm1,ijbm1,jk) - phib(iibm1,ijbm1,jk) zdx = phia(iibm1,ijbm1,jk) - phia(iibm2,ijbm2,jk) zdy_centred = phib(iibm1jp1,ijbm1jp1,jk) - phib(iibm1jm1,ijbm1jm1,jk) ! upstream differencing for tangential derivatives zsign_ups = sign( 1., zdt * zdy_centred ) zsign_ups = 0.5*( zsign_ups + abs(zsign_ups) ) zdy = zsign_ups * ( phib(iibm1 ,ijbm1 ,jk) - phib(iibm1jm1,ijbm1jm1,jk) ) & & + (1. - zsign_ups) * ( phib(iibm1jp1,ijbm1jp1,jk) - phib(iibm1 ,ijbm1 ,jk) ) znor2 = zdx * zdx + zdy * zdy znor2 = max(znor2,rsmall) zcx = zdt * zdx / znor2 zcy = zdt * zdy / znor2 ! ! update boundary value: zout = sign( 1., zcx ) zout = 0.5*( zout + abs(zout) ) zwgt = (1.-zout) * idx%nbd(jb,igrd) + zout * idx%nbdout(jb,igrd) ! only apply radiation on outflow points if( ll_npo ) then !! NPO version !! phia(ii,ij,jk) = (1.-zout) * phia(ii,ij,jk) & & + zout * ( phib(ii,ij,jk) + zcx*phia(iibm1,ijbm1,jk) ) / ( 1. + zcx ) else !! full oblique radiation !! zsign_ups = sign( 1., zcy ) zsign_ups = 0.5*( zsign_ups + abs(zsign_ups) ) phia(ii,ij,jk) = (1.-zout) * phia(ii,ij,jk) & & + zout * ( phib(ii,ij,jk) + zcx*phia(iibm1,ijbm1,jk) & & - zsign_ups * zcy * ( phib(ii ,ij ,jk) - phib(iijm1,ijjm1,jk ) ) & & - (1.-zsign_ups) * zcy * ( phib(iijp1,ijjp1,jk) - phib(ii ,ij ,jk ) ) ) / ( 1. + zcx ) end if phia(ii,ij,jk) = phia(ii,ij,jk) + zwgt * ( phi_ext(jb,jk) - phia(ii,ij,jk) ) phia(ii,ij,jk) = phia(ii,ij,jk) * mask(ii,ij,jk) END DO ! END DO IF( nn_timing == 1 ) CALL timing_stop('bdy_orlanski_3d') END SUBROUTINE bdy_orlanski_3d #else !!---------------------------------------------------------------------- !! Dummy module NO Unstruct Open Boundary Conditions !!---------------------------------------------------------------------- CONTAINS SUBROUTINE bdy_orlanski_2d( idx, igrd, phib, phia, phi_ext ) ! Empty routine WRITE(*,*) 'bdy_orlanski_2d: You should not have seen this print! error?', kt END SUBROUTINE bdy_orlanski_2d SUBROUTINE bdy_orlanski_3d( idx, igrd, phib, phia, phi_ext ) ! Empty routine WRITE(*,*) 'bdy_orlanski_3d: You should not have seen this print! error?', kt END SUBROUTINE bdy_orlanski_3d #endif !!====================================================================== END MODULE bdylib