Data Types
type	t_bcp

type	t_composite

type	t_ngc

type	t_ngm

type	t_refined

Functions/Subroutines
subroutine, public	allocate_nesting

subroutine, public	deallocate_nesting

subroutine, public	initialize_nesting

Variables
integer, parameter	nmflx = -6

integer, parameter	ndxdy = -5

integer, parameter	ngetd = -4

integer, parameter	nmask = -3

integer, parameter	nputd = -2

integer, parameter	n2way = -1

integer, parameter	nfsic = 1

integer, parameter	n2dic = 2

integer, parameter	n3dic = 3

integer, parameter	ntvic = 4

integer, parameter	nbstr = 5

integer, parameter	nrhst = 6

integer, parameter	nzeta = 7

integer, parameter	nzwgt = 8

integer, parameter	n2dps = 9

integer, parameter	n2dcs = 10

integer, parameter	n2dfx = 11

integer, parameter	n3duv = 12

integer, parameter	n3dtv = 13

logical, dimension(:,:), allocatable	contactregion

logical, dimension(:), allocatable	donortofiner

logical, dimension(:), allocatable	telescoping

logical	get_vweights

integer, dimension(:), allocatable	coarserdonor

integer, dimension(:), allocatable	finerdonor

integer, dimension(:), allocatable	refinesteps

integer, dimension(:), allocatable	refinestepscounter

real(r8), dimension(:), allocatable	twowayinterval

integer, dimension(:), allocatable	donor_grid

integer, dimension(:), allocatable	receiver_grid

integer, dimension(:), allocatable	rollingindex

real(dp), dimension(:,:), allocatable	rollingtime

integer, dimension(:), allocatable	i_left

integer, dimension(:), allocatable	i_right

integer, dimension(:), allocatable	j_bottom

integer, dimension(:), allocatable	j_top

integer	ncdatum

integer, dimension(:), allocatable	ncpoints

integer, dimension(:), allocatable	nstrr

integer, dimension(:), allocatable	nendr

integer, dimension(:), allocatable	nstru

integer, dimension(:), allocatable	nendu

integer, dimension(:), allocatable	nstrv

integer, dimension(:), allocatable	nendv

integer, dimension(:), allocatable	contact_region

integer, dimension(:), allocatable	on_boundary

integer, dimension(:), allocatable	idg_cp

integer, dimension(:), allocatable	jdg_cp

integer, dimension(:), allocatable	irg_cp

integer, dimension(:), allocatable	jrg_cp

integer	ncontact

type(t_ngc), dimension(:), allocatable	rcontact

type(t_ngc), dimension(:), allocatable	ucontact

type(t_ngc), dimension(:), allocatable	vcontact

type(t_bcp), dimension(:,:), allocatable	bry_contact

type(t_ngm), dimension(:), allocatable	contact_metric

type(t_composite), dimension(:), allocatable	composite

type(t_refined), dimension(:), allocatable	refined

Function/Subroutine Documentation

◆ allocate_nesting()

subroutine, public mod_nesting::allocate_nesting

Definition at line 441 of file mod_nesting.F.

!
!=======================================================================
!                                                                      !
!  This routine allocates and initializes nesting structure for 2D     !
!  state variables.                                                    !
!                                                                      !
!=======================================================================
!
      USE mod_param
      USE mod_boundary
      USE mod_scalars
!
!  Local variable declarations.
!
      integer :: LBi, UBi, LBj, UBj
      integer :: Imin, Imax, Jmin, Jmax
      integer :: CCR, cr, dg, ng, rg
      integer :: i, ibry, ic, id, ir, j, jd, jr, m, my_tile
      integer :: ispval
 
      integer, allocatable :: Ibmin(:,:), Ibmax(:,:)
      integer, allocatable :: Jbmin(:,:), Jbmax(:,:)
!
!-----------------------------------------------------------------------
!  Unpack Boundary Contact Points structure (type T_BCP).
!-----------------------------------------------------------------------
!
!  Allocate boundary connectivity (type T_BCP) structure.
!
      allocate ( bry_contact(4,ncontact) )
!
!  Allocate arrays in boundary connectivity structure.
!
      my_tile=-1                           ! for global values
      DO cr=1,ncontact
        rg=receiver_grid(cr)
        lbi=bounds(rg)%LBi(my_tile)
        ubi=bounds(rg)%UBi(my_tile)
        lbj=bounds(rg)%LBj(my_tile)
        ubj=bounds(rg)%UBj(my_tile)
        DO ibry=1,4
          SELECT CASE (ibry)
            CASE (iwest, ieast)
              allocate ( bry_contact(ibry,cr) % Ib(lbj:ubj) )
              dmem(rg)=dmem(rg)+real(ubj-lbj,r8)
 
              allocate ( bry_contact(ibry,cr) % Jb(lbj:ubj) )
              dmem(rg)=dmem(rg)+real(ubj-lbj,r8)
 
              allocate ( bry_contact(ibry,cr) % C2Bindex(lbj:ubj) )
              dmem(rg)=dmem(rg)+real(ubj-lbj,r8)
 
# ifdef NESTING_DEBUG
              allocate ( bry_contact(ibry,cr) % Mflux(lbj:ubj) )
              dmem(rg)=dmem(rg)+real(ubj-lbj,r8)
# endif
 
# ifdef SOLVE3D
              allocate ( bry_contact(ibry,cr) % Tflux(lbj:ubj,          &
     &                                                n(rg),nt(rg)) )
              dmem(rg)=dmem(rg)+real((ubj-lbj)*n(rg)*nt(rg),r8)
# endif
            CASE (isouth, inorth)
              allocate ( bry_contact(ibry,cr) % Ib(lbi:ubi) )
              dmem(rg)=dmem(rg)+real(ubi-lbi,r8)
 
              allocate ( bry_contact(ibry,cr) % Jb(lbi:ubi) )
              dmem(rg)=dmem(rg)+real(ubi-lbi,r8)
 
              allocate ( bry_contact(ibry,cr) % C2Bindex(lbi:ubi) )
              dmem(rg)=dmem(rg)+real(ubi-lbi,r8)
 
# ifdef NESTING_DEBUG
              allocate ( bry_contact(ibry,cr) % Mflux(lbi:ubi) )
              dmem(rg)=dmem(rg)+real(ubi-lbi,r8)
# endif
 
# ifdef SOLVE3D
              allocate ( bry_contact(ibry,cr) % Tflux(lbi:ubi,          &
     &                                                n(rg),nt(rg)) )
              dmem(rg)=dmem(rg)+real((ubi-lbi)*n(rg)*nt(rg),r8)
# endif
          END SELECT
        END DO
      END DO
!
!  Initialize boundary connectivity structure: Boundary indices array
!  are initialized to its special value.
!
      ispval=-999
!
      IF (.not.allocated(ibmin)) THEN
        allocate ( ibmin(4,ncontact) )
        DO ng=1,ngrids
          dmem(ng)=dmem(ng)+4.0_r8*real(ncontact,r8)
        END DO
        ibmin = -ispval
      END IF
      IF (.not.allocated(ibmax)) THEN
        allocate ( ibmax(4,ncontact) )
        DO ng=1,ngrids
          dmem(ng)=dmem(ng)+4.0_r8*real(ncontact,r8)
        END DO
        ibmax = ispval
      END IF
      IF (.not.allocated(jbmin)) THEN
        allocate ( jbmin(4,ncontact) )
        DO ng=1,ngrids
          dmem(ng)=dmem(ng)+4.0_r8*real(ncontact,r8)
        END DO
        jbmin = -ispval
      END IF
      IF (.not.allocated(jbmax)) THEN
        allocate ( jbmax(4,ncontact) )
        DO ng=1,ngrids
          dmem(ng)=dmem(ng)+4.0_r8*real(ncontact,r8)
        END DO
        jbmax = ispval
      END IF
!
      DO cr=1,ncontact
        DO ibry=1,4
          bry_contact(ibry,cr) % spv = ispval
          bry_contact(ibry,cr) % Ib = ispval
          bry_contact(ibry,cr) % Jb = ispval
          bry_contact(ibry,cr) % C2Bindex = ispval
# ifdef NESTING_DEBUG
          bry_contact(ibry,cr) % Mflux = 0.0_r8
