Grid_getBlkNeighLevels.F90 File Reference

Go to the source code of this file.

Functions/Subroutines
subroutine	Grid_getBlkNeighLevels (blockID, levels, trackBdry)

Function/Subroutine Documentation

Grid_getBlkNeighLevels()

subroutine Grid_getBlkNeighLevels	(	integer	blockID,
		integer, dimension(-1:1, -K2D:K2D , -K3D:K3D)	levels,
		logical	trackBdry
	)

For a given block, return refinement level information for its neigboring blocks in all directions, including diagonal.

It is assumed that blockID indicates a leaf block.

The level information returned can be used to determine the leaf block resolution from which data in the various guard cell regions of block blockID is derived when Grid_fillGuardCells is called. In particular, the caller can determine from this info for each guard cell region whether the guard cell data has been derived from interpolation or averaging, or by copying of unmodified leaf block data only.

blockID : ID of block in current processor levels : returns refinement level for the neigboring regions if the information is easily available on the executing MPI task, or one of the following indicators: * 1 .. lrefine_max a refinement level * -2 unknown or mixed refinement level <= lrefine(blockID) * -3 unknown or mixed refinement level * 10002 unknown or mixed refinement level >= lrefine(blockID) * 10003 unknown or mixed refinement level > lrefine(blockID) * 0 no information available The argument levels is an integer array of shape (3,1,1) for NDIM=1, (3,3,1) for NDIM=2, or (3,3,3) for NDIM=3. If its bounds are declared as dimension(-1:1,-K2D:K2D,-K3D:K3D), then * levels(0,0,0) always refers to the inner cells of block blockID itself and will always be set to the refinement level of blockID. The functionality of Grid_getBlkNeighLevels thus includes that of Grid_getBlkRefineLevel in all implementations. * levels(-1,0,0) and (+1,0,0) refer to left (West) and right (East) neighbors in the I direction, respectively. * levels(0,-1,0) and (0,+1,0) refer to lower (North) and right (South) neighbors in the J direction, respectively. * levels(0,0,-1) and (0,0,+1) refer to above and below neighbors in the K direction, respectively. * other elements refer to neighbors in diagonal directions. trackBdry: If present and TRUE, enable additional code for determining whether guard cells in diagonal directions that are located outside of the domain at a domain boundary might be filled (by the implementation of a boundary condition) based on data from a neighboring block at a different refinement level. If not present or not TRUE, directions that point outside of the domain are always considered to be at the same level as the current block.

NOTES

DEV: Currently only implemented correctly for Paramesh4 and UG!

With a Paramesh4 Grid implementation, refinement level information is taken from the PARAMESH private array surr_blks and is always available for all directions. With a uniform Grid implementation, refinement level 1 is returned for all directions since all blocks are considered to be at refinement level 1. With the AMReX Grid, this interface is not yet implemented.

The actual argument corresponding to the level dummy argument may be declared in the caller in various ways, for example integer :: levels(-1:1, -K2D:K2D , -K3D:K3D) or integer :: levels(3 , 1:1+2*K2D, 1:1+2*K3D) can be used equivalently (independent of whether NDIM = 1,2, or 3).

NDIM,K2D,K3D are defined in Simulation.h or constants.h.

SEE ALSO

Grid_getBlkRefineLevel gr_findAllNeghID

Definition at line 95 of file Grid_getBlkNeighLevels.F90.