MODULE ini_hmixcoef_mod ! ! git $Id$ ! svn $Id: ini_hmixcoef.F 1151 2023-02-09 03:08:53Z arango $ !================================================== Hernan G. Arango === ! Copyright (c) 2002-2023 The ROMS/TOMS Group ! ! Licensed under a MIT/X style license ! ! See License_ROMS.md ! !======================================================================= ! ! ! This routine initializes horizontal mixing coefficients arrays ! ! according to the model flag. ! ! ! ! WARNING: All biharmonic coefficients are assumed to have the ! ! square root taken and have m^2 s^-1/2 units. This ! ! will allow multiplying the biharmonic coefficient ! ! to harmonic operator. ! ! ! !======================================================================= ! implicit none PRIVATE PUBLIC :: ini_hmixcoef CONTAINS ! !*********************************************************************** SUBROUTINE ini_hmixcoef (ng, tile, model) !*********************************************************************** ! USE mod_param USE mod_grid USE mod_mixing USE mod_ncparam USE mod_scalars ! ! Imported variable declarations. ! integer, intent(in) :: ng, tile, model ! ! Local variable declarations. ! real(r8) :: diffusion2(MT), diffusion4(MT) real(r8) :: viscosity2, viscosity4 ! integer :: IminS, ImaxS, JminS, JmaxS integer :: LBi, UBi, LBj, UBj, LBij, UBij ! ! Set horizontal starting and ending indices for automatic private ! storage arrays. ! IminS=BOUNDS(ng)%Istr(tile)-3 ImaxS=BOUNDS(ng)%Iend(tile)+3 JminS=BOUNDS(ng)%Jstr(tile)-3 JmaxS=BOUNDS(ng)%Jend(tile)+3 ! ! Determine array lower and upper bounds in the I- and J-directions. ! LBi=BOUNDS(ng)%LBi(tile) UBi=BOUNDS(ng)%UBi(tile) LBj=BOUNDS(ng)%LBj(tile) UBj=BOUNDS(ng)%UBj(tile) ! ! Set array lower and upper bounds for MIN(I,J) directions and ! MAX(I,J) directions. ! LBij=BOUNDS(ng)%LBij UBij=BOUNDS(ng)%UBij CALL ini_hmixcoef_tile (ng, tile, model, & & LBi, UBi, LBj, UBj, & & IminS, ImaxS, JminS, JmaxS, & & GRID(ng) % grdscl, & & MIXING(ng) % diff2, & & MIXING(ng) % visc2_p, & & MIXING(ng) % visc2_r, & & diffusion2, diffusion4, & & viscosity2, viscosity4) RETURN END SUBROUTINE ini_hmixcoef ! !*********************************************************************** SUBROUTINE ini_hmixcoef_tile (ng, tile, model, & & LBi, UBi, LBj, UBj, & & IminS, ImaxS, JminS, JmaxS, & & grdscl, & & diff2, & & visc2_p, & & visc2_r, & & diffusion2, diffusion4, & & viscosity2, viscosity4) !*********************************************************************** ! USE mod_param USE mod_mixing USE mod_scalars ! USE exchange_2d_mod USE mp_exchange_mod, ONLY : mp_exchange2d USE mp_exchange_mod, ONLY : mp_exchange3d ! ! Imported variable declarations. ! integer, intent(in) :: ng, tile, model integer, intent(in) :: LBi, UBi, LBj, UBj integer, intent(in) :: IminS, ImaxS, JminS, JmaxS ! real(r8), intent(out) :: diffusion2(MT), diffusion4(MT) real(r8), intent(out) :: viscosity2, viscosity4 ! real(r8), intent(in) :: grdscl(LBi:,LBj:) real(r8), intent(inout) :: diff2(LBi:,LBj:,:) real(r8), intent(inout) :: visc2_p(LBi:,LBj:) real(r8), intent(inout) :: visc2_r(LBi:,LBj:) ! ! Local variable declarations. ! integer :: Imin, Imax, Jmin, Jmax integer :: i, j integer :: itrc real(r8) :: cff ! !----------------------------------------------------------------------- ! Set lower and upper tile bounds and staggered variables bounds for ! this horizontal domain partition. Notice that if tile=-1, it will ! set the values for the global grid. !----------------------------------------------------------------------- ! integer :: Istr, IstrB, IstrP, IstrR, IstrT, IstrM, IstrU integer :: Iend, IendB, IendP, IendR, IendT integer :: Jstr, JstrB, JstrP, JstrR, JstrT, JstrM, JstrV integer :: Jend, JendB, JendP, JendR, JendT integer :: Istrm3, Istrm2, Istrm1, IstrUm2, IstrUm1 integer :: Iendp1, Iendp2, Iendp2i, Iendp3 integer :: Jstrm3, Jstrm2, Jstrm1, JstrVm2, JstrVm1 integer :: Jendp1, Jendp2, Jendp2i, Jendp3 ! Istr =BOUNDS(ng) % Istr (tile) IstrB =BOUNDS(ng) % IstrB (tile) IstrM =BOUNDS(ng) % IstrM (tile) IstrP =BOUNDS(ng) % IstrP (tile) IstrR =BOUNDS(ng) % IstrR (tile) IstrT =BOUNDS(ng) % IstrT (tile) IstrU =BOUNDS(ng) % IstrU (tile) Iend =BOUNDS(ng) % Iend (tile) IendB =BOUNDS(ng) % IendB (tile) IendP =BOUNDS(ng) % IendP (tile) IendR =BOUNDS(ng) % IendR (tile) IendT =BOUNDS(ng) % IendT (tile) Jstr =BOUNDS(ng) % Jstr (tile) JstrB =BOUNDS(ng) % JstrB (tile) JstrM =BOUNDS(ng) % JstrM (tile) JstrP =BOUNDS(ng) % JstrP (tile) JstrR =BOUNDS(ng) % JstrR (tile) JstrT =BOUNDS(ng) % JstrT (tile) JstrV =BOUNDS(ng) % JstrV (tile) Jend =BOUNDS(ng) % Jend (tile) JendB =BOUNDS(ng) % JendB (tile) JendP =BOUNDS(ng) % JendP (tile) JendR =BOUNDS(ng) % JendR (tile) JendT =BOUNDS(ng) % JendT (tile) ! Istrm3 =BOUNDS(ng) % Istrm3 (tile) ! Istr-3 Istrm2 =BOUNDS(ng) % Istrm2 (tile) ! Istr-2 Istrm1 =BOUNDS(ng) % Istrm1 (tile) ! Istr-1 IstrUm2=BOUNDS(ng) % IstrUm2(tile) ! IstrU-2 IstrUm1=BOUNDS(ng) % IstrUm1(tile) ! IstrU-1 Iendp1 =BOUNDS(ng) % Iendp1 (tile) ! Iend+1 Iendp2 =BOUNDS(ng) % Iendp2 (tile) ! Iend+2 Iendp2i=BOUNDS(ng) % Iendp2i(tile) ! Iend+2 interior Iendp3 =BOUNDS(ng) % Iendp3 (tile) ! Iend+3 Jstrm3 =BOUNDS(ng) % Jstrm3 (tile) ! Jstr-3 Jstrm2 =BOUNDS(ng) % Jstrm2 (tile) ! Jstr-2 Jstrm1 =BOUNDS(ng) % Jstrm1 (tile) ! Jstr-1 JstrVm2=BOUNDS(ng) % JstrVm2(tile) ! JstrV-2 JstrVm1=BOUNDS(ng) % JstrVm1(tile) ! JstrV-1 Jendp1 =BOUNDS(ng) % Jendp1 (tile) ! Jend+1 Jendp2 =BOUNDS(ng) % Jendp2 (tile) ! Jend+2 Jendp2i=BOUNDS(ng) % Jendp2i(tile) ! Jend+2 interior Jendp3 =BOUNDS(ng) % Jendp3 (tile) ! Jend+3 ! !----------------------------------------------------------------------- ! Set horizontal, constant, mixing coefficient according to model flag. !----------------------------------------------------------------------- ! IF (model.eq.iNLM) THEN viscosity2=nl_visc2(ng) viscosity4=nl_visc4(ng) DO itrc=1,NT(ng) diffusion2(itrc)=nl_tnu2(itrc,ng) diffusion4(itrc)=nl_tnu4(itrc,ng) END DO ELSE IF ((model.eq.iTLM).or.(model.eq.iRPM)) THEN viscosity2=tl_visc2(ng) viscosity4=tl_visc4(ng) DO itrc=1,NT(ng) diffusion2(itrc)=tl_tnu2(itrc,ng) diffusion4(itrc)=tl_tnu4(itrc,ng) END DO ELSE IF (model.eq.iADM) THEN viscosity2=ad_visc2(ng) viscosity4=ad_visc4(ng) DO itrc=1,NT(ng) diffusion2(itrc)=ad_tnu2(itrc,ng) diffusion4(itrc)=ad_tnu4(itrc,ng) END DO END IF ! ! Update generic values. ! IF (DOMAIN(ng)%SouthWest_Test(tile)) THEN visc2(ng)=viscosity2 visc4(ng)=viscosity4 DO itrc=1,NT(ng) tnu2(itrc,ng)=diffusion2(itrc) tnu4(itrc,ng)=diffusion4(itrc) END DO END IF ! !----------------------------------------------------------------------- ! Initialize horizontal mixing arrays to constant mixing coefficient. !----------------------------------------------------------------------- ! Imin=BOUNDS(ng)%LBi(tile) Imax=BOUNDS(ng)%UBi(tile) Jmin=BOUNDS(ng)%LBj(tile) Jmax=BOUNDS(ng)%UBj(tile) ! DO j=Jmin,Jmax DO i=Imin,Imax visc2_p(i,j)=viscosity2 visc2_r(i,j)=viscosity2 END DO END DO DO itrc=1,NT(ng) DO j=Jmin,Jmax DO i=Imin,Imax diff2(i,j,itrc)=diffusion2(itrc) END DO END DO END DO ! !----------------------------------------------------------------------- ! Increase horizontal mixing coefficients in the sponge areas using ! the nondimentional factors read from application Grid NetCDF file. !----------------------------------------------------------------------- ! IF (LuvSponge(ng)) THEN DO i=IstrT,IendT DO j=JstrT,JendT visc2_r(i,j)=ABS(MIXING(ng)%visc_factor(i,j))* & & visc2_r(i,j) END DO END DO DO i=IstrP,IendT DO j=JstrP,JendT visc2_p(i,j)=0.25_r8* & & ABS(MIXING(ng)%visc_factor(i-1,j-1)+ & & MIXING(ng)%visc_factor(i ,j-1)+ & & MIXING(ng)%visc_factor(i-1,j )+ & & MIXING(ng)%visc_factor(i ,j ))* & & visc2_p(i,j) END DO END DO END IF DO itrc=1,NT(ng) IF (LtracerSponge(itrc,ng)) THEN DO j=JstrT,JendT DO i=IstrT,IendT diff2(i,j,itrc)=ABS(MIXING(ng)%diff_factor(i,j))* & & diff2(i,j,itrc) END DO END DO END IF END DO ! !----------------------------------------------------------------------- ! Exchange boundary data. !----------------------------------------------------------------------- ! IF (EWperiodic(ng).or.NSperiodic(ng)) THEN CALL exchange_r2d_tile (ng, tile, & & LBi, UBi, LBj, UBj, & & visc2_r) CALL exchange_p2d_tile (ng, tile, & & LBi, UBi, LBj, UBj, & & visc2_p) END IF IF (EWperiodic(ng).or.NSperiodic(ng)) THEN DO itrc=1,NT(ng) CALL exchange_r2d_tile (ng, tile, & & LBi, UBi, LBj, UBj, & & diff2(:,:,itrc)) END DO END IF CALL mp_exchange2d (ng, tile, model, 2, & & LBi, UBi, LBj, UBj, & & NghostPoints, & & EWperiodic(ng), NSperiodic(ng), & & visc2_r, visc2_p) CALL mp_exchange3d (ng, tile, model, 1, & & LBi, UBi, LBj, UBj, 1, NT(ng), & & NghostPoints, & & EWperiodic(ng), NSperiodic(ng), & & diff2) RETURN END SUBROUTINE ini_hmixcoef_tile END MODULE ini_hmixcoef_mod