# endif
# ifdef SOLVE3D
          bry_contact(ibry,cr) % Tflux = 0.0_r8
# endif
        END DO
      END DO
!
!  Identify contact points located on the grid boundary.  Notice that
!  the conjugate contact region (CCR) is also processed but it is not
!  yet used. Also, the CCR indices (Ib,Jb) are in refinement overwriten
!  in the m-loop below because several finer grid contact points
!  (RefineScale) are contained in the coarser grid cell. The C2Bindex
!  in this case has the value for the last processed contact point
!  with contact region "cr".
!
      DO m=1,ncdatum
        cr=contact_region(m)
        dg=donor_grid(cr)
        rg=receiver_grid(cr)
        ibry=on_boundary(m)
        DO ic=1,ncontact
          IF ((dg.eq.receiver_grid(ic)).and.                            &
     &        (rg.eq.donor_grid(ic))) THEN
            ccr=ic                            ! conjugate contact region
            EXIT
          END IF
        END DO
        IF ((ibry.eq.iwest ).or.(ibry.eq.ieast )) THEN
          ir=irg_cp(m)
          jr=jrg_cp(m)
          ibmin(ibry,cr )=min(ir,ibmin(ibry,cr ))
          ibmax(ibry,cr )=max(ir,ibmax(ibry,cr ))
          jbmin(ibry,cr )=min(jr,jbmin(ibry,cr ))
          jbmax(ibry,cr )=max(jr,jbmax(ibry,cr ))
          bry_contact(ibry,cr ) % Ib(jr) = ir
          bry_contact(ibry,cr ) % Jb(jr) = jr
          bry_contact(ibry,cr ) % C2Bindex(jr) = m-nstru(cr)+1
!
          id=idg_cp(m)
          jd=jdg_cp(m)
          ibmin(ibry,ccr)=min(id,ibmin(ibry,ccr))
          ibmax(ibry,ccr)=max(id,ibmax(ibry,ccr))
          jbmin(ibry,ccr)=min(jd,jbmin(ibry,ccr))
          jbmax(ibry,ccr)=max(jd,jbmax(ibry,ccr))
          bry_contact(ibry,ccr) % Ib(jd) = id
          bry_contact(ibry,ccr) % Jb(jd) = jd
          bry_contact(ibry,ccr) % C2Bindex(jd) = m-nstru(cr)+1  ! same
        ELSE IF ((ibry.eq.isouth).or.(ibry.eq.inorth)) THEN
          ir=irg_cp(m)
          jr=jrg_cp(m)
          ibmin(ibry,cr )=min(ir,ibmin(ibry,cr))
          ibmax(ibry,cr )=max(ir,ibmax(ibry,cr))
          jbmin(ibry,cr )=min(jr,jbmin(ibry,cr))
          jbmax(ibry,cr )=max(jr,jbmax(ibry,cr))
          bry_contact(ibry,cr ) % Ib(ir) = ir
          bry_contact(ibry,cr ) % Jb(ir) = jr
          bry_contact(ibry,cr ) % C2Bindex(ir) = m-nstrv(cr)+1
!
          id=idg_cp(m)
          jd=jdg_cp(m)
          ibmin(ibry,ccr)=min(id,ibmin(ibry,ccr))
          ibmax(ibry,ccr)=max(id,ibmax(ibry,ccr))
          jbmin(ibry,ccr)=min(jd,jbmin(ibry,ccr))
          jbmax(ibry,ccr)=max(jd,jbmax(ibry,ccr))
          bry_contact(ibry,ccr) % Ib(id) = id
          bry_contact(ibry,ccr) % Jb(id) = jd
          bry_contact(ibry,ccr) % C2Bindex(id) = m-nstrv(cr)+1  ! same
        END IF
      END DO
!
!  Set minimum and maximum indices to process at each boundary.
!
      DO cr=1,ncontact
        DO ibry=1,4
          IF (abs(ibmin(ibry,cr)).eq.abs(ispval)) THEN
            bry_contact(ibry,cr) % Ibmin = ispval
          ELSE
            bry_contact(ibry,cr) % Ibmin = ibmin(ibry,cr)
          END IF
 
          IF (abs(ibmax(ibry,cr)).eq.abs(ispval)) THEN
            bry_contact(ibry,cr) % Ibmax = ispval
          ELSE
            bry_contact(ibry,cr) % Ibmax = ibmax(ibry,cr)
          END IF
 
          IF (abs(jbmin(ibry,cr)).eq.abs(ispval)) THEN
            bry_contact(ibry,cr) % Jbmin = ispval
          ELSE
            bry_contact(ibry,cr) % Jbmin = jbmin(ibry,cr)
          END IF
 
          IF (abs(jbmax(ibry,cr)).eq.abs(ispval)) THEN
            bry_contact(ibry,cr) % Jbmax = ispval
          ELSE
            bry_contact(ibry,cr) % Jbmax = jbmax(ibry,cr)
          END IF
        END DO
      END DO
!
!-----------------------------------------------------------------------
!  Deactivate boundary condition switches if contact point lay on the
!  physical nested grid boundary.
!-----------------------------------------------------------------------
!
      DO cr=1,ncontact
        rg=receiver_grid(cr)
        IF (refinedgrid(rg)) THEN
          IF (refinescale(rg).gt.0) THEN
            lbc_apply(rg) % west  = .false.    ! This is a refinement
            lbc_apply(rg) % south = .false.    ! grid, so we need to
            lbc_apply(rg) % east  = .false.    ! avoid applying lateral
            lbc_apply(rg) % north = .false.    ! boundary conditions
          END IF
        ELSE
          DO ibry=1,4
            imin=bry_contact(ibry,cr) % Ibmin  ! Deactivate full or
            imax=bry_contact(ibry,cr) % Ibmax  ! partial lateral
            jmin=bry_contact(ibry,cr) % Jbmin  ! boundary conditions
            jmax=bry_contact(ibry,cr) % Jbmax
            SELECT CASE (ibry)
              CASE (iwest)
                IF ((jmin.ne.ispval).and.(jmax.ne.ispval)) THEN
                  DO j=jmin,jmax
                    lbc_apply(rg) % west (j) = .false.
                  END DO
                END IF
              CASE (isouth)
                IF ((imin.ne.ispval).and.(imax.ne.ispval)) THEN
                  DO i=imin,imax
                    lbc_apply(rg) % south(i) = .false.
                  END DO
                END IF
              CASE (ieast)
                IF ((jmin.ne.ispval).and.(jmax.ne.ispval)) THEN
                  DO j=jmin,jmax
                    lbc_apply(rg) % east (j) = .false.
                  END DO
                END IF
              CASE (inorth)
                IF ((imin.ne.ispval).and.(imax.ne.ispval)) THEN
                  DO i=imin,imax
                    lbc_apply(rg) % north(i) = .false.
                  END DO
                END IF
            END SELECT
          END DO
        END IF
      END DO
!
      RETURN

References mod_param::bounds, bry_contact, contact_region, mod_param::dmem, donor_grid, idg_cp, mod_scalars::ieast, mod_scalars::inorth, irg_cp, mod_scalars::isouth, mod_scalars::iwest, jdg_cp, jrg_cp, mod_boundary::lbc_apply, mod_param::n, ncdatum, ncontact, mod_param::ngrids, nstru, nstrv, mod_param::nt, on_boundary, mod_kinds::r8, receiver_grid, mod_scalars::refinedgrid, and mod_scalars::refinescale.

Referenced by mod_arrays::roms_allocate_arrays().

Here is the caller graph for this function:

◆ deallocate_nesting()

subroutine, public mod_nesting::deallocate_nesting

Definition at line 723 of file mod_nesting.F.

!
!=======================================================================
!                                                                      !
!  This routine allocates and initializes nesting structure for 2D     !
!  state variables.                                                    !
!                                                                      !
!=======================================================================
 
# ifdef SUBOBJECT_DEALLOCATION
!
      USE destroy_mod, ONLY : destroy
# endif
!
!  Local variable declarations.
!
      integer ::  cr, ibry
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", deallocate_nesting"
 
