MODULE ad_bc_bry3d_mod ! !git $Id$ !svn $Id: ad_bc_bry3d.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 package applies adjoint gradient conditions for generic 3D ! ! boundary fields. ! ! ! ! Routines: ! ! ! ! ad_bc_r3d_bry_tile Boundary conditions for field at RHO-points ! ! ad_bc_u3d_bry_tile Boundary conditions for field at U-points ! ! ad_bc_v3d_bry_tile Boundary conditions for field at V-points ! ! ! !======================================================================= ! implicit none CONTAINS ! !*********************************************************************** SUBROUTINE ad_bc_r3d_bry_tile (ng, tile, boundary, & & LBij, UBij, LBk, UBk, & & ad_A) !*********************************************************************** ! USE mod_param USE mod_scalars ! ! Imported variable declarations. ! integer, intent(in) :: ng, tile, boundary integer, intent(in) :: LBij, UBij, LBk, UBk real(r8), intent(inout) :: ad_A(LBij:,LBk:) ! ! Local variable declarations. ! integer :: k ! !----------------------------------------------------------------------- ! 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 ! !----------------------------------------------------------------------- ! Adjoint Southern and Northern edges: gradient boundary conditions. !----------------------------------------------------------------------- ! IF (boundary.eq.inorth) THEN IF (DOMAIN(ng)%NorthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Iend+1,k)=tl_A(Iend,k) !^ ad_A(Iend,k)=ad_A(Iend,k)+ad_A(Iend+1,k) ad_A(Iend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%NorthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Istr-1,k)=tl_A(Istr,k) !^ ad_A(Istr,k)=ad_A(Istr,k)+ad_A(Istr-1,k) ad_A(Istr-1,k)=0.0_r8 END DO END IF END IF IF (boundary.eq.isouth) THEN IF (DOMAIN(ng)%SouthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Iend+1,k)=tl_A(Iend,k) !^ ad_A(Iend,k)=ad_A(Iend,k)+ad_A(Iend+1,k) ad_A(Iend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%SouthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Istr-1,k)=tl_A(Istr,k) !^ ad_A(Istr,k)=ad_A(Istr,k)+ad_A(Istr-1,k) ad_A(Istr-1,k)=0.0_r8 END DO END IF END IF ! !----------------------------------------------------------------------- ! Adjoint Western and Eastern edges: gradient boundary conditions. !----------------------------------------------------------------------- ! IF (boundary.eq.ieast) THEN IF (DOMAIN(ng)%NorthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jend+1,k)=tl_A(Jend,k) !^ ad_A(Jend,k)=ad_A(Jend,k)+ad_A(Jend+1,k) ad_A(Jend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%SouthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jstr-1,k)=tl_A(Jstr,k) !^ ad_A(Jstr,k)=ad_A(Jstr,k)+ad_A(Jstr-1,k) ad_A(Jstr-1,k)=0.0_r8 END DO END IF END IF IF (boundary.eq.iwest) THEN IF (DOMAIN(ng)%NorthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jend+1,k)=tl_A(Jend,k) !^ ad_A(Jend,k)=ad_A(Jend,k)+ad_A(Jend+1,k) ad_A(Jend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%SouthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jstr-1,k)=tl_A(Jstr,k) !^ ad_A(Jstr,k)=ad_A(Jstr,k)+ad_A(Jstr-1,k) ad_A(Jstr-1,k)=0.0_r8 END DO END IF END IF RETURN END SUBROUTINE ad_bc_r3d_bry_tile ! !*********************************************************************** SUBROUTINE ad_bc_u3d_bry_tile (ng, tile, boundary, & & LBij, UBij, LBk, UBk, & & ad_A) !*********************************************************************** ! USE mod_param USE mod_scalars ! ! Imported variable declarations. ! integer, intent(in) :: ng, tile, boundary integer, intent(in) :: LBij, UBij, LBk, UBk real(r8), intent(inout) :: ad_A(LBij:,LBk:) ! ! Local variable declarations. ! integer :: k ! !----------------------------------------------------------------------- ! 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 ! !----------------------------------------------------------------------- ! Adjoint Southern and Northern edges: gradient boundary conditions. !----------------------------------------------------------------------- ! IF (boundary.eq.inorth) THEN IF (DOMAIN(ng)%NorthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Iend+1,k)=tl_A(Iend,k) !^ ad_A(Iend,k)=ad_A(Iend,k)+ad_A(Iend+1,k) ad_A(Iend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%NorthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(IstrU-1,k)=tl_A(IstrU,k) !^ ad_A(IstrU,k)=ad_A(IstrU,k)+ad_A(IstrU-1,k) ad_A(IstrU-1,k)=0.0_r8 END DO END IF END IF IF (boundary.eq.isouth) THEN IF (DOMAIN(ng)%SouthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Iend+1,k)=tl_A(Iend,k) !^ ad_A(Iend,k)=ad_A(Iend,k)+ad_A(Iend+1,k) ad_A(Iend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%SouthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(IstrU-1,k)=tl_A(IstrU,k) !^ ad_A(IstrU,k)=ad_A(IstrU,k)+ad_A(IstrU-1,k) ad_A(IstrU-1,k)=0.0_r8 END DO END IF END IF ! !----------------------------------------------------------------------- ! Adjoint Western and Eastern edges: gradient boundary conditions. !----------------------------------------------------------------------- ! IF (boundary.eq.ieast) THEN IF (DOMAIN(ng)%NorthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jend+1,k)=tl_A(Jend,k) !^ ad_A(Jend,k)=ad_A(Jend,k)+ad_A(Jend+1,k) ad_A(Jend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%SouthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jstr-1,k)=tl_A(Jstr,k) !^ ad_A(Jstr,k)=ad_A(Jstr,k)+ad_A(Jstr-1,k) ad_A(Jstr-1,k)=0.0_r8 END DO END IF END IF IF (boundary.eq.iwest) THEN IF (DOMAIN(ng)%NorthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jend+1,k)=tl_A(Jend,k) !^ ad_A(Jend,k)=ad_A(Jend,k)+ad_A(Jend+1,k) ad_A(Jend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%SouthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jstr-1,k)=tl_A(Jstr,k) !^ ad_A(Jstr,k)=ad_A(Jstr,k)+ad_A(Jstr-1,k) ad_A(Jstr-1,k)=0.0_r8 END DO END IF END IF RETURN END SUBROUTINE ad_bc_u3d_bry_tile ! !*********************************************************************** SUBROUTINE ad_bc_v3d_bry_tile (ng, tile, boundary, & & LBij, UBij, LBk, UBk, & & ad_A) !*********************************************************************** ! USE mod_param USE mod_scalars ! ! Imported variable declarations. ! integer, intent(in) :: ng, tile, boundary integer, intent(in) :: LBij, UBij, LBk, UBk real(r8), intent(inout) :: ad_A(LBij:,LBk:) ! ! Local variable declarations. ! integer :: k ! !----------------------------------------------------------------------- ! 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 ! !----------------------------------------------------------------------- ! Adjoint Southern and Northern edges: gradient boundary conditions. !----------------------------------------------------------------------- ! IF (boundary.eq.inorth) THEN IF (DOMAIN(ng)%NorthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Iend+1,k)=tl_A(Iend,k) !^ ad_A(Iend,k)=ad_A(Iend,k)+ad_A(Iend+1,k) ad_A(Iend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%NorthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Istr-1,k)=tl_A(Istr,k) !^ ad_A(Istr,k)=ad_A(Istr,k)+ad_A(Istr-1,k) ad_A(Istr-1,k)=0.0_r8 END DO END IF END IF IF (boundary.eq.isouth) THEN IF (DOMAIN(ng)%SouthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Iend+1,k)=tl_A(Iend,k) !^ ad_A(Iend,k)=ad_A(Iend,k)+ad_A(Iend+1,k) ad_A(Iend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%SouthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Istr-1,k)=tl_A(Istr,k) !^ ad_A(Istr,k)=ad_A(Istr,k)+ad_A(Istr-1,k) ad_A(Istr-1,k)=0.0_r8 END DO END IF END IF ! !----------------------------------------------------------------------- ! Adjoint Western and Eastern edges: gradient boundary conditions. !----------------------------------------------------------------------- ! IF (boundary.eq.ieast) THEN IF (DOMAIN(ng)%NorthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jend+1,k)=tl_A(Jend,k) !^ ad_A(Jend,k)=ad_A(Jend,k)+ad_A(Jend+1,k) ad_A(Jend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%SouthEast_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(JstrV-1,k)=tl_A(JstrV,k) !^ ad_A(JstrV,k)=ad_A(JstrV,k)+ad_A(JstrV-1,k) ad_A(JstrV-1,k)=0.0_r8 END DO END IF END IF IF (boundary.eq.iwest) THEN IF (DOMAIN(ng)%NorthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(Jend+1,k)=tl_A(Jend,k) !^ ad_A(Jend,k)=ad_A(Jend,k)+ad_A(Jend+1,k) ad_A(Jend+1,k)=0.0_r8 END DO END IF IF (DOMAIN(ng)%SouthWest_Corner(tile)) THEN DO k=LBk,UBk !^ tl_A(JstrV-1,k)=tl_A(JstrV,k) !^ ad_A(JstrV,k)=ad_A(JstrV,k)+ad_A(JstrV-1,k) ad_A(JstrV-1,k)=0.0_r8 END DO END IF END IF RETURN END SUBROUTINE ad_bc_v3d_bry_tile END MODULE ad_bc_bry3d_mod