# ifdef SUBOBJECT_DEALLOCATION
!
!-----------------------------------------------------------------------
!  Deallocate each variable in the derived-type T_BCP boundary
!  connectivity structure separately.
!-----------------------------------------------------------------------
!
      DO cr=1,ncontact
        DO ibry=1,4
          IF (.not.destroy(ng, bry_contact(ibry,cr)%Ib, myfile,         &
     &                     __line__, 'BRY_CONTACT(ibry,cr)%Ib')) RETURN
 
          IF (.not.destroy(ng, bry_contact(ibry,cr)%Jb, myfile,         &
     &                     __line__, 'BRY_CONTACT(ibry,cr)%Jb')) RETURN
 
          IF (.not.destroy(ng, bry_contact(ibry,cr)%C2Bindex, myfile,   &
     &                __line__, 'BRY_CONTACT(ibry,cr)%C2Bindex')) RETURN
 
#  ifdef NESTING_DEBUG
          IF (.not.destroy(ng, bry_contact(ibry,cr)%Mflux, myfile,      &
     &                __line__, 'BRY_CONTACT(ibry,cr)%Mflux')) RETURN
#  endif
 
#  ifdef SOLVE3D
          IF (.not.destroy(ng, bry_contact(ibry,cr)%Tflux, myfile,      &
     &                __line__, 'BRY_CONTACT(ibry,cr)%Tflux')) RETURN
#  endif
        END DO
      END DO
!
!-----------------------------------------------------------------------
!  Deallocate each variable in the derived-type T_NGC grid connectivity
!  structure separately.
!-----------------------------------------------------------------------
!
      DO cr=1,ncontact
        IF (.not.destroy(ng, rcontact(cr)%Irg, myfile,                  &
     &                   __line__, 'Rcontact(cr)%Irg')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%Irg, myfile,                  &
     &                   __line__, 'Ucontact(cr)%Irg')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%Irg, myfile,                  &
     &                   __line__, 'Vcontact(cr)%Irg')) RETURN
!
        IF (.not.destroy(ng, rcontact(cr)%Jrg, myfile,                  &
     &                   __line__, 'Rcontact(cr)%Jrg')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%Jrg, myfile,                  &
     &                   __line__, 'Ucontact(cr)%Jrg')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%Jrg, myfile,                  &
     &                   __line__, 'Vcontact(cr)%Jrg')) RETURN
!
        IF (.not.destroy(ng, rcontact(cr)%Idg, myfile,                  &
     &                   __line__, 'Rcontact(cr)%Idg')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%Idg, myfile,                  &
     &                   __line__, 'Ucontact(cr)%Idg')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%Idg, myfile,                  &
     &                   __line__, 'Vcontact(cr)%Idg')) RETURN
!
        IF (.not.destroy(ng, rcontact(cr)%Jdg, myfile,                  &
     &                   __line__, 'Rcontact(cr)%Jdg')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%Jdg, myfile,                  &
     &                   __line__, 'Ucontact(cr)%Jdg')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%Jdg, myfile,                  &
     &                   __line__, 'Vcontact(cr)%Jdg')) RETURN
 
#  ifdef SOLVE3D
!
        IF (.not.destroy(ng, rcontact(cr)%Kdg, myfile,                  &
     &                   __line__, 'Rcontact(cr)%Kdg')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%Kdg, myfile,                  &
     &                   __line__, 'Ucontact(cr)%Kdg')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%Kdg, myfile,                  &
     &                   __line__, 'Vcontact(cr)%Kdg')) RETURN
#  endif
!
        IF (.not.destroy(ng, rcontact(cr)%Lweight, myfile,              &
     &                   __line__, 'Rcontact(cr)%Lweight')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%Lweight, myfile,              &
     &                   __line__, 'Ucontact(cr)%Lweight')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%Lweight, myfile,              &
     &                   __line__, 'Vcontact(cr)%Lweight')) RETURN
!
#  ifdef WET_DRY
        IF (.not.destroy(ng, rcontact(cr)%LweightUnmasked, myfile,      &
     &              __line__, 'Rcontact(cr)%LweightUnmasked')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%LweightUnmasked, myfile,      &
     &              __line__, 'Ucontact(cr)%LweightUnmasked')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%LweightUnmasked, myfile,      &
     &              __line__, 'Vcontact(cr)%LweightUnmasked')) RETURN
#  endif
 
#  ifdef QUADRATIC_WEIGHTS
!
        IF (.not.destroy(ng, rcontact(cr)%Qweight, myfile,              &
     &                   __line__, 'Rcontact(cr)%Qweight')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%Qweight, myfile,              &
     &                   __line__, 'Ucontact(cr)%Qweight')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%Qweight, myfile,              &
     &                   __line__, 'Vcontact(cr)%Qweight')) RETURN
 
#   ifdef WET_DRY
!
        IF (.not.destroy(ng, rcontact(cr)%QweightUnmasked, myfile,      &
     &              __line__, 'Rcontact(cr)%QweightUnmasked')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%QweightUnmasked, myfile,      &
     &              __line__, 'Ucontact(cr)%QweightUnmasked')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%QweightUnmasked, myfile,      &
     &              __line__, 'Vcontact(cr)%QweightUnmasked')) RETURN
#   endif
#  endif
 
#  ifdef SOLVE3D
!
        IF (.not.destroy(ng, rcontact(cr)%Vweight, myfile,              &
     &                   __line__, 'Rcontact(cr)%Vweight')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%Vweight, myfile,              &
     &                   __line__, 'Ucontact(cr)%Vweight')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%Vweight, myfile,              &
     &                   __line__, 'Vcontact(cr)%Vweight')) RETURN
 
#   if defined TANGENT || defined TL_IOMS
!
        IF (.not.destroy(ng, rcontact(cr)%tl_Vweight, myfile,           &
     &                   __line__, 'Rcontact(cr)%tl_Vweight')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%tl_Vweight, myfile,           &
     &                   __line__, 'Ucontact(cr)%tl_Vweight')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%tl_Vweight, myfile,           &
     &                   __line__, 'Vcontact(cr)%tl_Vweight')) RETURN
#   endif
 
#   ifdef ADJOINT
!
        IF (.not.destroy(ng, rcontact(cr)%ad_Vweight, myfile,           &
     &                   __line__, 'Rcontact(cr)%ad_Vweight')) RETURN
        IF (.not.destroy(ng, ucontact(cr)%ad_Vweight, myfile,           &
     &                   __line__, 'Ucontact(cr)%ad_Vweight')) RETURN
        IF (.not.destroy(ng, vcontact(cr)%ad_Vweight, myfile,           &
     &                   __line__, 'Vcontact(cr)%ad_Vweight')) RETURN
#   endif
#  endif
      END DO
!
!-----------------------------------------------------------------------
!  Deallocate each variable in the derived-type T_NGC contact region
!  metrics structure separately.
!-----------------------------------------------------------------------
!
      DO cr=1,ncontact
        IF (.not.destroy(ng, contact_metric(cr)%angler, myfile,         &
     &                   __line__, 'CONTACT_METRIC(cr)%angler')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%dndx, myfile,           &
     &                   __line__, 'CONTACT_METRIC(cr)%dndx')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%dmde, myfile,           &
     &                   __line__, 'CONTACT_METRIC(cr)%dmde')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%f, myfile,              &
     &                   __line__, 'CONTACT_METRIC(cr)%f')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%h, myfile,              &
     &                   __line__, 'CONTACT_METRIC(cr)%h')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%rmask, myfile,          &
     &                   __line__, 'CONTACT_METRIC(cr)%rmask')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%umask, myfile,          &
     &                   __line__, 'CONTACT_METRIC(cr)%umask')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%vmask, myfile,          &
     &                   __line__, 'CONTACT_METRIC(cr)%vmask')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%pm, myfile,             &
     &                   __line__, 'CONTACT_METRIC(cr)%pm')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%pn, myfile,             &
     &                   __line__, 'CONTACT_METRIC(cr)%pn')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%Xr, myfile,             &
     &                   __line__, 'CONTACT_METRIC(cr)%Xr')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%Yr, myfile,             &
     &                   __line__, 'CONTACT_METRIC(cr)%Yr')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%Xu, myfile,             &
     &                   __line__, 'CONTACT_METRIC(cr)%Xu')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%Yu, myfile,             &
     &                   __line__, 'CONTACT_METRIC(cr)%Yu')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%Xv, myfile,             &
     &                   __line__, 'CONTACT_METRIC(cr)%Xv')) RETURN
 
        IF (.not.destroy(ng, contact_metric(cr)%Yv, myfile,             &
     &                   __line__, 'CONTACT_METRIC(cr)%Yv')) RETURN
      END DO
!
!-----------------------------------------------------------------------
!  Deallocate each variable in the derived-type T_COMPOSITE for
!  composite grids contact region structure separately.
!-----------------------------------------------------------------------
!
      DO cr=1,ncontact
        IF (.not.destroy(ng, composite(cr)%bustr, myfile,               &
     &                   __line__, 'COMPOSITE(cr)%bustr')) RETURN
        IF (.not.destroy(ng, composite(cr)%bvstr, myfile,               &
     &                   __line__, 'COMPOSITE(cr)%bvstr')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%ubar, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%ubar')) RETURN
        IF (.not.destroy(ng, composite(cr)%vbar, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%vbar')) RETURN
        IF (.not.destroy(ng, composite(cr)%zeta, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%zeta')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%rzeta, myfile,               &
     &                   __line__, 'COMPOSITE(cr)%rzeta')) RETURN
 
#   if defined TANGENT || defined TL_IOMS
        IF (.not.destroy(ng, composite(cr)%tl_bustr, myfile,            &
     &                   __line__, 'COMPOSITE(cr)%tl_bustr')) RETURN
        IF (.not.destroy(ng, composite(cr)%tl_bvstr, myfile,            &
     &                   __line__, 'COMPOSITE(cr)%tl_bvstr')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%tl_ubar, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%tl_ubar')) RETURN
        IF (.not.destroy(ng, composite(cr)%tl_vbar, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%tl_vbar')) RETURN
        IF (.not.destroy(ng, composite(cr)%tl_zeta, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%tl_zeta')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%tl_rzeta, myfile,            &
     &                   __line__, 'COMPOSITE(cr)%tl_rzeta')) RETURN
#   endif
 
#   ifdef ADJOINT
        IF (.not.destroy(ng, composite(cr)%ad_bustr, myfile,            &
     &                   __line__, 'COMPOSITE(cr)%ad_bustr')) RETURN
        IF (.not.destroy(ng, composite(cr)%ad_bvstr, myfile,            &
     &                   __line__, 'COMPOSITE(cr)%ad_bvstr')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%ad_ubar, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%ad_ubar')) RETURN
        IF (.not.destroy(ng, composite(cr)%ad_vbar, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%ad_vbar')) RETURN
        IF (.not.destroy(ng, composite(cr)%ad_zeta, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%ad_zeta')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%ad_rzeta, myfile,            &
     &                   __line__, 'COMPOSITE(cr)%ad_rzeta')) RETURN
#   endif
 
#  ifdef SOLVE3D
        IF (.not.destroy(ng, composite(cr)%DU_avg1, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%DU_avg1')) RETURN
        IF (.not.destroy(ng, composite(cr)%DV_avg1, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%DV_avg1')) RETURN
        IF (.not.destroy(ng, composite(cr)%Zt_avg1, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%Zt_avg1')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%u, myfile,                   &
     &                   __line__, 'COMPOSITE(cr)%u')) RETURN
        IF (.not.destroy(ng, composite(cr)%v, myfile,                   &
     &                   __line__, 'COMPOSITE(cr)%v')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%Huon, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%Huon')) RETURN
        IF (.not.destroy(ng, composite(cr)%Hvom, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%Hvom')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%t, myfile,                   &
     &                   __line__, 'COMPOSITE(cr)%t')) RETURN
 
#   if defined TANGENT || defined TL_IOMS
        IF (.not.destroy(ng, composite(cr)%tl_DU_avg1, myfile,          &
     &                   __line__, 'COMPOSITE(cr)%tl_DU_avg1')) RETURN
        IF (.not.destroy(ng, composite(cr)%tl_DV_avg1, myfile,          &
     &                   __line__, 'COMPOSITE(cr)%tl_DV_avg1')) RETURN
        IF (.not.destroy(ng, composite(cr)%tl_Zt_avg1, myfile,          &
     &                   __line__, 'COMPOSITE(cr)%tl_Zt_avg1')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%tl_u, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%tl_u')) RETURN
        IF (.not.destroy(ng, composite(cr)%tl_v, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%tl_v')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%tl_Huon, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%tl_Huon')) RETURN
        IF (.not.destroy(ng, composite(cr)%tl_Hvom, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%tl_Hvom')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%tl_t, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%tl_t')) RETURN
#   endif
 
#   ifdef ADJOINT
        IF (.not.destroy(ng, composite(cr)%ad_DU_avg1, myfile,          &
     &                   __line__, 'COMPOSITE(cr)%ad_DU_avg1')) RETURN
        IF (.not.destroy(ng, composite(cr)%ad_DV_avg1, myfile,          &
     &                   __line__, 'COMPOSITE(cr)%ad_DV_avg1')) RETURN
        IF (.not.destroy(ng, composite(cr)%ad_Zt_avg1, myfile,          &
     &                   __line__, 'COMPOSITE(cr)%ad_Zt_avg1')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%ad_u, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%ad_u')) RETURN
        IF (.not.destroy(ng, composite(cr)%ad_v, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%ad_v')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%ad_Huon, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%ad_Huon')) RETURN
        IF (.not.destroy(ng, composite(cr)%ad_Hvom, myfile,             &
     &                   __line__, 'COMPOSITE(cr)%ad_Hvom')) RETURN
 
        IF (.not.destroy(ng, composite(cr)%ad_t, myfile,                &
     &                   __line__, 'COMPOSITE(cr)%ad_t')) RETURN
#   endif
#  endif
      END DO
!
!-----------------------------------------------------------------------
!  Deallocate each variable in the derived-type T_REFINED for
!  refinement grids contact region structure separately.
!-----------------------------------------------------------------------
!
      DO cr=1,ncontact
        IF (.not.destroy(ng, refined(cr)%ubar, myfile,                  &
     &                   __line__, 'REFINED(cr)%ubar')) RETURN
        IF (.not.destroy(ng, refined(cr)%vbar, myfile,                  &
     &                   __line__, 'REFINED(cr)%vbar')) RETURN
        IF (.not.destroy(ng, refined(cr)%zeta, myfile,                  &
     &                   __line__, 'REFINED(cr)%zeta')) RETURN
 
        IF (.not.destroy(ng, refined(cr)%U2d_flux, myfile,              &
     &                   __line__, 'REFINED(cr)%U2d_flux')) RETURN
        IF (.not.destroy(ng, refined(cr)%V2d_flux, myfile,               &
     &                   __line__, 'REFINED(cr)%V2d_flux')) RETURN
 
        IF (.not.destroy(ng, refined(cr)%on_u, myfile,                  &
     &                   __line__, 'REFINED(cr)%on_u')) RETURN
        IF (.not.destroy(ng, refined(cr)%om_v, myfile,                  &
     &                   __line__, 'REFINED(cr)%om_v')) RETURN
 
#  if defined TANGENT || defined TL_IOMS
        IF (.not.destroy(ng, refined(cr)%tl_ubar, myfile,               &
     &                   __line__, 'REFINED(cr)%tl_ubar')) RETURN
        IF (.not.destroy(ng, refined(cr)%tl_vbar, myfile,               &
     &                   __line__, 'REFINED(cr)%tl_vbar')) RETURN
        IF (.not.destroy(ng, refined(cr)%tl_zeta, myfile,               &
     &                   __line__, 'REFINED(cr)%tl_zeta')) RETURN
 
        IF (.not.destroy(ng, refined(cr)%tl_U2d_flux, myfile,           &
     &                   __line__, 'REFINED(cr)%tl_U2d_flux')) RETURN
        IF (.not.destroy(ng, refined(cr)%tl_V2d_flux, myfile,           &
     &                   __line__, 'REFINED(cr)%tl_V2d_flux')) RETURN
#  endif
 
#  ifdef ADJOINT
        IF (.not.destroy(ng, refined(cr)%ad_ubar, myfile,               &
     &                   __line__, 'REFINED(cr)%ad_ubar')) RETURN
        IF (.not.destroy(ng, refined(cr)%ad_vbar, myfile,               &
     &                   __line__, 'REFINED(cr)%ad_vbar')) RETURN
        IF (.not.destroy(ng, refined(cr)%ad_zeta, myfile,               &
     &                   __line__, 'REFINED(cr)%ad_zeta')) RETURN
 
        IF (.not.destroy(ng, refined(cr)%ad_U2d_flux, myfile,           &
     &                   __line__, 'REFINED(cr)%ad_U2d_flux')) RETURN
        IF (.not.destroy(ng, refined(cr)%ad_V2d_flux, myfile,           &
     &                   __line__, 'REFINED(cr)%ad_V2d_flux')) RETURN
#  endif
 
#  ifdef SOLVE3D
        IF (.not.destroy(ng, refined(cr)%u, myfile,                     &
     &                   __line__, 'REFINED(cr)%u')) RETURN
        IF (.not.destroy(ng, refined(cr)%v, myfile,                     &
     &                   __line__, 'REFINED(cr)%v')) RETURN
 
        IF (.not.destroy(ng, refined(cr)%t, myfile,                     &
     &                   __line__, 'REFINED(cr)%t')) RETURN
 
#   if defined TANGENT || defined TL_IOMS
        IF (.not.destroy(ng, refined(cr)%tl_u, myfile,                  &
     &                   __line__, 'REFINED(cr)%tl_u')) RETURN
        IF (.not.destroy(ng, refined(cr)%tl_v, myfile,                  &
     &                   __line__, 'REFINED(cr)%tl_v')) RETURN
 
        IF (.not.destroy(ng, refined(cr)%tl_t, myfile,                  &
     &                   __line__, 'REFINED(cr)%tl_t')) RETURN
#   endif
 
#   ifdef ADJOINT
        IF (.not.destroy(ng, refined(cr)%ad_u, myfile,                  &
     &                   __line__, 'REFINED(cr)%ad_u')) RETURN
        IF (.not.destroy(ng, refined(cr)%ad_v, myfile,                  &
     &                   __line__, 'REFINED(cr)%ad_v')) RETURN
 
        IF (.not.destroy(ng, refined(cr)%ad_t, myfile,                  &
     &                   __line__, 'REFINED(cr)%ad_t')) RETURN
#   endif
#  endif
      END DO
# endif
!
!-----------------------------------------------------------------------
!  Deallocate derived-type structures:
!-----------------------------------------------------------------------
!
!  Boundary connectivity.
 
      IF (allocated(bry_contact)) deallocate ( bry_contact )
!
!  Grid connectivity.
!
      IF (allocated(rcontact)) deallocate ( rcontact )
      IF (allocated(ucontact)) deallocate ( ucontact )
      IF (allocated(vcontact)) deallocate ( vcontact )
!
!  Contact region metrics.
!
      IF (allocated(contact_metric)) deallocate ( contact_metric )
!
!  Composite grid contact regions.
!
      IF (allocated(composite)) deallocate ( composite )
!
!  Deallocate refinement grids contact regions structure.
!
      IF (allocated(refined)) deallocate ( refined )
!
!-----------------------------------------------------------------------
!  Deallocate other variables in module.
!-----------------------------------------------------------------------
!
      IF (allocated(contactregion)) THEN
        deallocate ( coarserdonor )
      END IF
 
      IF (allocated(finerdonor)) THEN
        deallocate ( finerdonor )
      END IF
 
      IF (allocated(donortofiner)) THEN
        deallocate ( donortofiner )
      END IF
 
      IF (allocated(refinesteps)) THEN
        deallocate ( refinesteps )
      END IF
 
      IF (allocated(refinestepscounter)) THEN
        deallocate ( refinestepscounter )
      END IF
 
      IF (allocated(twowayinterval)) THEN
        deallocate ( twowayinterval )
      END IF
 
      IF (allocated(telescoping)) THEN
        deallocate ( telescoping )
      END IF
 
      IF (allocated(rollingindex)) THEN
        deallocate ( rollingindex )
      END IF
 
      IF (allocated(rollingtime)) THEN
        deallocate ( rollingtime )
      END IF
!
      RETURN

References bry_contact, coarserdonor, composite, contact_metric, contactregion, donortofiner, finerdonor, ncontact, rcontact, refined, refinesteps, refinestepscounter, rollingindex, rollingtime, telescoping, twowayinterval, ucontact, and vcontact.

Referenced by mod_arrays::roms_deallocate_arrays().

Here is the caller graph for this function:

◆ initialize_nesting()

subroutine, public mod_nesting::initialize_nesting

Definition at line 1214 of file mod_nesting.F.

!
!=======================================================================
!                                                                      !
!  This routine initializes time varying nesting structures.           !
!                                                                      !
!=======================================================================
!
      USE mod_param
      USE mod_scalars
!
!  Local variable declarations.
!
      integer :: cr
 
      real(r8), parameter :: IniVal = 0.0_r8
!
!-----------------------------------------------------------------------
!  Initialize time-varying contact regions structures.  They are used
!  to process values from contact regions to global kernel arrays and
!  vice versa.
!-----------------------------------------------------------------------
!
!  Composite grids contact region structure.
!
      IF (any(compositegrid)) THEN
        DO cr=1,ncontact
          composite(cr) % bustr = inival
          composite(cr) % bvstr = inival
 
          composite(cr) % ubar = inival
          composite(cr) % vbar = inival
          composite(cr) % zeta = inival
 
          composite(cr) % rzeta = inival
 
# ifdef SOLVE3D
          composite(cr) % DU_avg1 = inival
          composite(cr) % DV_avg1 = inival
          composite(cr) % Zt_avg1 = inival
 
          composite(cr) % u = inival
          composite(cr) % v = inival
 
          composite(cr) % Huon = inival
          composite(cr) % Hvom = inival
 
          composite(cr) % t = inival
# endif
        END DO
      END IF
!
!  Refinement grids contact region structure.
!
      IF (any(refinedgrid(:))) THEN
        DO cr=1,ncontact
          refined(cr) % ubar = inival
          refined(cr) % vbar = inival
          refined(cr) % zeta = inival
 
          refined(cr) % U2d_flux = inival
          refined(cr) % V2d_flux = inival
 
          refined(cr) % on_u = inival
          refined(cr) % om_v = inival
 
# ifdef SOLVE3D
          refined(cr) % u = inival
          refined(cr) % v = inival
 
          refined(cr) % t = inival
# endif
        END DO
      END IF
 
      RETURN

References composite, mod_scalars::compositegrid, ncontact, refined, and mod_scalars::refinedgrid.

Referenced by mod_arrays::roms_initialize_arrays().

Here is the caller graph for this function:

Variable Documentation

◆ bry_contact

type (t_bcp), dimension(:,:), allocatable mod_nesting::bry_contact

Definition at line 335 of file mod_nesting.F.

335 TYPE (T_BCP), allocatable :: BRY_CONTACT(:,:) ! [4,Ncontact]

Referenced by ad_nesting_mod::ad_check_massflux(), ad_nesting_mod::ad_correct_tracer_tile(), ad_nesting_mod::ad_put_refine2d(), allocate_nesting(), nesting_mod::check_massflux(), nesting_mod::correct_tracer_tile(), deallocate_nesting(), nesting_mod::put_refine2d(), step3d_t_mod::step3d_t_tile(), tl_nesting_mod::tl_check_massflux(), tl_nesting_mod::tl_correct_tracer_tile(), tl_nesting_mod::tl_put_refine2d(), u2dbc_mod::u2dbc_tile(), and v2dbc_mod::v2dbc_tile().

◆ coarserdonor

integer, dimension(:), allocatable mod_nesting::coarserdonor

Definition at line 138 of file mod_nesting.F.

138 integer, allocatable :: CoarserDonor(:) ! [Ngrids]

Referenced by ad_nesting_mod::ad_get_refine(), ad_nesting_mod::ad_nesting(), nesting_mod::check_massflux(), deallocate_nesting(), nesting_mod::get_refine(), metrics_mod::metrics_tile(), nesting_mod::nesting(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_get_refine(), and tl_nesting_mod::tl_nesting().

◆ composite

type (t_composite), dimension(:), allocatable mod_nesting::composite

Definition at line 409 of file mod_nesting.F.

409 TYPE (T_COMPOSITE), allocatable :: COMPOSITE(:) ! [Ncontact]

Referenced by ad_nesting_mod::ad_get_composite(), ad_nesting_mod::ad_put_composite(), deallocate_nesting(), nesting_mod::get_composite(), initialize_nesting(), nesting_mod::put_composite(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_get_composite(), and tl_nesting_mod::tl_put_composite().

◆ contact_metric

type (t_ngm), dimension(:), allocatable mod_nesting::contact_metric

Definition at line 374 of file mod_nesting.F.

374 TYPE (T_NGM), allocatable :: CONTACT_METRIC(:) ! [Ncontact]

Referenced by deallocate_nesting(), get_grid_mod::get_grid_nf90(), get_grid_mod::get_grid_pio(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ contact_region

integer, dimension(:), allocatable mod_nesting::contact_region

Definition at line 209 of file mod_nesting.F.

209 integer, allocatable :: contact_region(:) ! [NCdatum]

Referenced by allocate_nesting(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ contactregion

logical, dimension(:,:), allocatable mod_nesting::contactregion

Definition at line 105 of file mod_nesting.F.

105 logical, allocatable :: ContactRegion(:,:) ! [4,Ngrids]

Referenced by deallocate_nesting(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ donor_grid

integer, dimension(:), allocatable mod_nesting::donor_grid

Definition at line 172 of file mod_nesting.F.

172 integer, allocatable :: donor_grid(:) ! [Ncontact]

Referenced by ad_nesting_mod::ad_correct_tracer_tile(), allocate_nesting(), nesting_mod::correct_tracer_tile(), metrics_mod::metrics_tile(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), and tl_nesting_mod::tl_correct_tracer_tile().

◆ donortofiner

logical, dimension(:), allocatable mod_nesting::donortofiner

Definition at line 111 of file mod_nesting.F.

111 logical, allocatable :: DonorToFiner(:) ! {Ngrids]

Referenced by ad_main3d(), deallocate_nesting(), main3d(), metrics_mod::metrics_tile(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), and tl_main3d().

◆ finerdonor

integer, dimension(:), allocatable mod_nesting::finerdonor

Definition at line 145 of file mod_nesting.F.

145 integer, allocatable :: FinerDonor(:) ! [Ngrids]

Referenced by nesting_mod::check_massflux(), deallocate_nesting(), metrics_mod::metrics_tile(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ get_vweights

logical mod_nesting::get_vweights

Definition at line 130 of file mod_nesting.F.

130 logical :: get_Vweights

Referenced by ad_nesting_mod::ad_nesting(), nesting_mod::nesting(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), and tl_nesting_mod::tl_nesting().

◆ i_left

integer, dimension(:), allocatable mod_nesting::i_left

Definition at line 193 of file mod_nesting.F.

193 integer, allocatable :: I_left(:) ! [Ngrids]

Referenced by ad_nesting_mod::ad_bry_fluxes(), ad_nesting_mod::ad_check_massflux(), ad_nesting_mod::ad_correct_tracer_tile(), ad_nesting_mod::ad_get_persisted2d(), nesting_mod::bry_fluxes(), nesting_mod::check_massflux(), nesting_mod::correct_tracer_tile(), nesting_mod::fine2coarse2d(), nesting_mod::fine2coarse3d(), nesting_mod::get_persisted2d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_check_massflux(), and tl_nesting_mod::tl_correct_tracer_tile().

◆ i_right

integer, dimension(:), allocatable mod_nesting::i_right

Definition at line 194 of file mod_nesting.F.

194 integer, allocatable :: I_right(:) ! [Ngrids]

Referenced by ad_nesting_mod::ad_bry_fluxes(), ad_nesting_mod::ad_check_massflux(), ad_nesting_mod::ad_correct_tracer_tile(), nesting_mod::bry_fluxes(), nesting_mod::check_massflux(), nesting_mod::correct_tracer_tile(), nesting_mod::fine2coarse2d(), nesting_mod::fine2coarse3d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_check_massflux(), and tl_nesting_mod::tl_correct_tracer_tile().

◆ idg_cp

integer, dimension(:), allocatable mod_nesting::idg_cp

Definition at line 211 of file mod_nesting.F.

211 integer, allocatable :: Idg_cp(:) ! [NCdatum]

Referenced by allocate_nesting(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ irg_cp

integer, dimension(:), allocatable mod_nesting::irg_cp

Definition at line 213 of file mod_nesting.F.

213 integer, allocatable :: Irg_cp(:) ! [NCdatum]

Referenced by allocate_nesting(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ j_bottom

integer, dimension(:), allocatable mod_nesting::j_bottom

Definition at line 195 of file mod_nesting.F.

195 integer, allocatable :: J_bottom(:) ! [Ngrids]

Referenced by ad_nesting_mod::ad_bry_fluxes(), ad_nesting_mod::ad_check_massflux(), ad_nesting_mod::ad_correct_tracer_tile(), ad_nesting_mod::ad_get_persisted2d(), nesting_mod::bry_fluxes(), nesting_mod::check_massflux(), nesting_mod::correct_tracer_tile(), nesting_mod::fine2coarse2d(), nesting_mod::fine2coarse3d(), nesting_mod::get_persisted2d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_check_massflux(), and tl_nesting_mod::tl_correct_tracer_tile().

◆ j_top

integer, dimension(:), allocatable mod_nesting::j_top

Definition at line 196 of file mod_nesting.F.

196 integer, allocatable :: J_top(:) ! [Ngrids]

Referenced by ad_nesting_mod::ad_bry_fluxes(), ad_nesting_mod::ad_check_massflux(), ad_nesting_mod::ad_correct_tracer_tile(), nesting_mod::bry_fluxes(), nesting_mod::check_massflux(), nesting_mod::correct_tracer_tile(), nesting_mod::fine2coarse2d(), nesting_mod::fine2coarse3d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_check_massflux(), and tl_nesting_mod::tl_correct_tracer_tile().

◆ jdg_cp

integer, dimension(:), allocatable mod_nesting::jdg_cp

Definition at line 212 of file mod_nesting.F.

212 integer, allocatable :: Jdg_cp(:) ! [NCdatum]

Referenced by allocate_nesting(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ jrg_cp

integer, dimension(:), allocatable mod_nesting::jrg_cp

Definition at line 214 of file mod_nesting.F.

214 integer, allocatable :: Jrg_cp(:) ! [NCdatum]

Referenced by allocate_nesting(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ n2dcs

integer, parameter mod_nesting::n2dcs = 10

Definition at line 91 of file mod_nesting.F.

91 integer, parameter :: n2dCS = 10 ! 2D engine Corrector Step

Referenced by ad_nesting_mod::ad_get_composite(), ad_main3d(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), main3d(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), tl_main3d(), and tl_nesting_mod::tl_put_composite().

◆ n2dfx

integer, parameter mod_nesting::n2dfx = 11

Definition at line 92 of file mod_nesting.F.

92 integer, parameter :: n2dfx = 11 ! time-averaged 2D fluxes

Referenced by ad_nesting_mod::ad_get_composite(), ad_main3d(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), main3d(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), tl_main3d(), and tl_nesting_mod::tl_put_composite().

◆ n2dic

integer, parameter mod_nesting::n2dic = 2

Definition at line 83 of file mod_nesting.F.

83 integer, parameter :: n2dIC = 2 ! 2D momentum initialization

Referenced by ad_nesting_mod::ad_get_composite(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), initial(), roms_kernel_mod::nlm_initial(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), and tl_nesting_mod::tl_put_composite().

◆ n2dps

integer, parameter mod_nesting::n2dps = 9

Definition at line 90 of file mod_nesting.F.

90 integer, parameter :: n2dPS = 9 ! 2D engine Predictor Step

Referenced by ad_nesting_mod::ad_get_composite(), ad_main3d(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), main3d(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), tl_main3d(), and tl_nesting_mod::tl_put_composite().

◆ n2way

integer, parameter mod_nesting::n2way = -1

Definition at line 80 of file mod_nesting.F.

80 integer, parameter :: n2way = -1 ! fine to course coupling

Referenced by ad_main3d(), ad_nesting_mod::ad_nesting(), main3d(), nesting_mod::nesting(), tl_main3d(), and tl_nesting_mod::tl_nesting().

◆ n3dic

integer, parameter mod_nesting::n3dic = 3

Definition at line 84 of file mod_nesting.F.

84 integer, parameter :: n3dIC = 3 ! 3D momentum initialization

Referenced by ad_nesting_mod::ad_get_composite(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), initial(), roms_kernel_mod::nlm_initial(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), and tl_nesting_mod::tl_put_composite().

◆ n3dtv

integer, parameter mod_nesting::n3dtv = 13

Definition at line 94 of file mod_nesting.F.

94 integer, parameter :: n3dTV = 13 ! 3D tracer variables

Referenced by ad_nesting_mod::ad_get_composite(), ad_main3d(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), main3d(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), tl_main3d(), and tl_nesting_mod::tl_put_composite().

◆ n3duv

integer, parameter mod_nesting::n3duv = 12

Definition at line 93 of file mod_nesting.F.

93 integer, parameter :: n3duv = 12 ! 3D momentum and fluxes

Referenced by ad_nesting_mod::ad_get_composite(), ad_main3d(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), main3d(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), tl_main3d(), and tl_nesting_mod::tl_put_composite().

◆ nbstr

integer, parameter mod_nesting::nbstr = 5

Definition at line 86 of file mod_nesting.F.

86 integer, parameter :: nbstr = 5 ! bottom stress (bustr,bvstr)

Referenced by ad_nesting_mod::ad_get_composite(), ad_main3d(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), main3d(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), tl_main3d(), and tl_nesting_mod::tl_put_composite().

◆ ncdatum

integer mod_nesting::ncdatum

Definition at line 203 of file mod_nesting.F.

203 integer :: NCdatum

Referenced by allocate_nesting(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ ncontact

integer mod_nesting::ncontact

Definition at line 256 of file mod_nesting.F.

256 integer :: Ncontact ! total number of contact regions

◆ ncpoints

integer, dimension(:), allocatable mod_nesting::ncpoints

Definition at line 204 of file mod_nesting.F.

204 integer, allocatable :: NCpoints(:) ! [Ncontact]

Referenced by set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ ndxdy

integer, parameter mod_nesting::ndxdy = -5

Definition at line 76 of file mod_nesting.F.

76 integer, parameter :: ndxdy = -5 ! extract on_u and om_v

Referenced by ad_nesting_mod::ad_nesting(), nesting_mod::nesting(), set_grid(), and tl_nesting_mod::tl_nesting().

◆ nendr

integer, dimension(:), allocatable mod_nesting::nendr

Definition at line 205 of file mod_nesting.F.

Referenced by set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ nendu

integer, dimension(:), allocatable mod_nesting::nendu

Definition at line 206 of file mod_nesting.F.

Referenced by set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ nendv

integer, dimension(:), allocatable mod_nesting::nendv

Definition at line 207 of file mod_nesting.F.

Referenced by set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ nfsic

integer, parameter mod_nesting::nfsic = 1

Definition at line 82 of file mod_nesting.F.

82 integer, parameter :: nFSIC = 1 ! free surface initialization

Referenced by ad_nesting_mod::ad_get_composite(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), initial(), roms_kernel_mod::nlm_initial(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), and tl_nesting_mod::tl_put_composite().

◆ ngetd

integer, parameter mod_nesting::ngetd = -4

Definition at line 77 of file mod_nesting.F.

77 integer, parameter :: ngetD = -4 ! extract donor grid data

Referenced by ad_main3d(), ad_nesting_mod::ad_nesting(), main3d(), nesting_mod::nesting(), tl_main3d(), and tl_nesting_mod::tl_nesting().

◆ nmask

integer, parameter mod_nesting::nmask = -3

Definition at line 78 of file mod_nesting.F.

78 integer, parameter :: nmask = -3 ! scale interpolation weights

Referenced by ad_main3d(), ad_nesting_mod::ad_nesting(), initial(), main3d(), nesting_mod::nesting(), roms_kernel_mod::nlm_initial(), tl_main3d(), and tl_nesting_mod::tl_nesting().

◆ nmflx

integer, parameter mod_nesting::nmflx = -6

Definition at line 75 of file mod_nesting.F.

75 integer, parameter :: nmflx = -6 ! check mass flux conservation

Referenced by ad_main3d(), ad_nesting_mod::ad_nesting(), main3d(), nesting_mod::nesting(), tl_main3d(), and tl_nesting_mod::tl_nesting().

◆ nputd

integer, parameter mod_nesting::nputd = -2

Definition at line 79 of file mod_nesting.F.

79 integer, parameter :: nputD = -2 ! fill contact points

Referenced by ad_main3d(), ad_nesting_mod::ad_nesting(), main3d(), nesting_mod::nesting(), tl_main3d(), and tl_nesting_mod::tl_nesting().

◆ nrhst

integer, parameter mod_nesting::nrhst = 6

Definition at line 87 of file mod_nesting.F.

87 integer, parameter :: nrhst = 6 ! RHS terms (tracers)

Referenced by ad_nesting_mod::ad_get_composite(), ad_main3d(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), main3d(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), tl_main3d(), and tl_nesting_mod::tl_put_composite().

◆ nstrr

integer, dimension(:), allocatable mod_nesting::nstrr

Definition at line 205 of file mod_nesting.F.

205 integer, allocatable :: NstrR(:), NendR(:) ! [Ncontact]

Referenced by ad_nesting_mod::ad_get_persisted2d(), nesting_mod::get_persisted2d(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ nstru

integer, dimension(:), allocatable mod_nesting::nstru

Definition at line 206 of file mod_nesting.F.

206 integer, allocatable :: NstrU(:), NendU(:) ! [Ncontact]

Referenced by ad_nesting_mod::ad_get_persisted2d(), allocate_nesting(), nesting_mod::get_persisted2d(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ nstrv

integer, dimension(:), allocatable mod_nesting::nstrv

Definition at line 207 of file mod_nesting.F.

207 integer, allocatable :: NstrV(:), NendV(:) ! [Ncontact]

Referenced by ad_nesting_mod::ad_get_persisted2d(), allocate_nesting(), nesting_mod::get_persisted2d(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ ntvic

integer, parameter mod_nesting::ntvic = 4

Definition at line 85 of file mod_nesting.F.

85 integer, parameter :: nTVIC = 4 ! tracers initialization

Referenced by ad_nesting_mod::ad_get_composite(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), initial(), roms_kernel_mod::nlm_initial(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), and tl_nesting_mod::tl_put_composite().

◆ nzeta

integer, parameter mod_nesting::nzeta = 7

Definition at line 88 of file mod_nesting.F.

88 integer, parameter :: nzeta = 7 ! 3D kernel free-surface

Referenced by ad_nesting_mod::ad_get_composite(), ad_main3d(), ad_nesting_mod::ad_put_composite(), nesting_mod::get_composite(), main3d(), nesting_mod::put_composite(), tl_nesting_mod::tl_get_composite(), tl_main3d(), and tl_nesting_mod::tl_put_composite().

◆ nzwgt

integer, parameter mod_nesting::nzwgt = 8

Definition at line 89 of file mod_nesting.F.

89 integer, parameter :: nzwgt = 8 ! 3D vertical weights

Referenced by ad_main3d(), ad_nesting_mod::ad_nesting(), initial(), nesting_mod::nesting(), roms_kernel_mod::nlm_initial(), tl_main3d(), and tl_nesting_mod::tl_nesting().

◆ on_boundary

integer, dimension(:), allocatable mod_nesting::on_boundary

Definition at line 210 of file mod_nesting.F.

210 integer, allocatable :: on_boundary(:) ! [NCdatum]

Referenced by ad_nesting_mod::ad_get_persisted2d(), allocate_nesting(), nesting_mod::get_persisted2d(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ rcontact

type (t_ngc), dimension(:), allocatable mod_nesting::rcontact

Definition at line 286 of file mod_nesting.F.

286 TYPE (T_NGC), allocatable :: Rcontact(:) ! RHO-points, [Ncontact]

◆ receiver_grid

integer, dimension(:), allocatable mod_nesting::receiver_grid

Definition at line 173 of file mod_nesting.F.

173 integer, allocatable :: receiver_grid(:) ! [Ncontact]

Referenced by ad_nesting_mod::ad_correct_tracer_tile(), allocate_nesting(), nesting_mod::correct_tracer_tile(), metrics_mod::metrics_tile(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), and tl_nesting_mod::tl_correct_tracer_tile().

◆ refined

type (t_refined), dimension(:), allocatable mod_nesting::refined

Definition at line 437 of file mod_nesting.F.

437 TYPE (T_REFINED), allocatable :: REFINED(:) ! [Ncontact]

Referenced by ad_nesting_mod::ad_check_massflux(), ad_nesting_mod::ad_get_refine(), ad_nesting_mod::ad_put_refine2d(), ad_nesting_mod::ad_put_refine3d(), nesting_mod::check_massflux(), deallocate_nesting(), nesting_mod::get_metrics(), nesting_mod::get_refine(), initialize_nesting(), nesting_mod::put_refine2d(), nesting_mod::put_refine3d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_check_massflux(), tl_nesting_mod::tl_get_refine(), tl_nesting_mod::tl_put_refine2d(), tl_nesting_mod::tl_put_refine3d(), u2dbc_mod::u2dbc_tile(), and v2dbc_mod::v2dbc_tile().

◆ refinesteps

integer, dimension(:), allocatable mod_nesting::refinesteps

Definition at line 156 of file mod_nesting.F.

156 integer, allocatable :: RefineSteps(:) ! [Ngrids]

Referenced by nesting_mod::bry_fluxes(), nesting_mod::check_massflux(), deallocate_nesting(), metrics_mod::metrics_tile(), ntimesteps(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ refinestepscounter

integer, dimension(:), allocatable mod_nesting::refinestepscounter

Definition at line 162 of file mod_nesting.F.

162 integer, allocatable :: RefineStepsCounter(:) ! [Ngrids]

Referenced by deallocate_nesting(), ntimesteps(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ rollingindex

integer, dimension(:), allocatable mod_nesting::rollingindex

Definition at line 178 of file mod_nesting.F.

178 integer, allocatable :: RollingIndex(:) ! [Ncontact]

Referenced by ad_nesting_mod::ad_check_massflux(), ad_nesting_mod::ad_get_refine(), ad_nesting_mod::ad_put_refine(), ad_nesting_mod::ad_put_refine2d(), ad_nesting_mod::ad_put_refine3d(), nesting_mod::check_massflux(), deallocate_nesting(), nesting_mod::get_refine(), nesting_mod::put_refine2d(), nesting_mod::put_refine3d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_check_massflux(), tl_nesting_mod::tl_get_refine(), tl_nesting_mod::tl_put_refine2d(), tl_nesting_mod::tl_put_refine3d(), u2dbc_mod::u2dbc_tile(), and v2dbc_mod::v2dbc_tile().

◆ rollingtime

real(dp), dimension(:,:), allocatable mod_nesting::rollingtime

Definition at line 179 of file mod_nesting.F.

179 real(dp), allocatable :: RollingTime(:,:) ! [Ncontact]

Referenced by ad_nesting_mod::ad_get_refine(), ad_nesting_mod::ad_put_refine(), ad_nesting_mod::ad_put_refine2d(), ad_nesting_mod::ad_put_refine3d(), deallocate_nesting(), nesting_mod::get_refine(), nesting_mod::put_refine2d(), nesting_mod::put_refine3d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_get_refine(), tl_nesting_mod::tl_put_refine2d(), and tl_nesting_mod::tl_put_refine3d().

◆ telescoping

logical, dimension(:), allocatable mod_nesting::telescoping

Definition at line 117 of file mod_nesting.F.

117 logical, allocatable :: Telescoping(:) ! [Ngrids]

Referenced by nesting_mod::check_massflux(), deallocate_nesting(), metrics_mod::metrics_tile(), ntimesteps(), set_contact_mod::set_contact_nf90(), and set_contact_mod::set_contact_pio().

◆ twowayinterval

real(r8), dimension(:), allocatable mod_nesting::twowayinterval

Definition at line 167 of file mod_nesting.F.

167 real(r8), allocatable :: TwoWayInterval(:) ! [Ngrids]

Referenced by ad_main3d(), nesting_mod::check_massflux(), deallocate_nesting(), main3d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), and tl_main3d().

◆ ucontact

type (t_ngc), dimension(:), allocatable mod_nesting::ucontact

Definition at line 287 of file mod_nesting.F.

287 TYPE (T_NGC), allocatable :: Ucontact(:) ! U-points, [Ncontact]

Referenced by ad_nesting_mod::ad_fine2coarse(), ad_nesting_mod::ad_get_composite(), ad_nesting_mod::ad_get_refine(), ad_nesting_mod::ad_put_composite(), ad_nesting_mod::ad_put_refine2d(), ad_nesting_mod::ad_put_refine3d(), ad_nesting_mod::ad_z_weights(), deallocate_nesting(), nesting_mod::fine2coarse(), nesting_mod::get_composite(), get_grid_mod::get_grid_nf90(), get_grid_mod::get_grid_pio(), nesting_mod::get_metrics(), nesting_mod::get_refine(), nesting_mod::mask_hweights(), nesting_mod::put_composite(), nesting_mod::put_refine2d(), nesting_mod::put_refine3d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_fine2coarse(), tl_nesting_mod::tl_get_composite(), tl_nesting_mod::tl_get_refine(), tl_nesting_mod::tl_put_composite(), tl_nesting_mod::tl_put_refine2d(), tl_nesting_mod::tl_put_refine3d(), tl_nesting_mod::tl_z_weights(), u2dbc_mod::u2dbc_tile(), and nesting_mod::z_weights().

◆ vcontact

type (t_ngc), dimension(:), allocatable mod_nesting::vcontact

Definition at line 288 of file mod_nesting.F.

288 TYPE (T_NGC), allocatable :: Vcontact(:) ! V-points, [Ncontact]

Referenced by ad_nesting_mod::ad_fine2coarse(), ad_nesting_mod::ad_get_composite(), ad_nesting_mod::ad_get_refine(), ad_nesting_mod::ad_put_composite(), ad_nesting_mod::ad_put_refine2d(), ad_nesting_mod::ad_put_refine3d(), ad_nesting_mod::ad_z_weights(), deallocate_nesting(), nesting_mod::fine2coarse(), nesting_mod::get_composite(), get_grid_mod::get_grid_nf90(), get_grid_mod::get_grid_pio(), nesting_mod::get_metrics(), nesting_mod::get_refine(), nesting_mod::mask_hweights(), nesting_mod::put_composite(), nesting_mod::put_refine2d(), nesting_mod::put_refine3d(), set_contact_mod::set_contact_nf90(), set_contact_mod::set_contact_pio(), tl_nesting_mod::tl_fine2coarse(), tl_nesting_mod::tl_get_composite(), tl_nesting_mod::tl_get_refine(), tl_nesting_mod::tl_put_composite(), tl_nesting_mod::tl_put_refine2d(), tl_nesting_mod::tl_put_refine3d(), tl_nesting_mod::tl_z_weights(), v2dbc_mod::v2dbc_tile(), and nesting_mod::z_weights().

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ allocate_nesting()

◆ deallocate_nesting()

◆ initialize_nesting()

Variable Documentation

◆ bry_contact

◆ coarserdonor

◆ composite

◆ contact_metric

◆ contact_region

◆ contactregion

◆ donor_grid

◆ donortofiner

◆ finerdonor

◆ get_vweights

◆ i_left

◆ i_right

◆ idg_cp

◆ irg_cp

◆ j_bottom

◆ j_top

◆ jdg_cp

◆ jrg_cp

◆ n2dcs

◆ n2dfx

◆ n2dic

◆ n2dps

◆ n2way

◆ n3dic

◆ n3dtv

◆ n3duv

◆ nbstr

◆ ncdatum

◆ ncontact

◆ ncpoints

◆ ndxdy

◆ nendr

◆ nendu

◆ nendv

◆ nfsic

◆ ngetd

◆ nmask

◆ nmflx

◆ nputd

◆ nrhst

◆ nstrr

◆ nstru

◆ nstrv

◆ ntvic

◆ nzeta

◆ nzwgt

◆ on_boundary

◆ rcontact

◆ receiver_grid

◆ refined

◆ refinesteps

◆ refinestepscounter

◆ rollingindex

◆ rollingtime

◆ telescoping

◆ twowayinterval

◆ ucontact

◆ vcontact