A Rectangular Domain on an Integer Lattice. More...

#include <AMReX_Box.H>

Public Member Functions
__host__ __device__ constexpr	BoxND () noexcept
	Default constructor creates an invalid box (use ok() to test).

__host__ __device__ constexpr	BoxND (const IntVectND< dim > &small, const IntVectND< dim > &big) noexcept
	Construct a cell-centered box spanning `small` through `big`.

__host__ __device__	BoxND (const IntVectND< dim > &small, const int *vec_len) noexcept
	Construct a box with lower corner `small` and lengths `vec_len`.

__host__ __device__	BoxND (const IntVectND< dim > &small, const IntVectND< dim > &big, const IntVectND< dim > &typ) noexcept
	Construct a box with explicit nodal/cell flags per direction.

__host__ __device__	BoxND (const IntVectND< dim > &small, const IntVectND< dim > &big, IndexTypeND< dim > t) noexcept
	Construct a box with the given index type descriptor.

template<typename T > requires ( 1<=dim && dim<=3 )
__host__ __device__	BoxND (Array4< T > const &a) noexcept
	Construct a box from an Array4 view (bounds are inferred from begin/end).

__host__ __device__ const IntVectND< dim > &	smallEnd () const &noexcept
	Return the inclusive lower bound of the box.

__host__ __device__ int	smallEnd (int dir) const &noexcept
	Return the inclusive lower bound in the given direction.

__host__ __device__ const IntVectND< dim > &	bigEnd () const &noexcept
	Return the inclusive upper bound of the box.

__host__ __device__ int	bigEnd (int dir) const noexcept
	Return the inclusive upper bound in the given direction.

__host__ __device__ IndexTypeND< dim >	ixType () const noexcept
	Return the indexing type.

__host__ __device__ IntVectND< dim >	type () const noexcept
	Return the indexing type.

__host__ __device__ IndexType::CellIndex	type (int dir) const noexcept
	Return the indexing type in the specified direction.

__host__ __device__ IntVectND< dim >	size () const noexcept
	Return the length of the BoxND.

__host__ __device__ IntVectND< dim >	length () const noexcept
	Return the length of the BoxND.

__host__ __device__ int	length (int dir) const noexcept
	Return the length of the BoxND in given direction.

__host__ __device__ GpuArray< int, 3 >	length3d () const noexcept
	Return lengths padded to 3D (missing dims default to 1).

__host__ __device__ GpuArray< int, 3 >	loVect3d () const noexcept
	Return low-end coordinates padded to 3D (missing dims default to 0).

__host__ __device__ GpuArray< int, 3 >	hiVect3d () const noexcept
	Return high-end coordinates padded to 3D (missing dims default to 0).

__host__ __device__ const int *	loVect () const &noexcept
	Return a pointer to the low-end coordinates (useful for Fortran calls).

__host__ __device__ const int *	loVect () &&=delete

__host__ __device__ const int *	hiVect () const &noexcept
	Return a pointer to the high-end coordinates (useful for Fortran calls).

__host__ __device__ const int *	hiVect () &&=delete

__host__ __device__ int	operator[] (Orientation face) const noexcept
	Return the coordinate normal to the given face.

__host__ __device__ bool	isEmpty () const noexcept
	Checks if it is an empty BoxND.

__host__ __device__ bool	ok () const noexcept
	Return true if high bounds are >= low bounds and the index type is valid.

__host__ __device__ bool	contains (const IntVectND< dim > &p) const noexcept
	Return true if argument is contained within BoxND.

__host__ __device__ bool	contains (const Dim3 &p) const noexcept
	Return true if argument is contained within BoxND.

__host__ __device__ bool	contains (int i, int j, int k) const noexcept
	Return true if argument is contained within BoxND.

__host__ __device__ bool	contains (const BoxND &b) const noexcept
	Return true if argument is contained within BoxND. It is an error if the Boxes have different types.

__host__ __device__ bool	strictly_contains (const IntVectND< dim > &p) const noexcept
	Return true if argument is strictly contained within BoxND.

__host__ __device__ bool	strictly_contains (const BoxND &b) const noexcept
	Return true if argument is strictly contained within BoxND. It is an error if the Boxes have different types.

__host__ __device__ bool	strictly_contains (const Dim3 &p) const noexcept
	Return true if argument is strictly contained within BoxND.

__host__ __device__ bool	strictly_contains (int i, int j, int k) const noexcept
	Return true if argument is strictly contained within BoxND.

__host__ __device__ bool	intersects (const BoxND &b) const noexcept
	Return true if Boxes have non-null intersections. It is an error if the Boxes have different types.

__host__ __device__ bool	sameSize (const BoxND &b) const noexcept
	Return true is Boxes same size, ie translates of each other,. It is an error if they have different types.

__host__ __device__ bool	sameType (const BoxND &b) const noexcept
	Return true if Boxes have same type.

__host__ __device__ bool	operator== (const BoxND &b) const noexcept
	Return true if Boxes are identical (including type).

__host__ __device__ bool	operator!= (const BoxND &b) const noexcept
	Return true if Boxes differ (including type).

__host__ __device__ bool	operator< (const BoxND &rhs) const noexcept
	Lexicographic ordering (type, then lower, then upper corners).

__host__ __device__ bool	operator<= (const BoxND &rhs) const noexcept
	Return true if this box is <= rhs in the lexicographic ordering.

__host__ __device__ bool	operator> (const BoxND &rhs) const noexcept
	Return true if this box is > rhs in the lexicographic ordering.

__host__ __device__ bool	operator>= (const BoxND &rhs) const noexcept
	Return true if this box is >= rhs in the lexicographic ordering.

__host__ __device__ bool	cellCentered () const noexcept
	Return true if BoxND is cell-centered in all indexing directions.

__host__ __device__ Long	numPts () const noexcept
	Return the number of points contained in the BoxND.

__host__ __device__ double	d_numPts () const noexcept
	Return the number of points contained in the BoxND. This is intended for use only in diagnostic messages.

__host__ __device__ Long	volume () const noexcept
	Return the volume, in indexing space, of region enclosed by this BoxND. This is identical to numPts() for CELL centered BoxND; otherwise, numPts() > volume().

__host__ __device__ int	longside (int &dir) const noexcept
	Return length of longest side. dir is modified to give direction with longest side: 0...dim-1. Ignores type.

__host__ __device__ int	longside () const noexcept
	Return length of longest side. Ignores type.

__host__ __device__ int	shortside (int &dir) const noexcept
	Return length of shortest side. dir is modified to give direction with shortest side: 0...dim-1. Ignores type.

__host__ __device__ int	shortside () const noexcept
	Return length of shortest side. Ignores type.

__host__ __device__ Long	index (const IntVectND< dim > &v) const noexcept
	Return offset of point from smallend; i.e. index(smallend) -> 0, bigend would return numPts()-1. Is used in accessing FArrayBox.

__host__ __device__ IntVectND< dim >	atOffset (Long offset) const noexcept
	Given the offset, compute IntVectND<dim>

template<int N = dim> requires (1 <= N && N <= 3)
__host__ __device__ GpuArray< int, 3 >	atOffset3d (Long offset) const noexcept

__host__ __device__ BoxND &	setSmall (const IntVectND< dim > &sm) noexcept

__host__ __device__ BoxND &	setSmall (int dir, int sm_index) noexcept
	Redefine the small end of the BoxND.

__host__ __device__ BoxND &	setBig (const IntVectND< dim > &bg) noexcept
	Redefine the big end of the BoxND.

__host__ __device__ BoxND &	setBig (int dir, int bg_index) noexcept
	Redefine the big end of the BoxND.

__host__ __device__ BoxND &	setRange (int dir, int sm_index, int n_cells=1) noexcept
	Set the entire range in a given direction, starting at sm_index with length n_cells. NOTE: This will yield an illegal BoxND if n_cells <= 0.

__host__ __device__ BoxND &	setType (const IndexTypeND< dim > &t) noexcept
	Set indexing type.

__host__ __device__ BoxND &	shift (int dir, int nzones) noexcept
	Shift this BoxND nzones indexing positions in coordinate direction dir.

__host__ __device__ BoxND &	shift (const IntVectND< dim > &iv) noexcept
	Equivalent to b.shift(0,iv[0]).shift(1,iv[1]) ....

__host__ __device__ BoxND &	shiftHalf (int dir, int num_halfs) noexcept
	This member shifts the BoxND by "half" indices, thereby converting the BoxND from type CELL to NODE and visa-versa. b.shiftHalf(0,1) shifts b to the right by 1/2 cells. b.shiftHalf(1,-3) shifts b in the -j direction by 3/2 cells. NOTE: If num_halfs is EVEN the shift is num_halfs/2 full zones and hence will not change the type. This is: b.shifthalf(4) == b.shift(2).

__host__ __device__ BoxND &	shiftHalf (const IntVectND< dim > &iv) noexcept
	Equivalent to b.shiftHalf(0,iv[0]).shiftHalf(1,iv[1]) ...

__host__ __device__ BoxND &	convert (IndexTypeND< dim > typ) noexcept
	Convert the BoxND from the current type into the argument type. This may change the BoxND coordinates: type CELL -> NODE : increase coordinate by one on high end type NODE -> CELL : reduce coordinate by one on high end other type mappings make no change.

__host__ __device__ BoxND &	convert (const IntVectND< dim > &typ) noexcept
	Convert the BoxND from the current type into the argument type. This may change the BoxND coordinates: type CELL -> NODE : increase coordinate by one on high end type NODE -> CELL : reduce coordinate by one on high end other type mappings make no change.

__host__ __device__ BoxND &	surroundingNodes () noexcept
	Convert to NODE type in all directions.

__host__ __device__ BoxND &	surroundingNodes (int dir) noexcept
	Convert to NODE type in given direction.

__host__ __device__ BoxND &	surroundingNodes (Direction d) noexcept
	Convert to NODE type in given direction.

__host__ __device__ BoxND &	enclosedCells () noexcept
	Convert to CELL type in all directions.

__host__ __device__ BoxND &	enclosedCells (int dir) noexcept
	Convert to CELL type in given direction.

__host__ __device__ BoxND &	enclosedCells (Direction d) noexcept
	Convert to CELL type in given Direction `d`.

__host__ __device__ BoxND	operator& (const BoxND &rhs) const noexcept
	Return BoxND that is intersection of this BoxND and argument. The Boxes MUST be of same type.

__host__ __device__ BoxND &	operator&= (const BoxND &rhs) noexcept
	Intersect this BoxND with its argument. The Boxes MUST be of the same type.

__host__ __device__ BoxND &	minBox (const BoxND &b) noexcept
	Modify BoxND to that of the minimum BoxND containing both the original BoxND and the argument. Both Boxes must have identical type.

__host__ __device__ BoxND &	operator+= (const IntVectND< dim > &v) noexcept
	Shift BoxND (relative) by given IntVectND<dim>.

__host__ __device__ BoxND	operator+ (const IntVectND< dim > &v) const noexcept
	Shift BoxND (relative) by given IntVectND<dim>.

__host__ __device__ BoxND &	operator-= (const IntVectND< dim > &v) noexcept
	Shift BoxND (relative) by given IntVectND<dim>.

__host__ __device__ BoxND	operator- (const IntVectND< dim > &v) const noexcept
	Shift BoxND (relative) by given IntVectND<dim>.

__host__ __device__ BoxND	chop (int dir, int chop_pnt) noexcept
	Chop the BoxND at `chop_pnt` in the `dir` direction return one BoxND and modify the object BoxND. The union of the two is the original BoxND. The modified BoxND is the low end, the returned BoxND is the high end. If type(dir) = CELL, the Boxes are disjoint with the chop_pnt included in the high end (new BoxND). It is an ERROR if chop_pnt is the low end of the orig BoxND. If type(dir) = NODE, the chop_pnt is included in both Boxes but is the only point in common. It is also an error if the chop_pnt is an end node of the BoxND.

__host__ __device__ BoxND &	grow (int i) noexcept
	Grow in all directions by `i` cells (negative shrinks).

__host__ __device__ BoxND &	grow (const IntVectND< dim > &v) noexcept
	Grow in each direction by the supplied amount (negative shrinks).

__host__ __device__ BoxND &	grow (int idir, int n_cell) noexcept
	Grow on both ends in direction `idir` by `n_cell` cells (negative shrinks).

__host__ __device__ BoxND &	grow (Direction d, int n_cell) noexcept
	Grow on both ends in direction d by `n_cell` cells (negative shrinks).

__host__ __device__ BoxND &	growLo (int idir, int n_cell=1) noexcept
	Grow on the low end by `n_cell` cells in direction `idir` (negative shrinks).

__host__ __device__ BoxND &	growLo (Direction d, int n_cell=1) noexcept
	Grow on the low end by `n_cell` cells in direction `d` (negative shrinks).

__host__ __device__ BoxND &	growHi (int idir, int n_cell=1) noexcept
	Grow on the high end by `n_cell` cells in direction `idir` (negative shrinks).

__host__ __device__ BoxND &	growHi (Direction d, int n_cell=1) noexcept
	Grow on the high end by `n_cell` cells in direction `d` (negative shrinks).

__host__ __device__ BoxND &	grow (Orientation face, int n_cell=1) noexcept
	Grow in the direction of the given face.

__host__ __device__ BoxND &	refine (int ref_ratio) noexcept
	Refine BoxND by given (positive) refinement ratio. NOTE: if type(dir) = CELL centered: lo <- loratio and hi <- (hi+1)ratio - 1. NOTE: if type(dir) = NODE centered: lo <- loratio and hi <- hiratio.

__host__ __device__ BoxND &	refine (const IntVectND< dim > &ref_ratio) noexcept
	Refine BoxND by given (positive) refinement ratio. NOTE: if type(dir) = CELL centered: lo <- loratio and hi <- (hi+1)ratio - 1. NOTE: if type(dir) = NODE centered: lo <- loratio and hi <- hiratio.

__host__ __device__ BoxND &	coarsen (int ref_ratio) noexcept
	Coarsen BoxND by given (positive) refinement ratio. NOTE: if type(dir) = CELL centered: lo <- lo/ratio and hi <- hi/ratio. NOTE: if type(dir) = NODE centered: lo <- lo/ratio and hi <- hi/ratio + ((hiratio)==0 ? 0 : 1). That is, refinement of coarsened BoxND must contain the original BoxND.

__host__ __device__ BoxND &	coarsen (const IntVectND< dim > &ref_ratio) noexcept
	Coarsen BoxND by given (positive) refinement ratio. NOTE: if type(dir) = CELL centered: lo <- lo/ratio and hi <- hi/ratio. NOTE: if type(dir) = NODE centered: lo <- lo/ratio and hi <- hi/ratio + ((hiratio)==0 ? 0 : 1). That is, refinement of coarsened BoxND must contain the original BoxND.

__host__ __device__ void	next (IntVectND< dim > &) const noexcept
	Step through the rectangle. It is a runtime error to give a point not inside rectangle. Iteration may not be efficient.

__host__ __device__ bool	isSquare () const noexcept

__host__ __device__ bool	coarsenable (const IntVectND< dim > &refrat, const IntVectND< dim > &min_width) const noexcept
	Return whether this Box is coarsenable.

__host__ __device__ bool	coarsenable (int refrat, int min_width=1) const noexcept
	Return whether this Box is coarsenable.

__host__ __device__ bool	coarsenable (const IntVectND< dim > &refrat, int min_width=1) const noexcept
	Return whether this Box is coarsenable.

__host__ __device__ void	normalize () noexcept
	Ensure each dimension has at least one cell or node by expanding empty directions.

__host__ __device__ BoxND &	makeSlab (int direction, int slab_index) noexcept
	Collapse the box to a single slab at coordinate `slab_index` along `direction`.

BoxIteratorND< dim >	iterator () const noexcept
	Return a BoxIteratorND that can be used to loop over the IntVects contained by the BoxND.

template<int new_dim>
__host__ __device__ BoxND< new_dim >	shrink () const noexcept
	Return a new BoxND of dimension new_dim and assigns the first new_dim dimension of this BoxND to it.

template<int new_dim>
__host__ __device__ BoxND< new_dim >	expand () const noexcept
	Return a new BoxND of size new_dim and assigns all values of this BoxND to it and (small=0, big=0, typ=CELL) to the remaining elements.

template<int new_dim>
__host__ __device__ BoxND< new_dim >	resize () const noexcept
	Return a new BoxND of size new_dim by either shrinking or expanding this BoxND.

Static Public Member Functions
__host__ static __device__ BoxND	TheUnitBox () noexcept
	This static member function returns a constant reference to an object of type BoxND representing the unit BoxND in dim-dimensional space.

__host__ static __device__ constexpr std::size_t	ndims () noexcept

__host__ static __device__ constexpr int	indims () noexcept

Friends
class	BoxCommHelper

MPI_Datatype	ParallelDescriptor::Mpi_typemap ()

Detailed Description

template<int dim>
class amrex::BoxND< dim >

A Rectangular Domain on an Integer Lattice.

A BoxND is an abstraction for defining discrete regions of dim indexing space. Boxes have an IndexType, which defines IndexType::CELL or IndexType::NODE based points for each direction and a low and high INTVECT which defines the lower and upper corners of the BoxND. Boxes can exist in positive and negative indexing space.

Box is a dimension dependent alias to BoxND<AMREX_SPACEDIM>, so AMREX_SPACEDIM must be defined as either 1, 2, or 3 when compiling.

Constructor & Destructor Documentation

◆ BoxND() [1/6]

template<int dim>

__host__ __device__ constexpr amrex::BoxND< dim >::BoxND ( )

inlineconstexprnoexcept

Default constructor creates an invalid box (use ok() to test).

◆ BoxND() [2/6]

template<int dim>

__host__ __device__ constexpr amrex::BoxND< dim >::BoxND	(	const IntVectND< dim > &	small,
		const IntVectND< dim > &	big
	)

inlineconstexprnoexcept

Construct a cell-centered box spanning small through big.

◆ BoxND() [3/6]

template<int dim>

__host__ __device__ amrex::BoxND< dim >::BoxND	(	const IntVectND< dim > &	small,
		const int *	vec_len
	)

inlinenoexcept

Construct a box with lower corner small and lengths vec_len.

Parameters

small	Lower corner.
vec_len	Array of lengths in each direction.

◆ BoxND() [4/6]

template<int dim>

__host__ __device__ amrex::BoxND< dim >::BoxND	(	const IntVectND< dim > &	small,
		const IntVectND< dim > &	big,
		const IntVectND< dim > &	typ
	)

inlinenoexcept

Construct a box with explicit nodal/cell flags per direction.

Parameters

small	Lower corner.
big	Upper corner.
typ	IntVect of 0 (cell) / 1 (node) selectors.

◆ BoxND() [5/6]

template<int dim>

__host__ __device__ amrex::BoxND< dim >::BoxND	(	const IntVectND< dim > &	small,
		const IntVectND< dim > &	big,
		IndexTypeND< dim >	t
	)

inlinenoexcept

Construct a box with the given index type descriptor.

◆ BoxND() [6/6]

template<int dim>

template<typename T >
requires ( 1<=dim && dim<=3 )

__host__ __device__ amrex::BoxND< dim >::BoxND ( Array4< T > const & a )

inlineexplicitnoexcept

Construct a box from an Array4 view (bounds are inferred from begin/end).

Member Function Documentation

◆ atOffset()

template<int dim>

__host__ __device__ IntVectND< dim > amrex::BoxND< dim >::atOffset ( Long offset ) const

inlinenoexcept

Given the offset, compute IntVectND<dim>

◆ atOffset3d()

template<int dim>
requires (1 <= N && N <= 3)

template<int N>
requires (1 <= N && N <= 3)

__host__ __device__ GpuArray< int, 3 > amrex::BoxND< dim >::atOffset3d ( Long offset ) const

inlinenoexcept

Given the offset, return its corresponding index vector in GpuArray<int,3>. This function is available for 1D, 2D and 3D Boxes only,

◆ bigEnd() [1/2]

template<int dim>

__host__ __device__ const IntVectND< dim > & amrex::BoxND< dim >::bigEnd ( ) const &

inlinenoexcept

Return the inclusive upper bound of the box.

◆ bigEnd() [2/2]

template<int dim>

__host__ __device__ int amrex::BoxND< dim >::bigEnd ( int dir ) const

inlinenoexcept

Return the inclusive upper bound in the given direction.

◆ cellCentered()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::cellCentered ( ) const

inlinenoexcept

Return true if BoxND is cell-centered in all indexing directions.

◆ chop()

template<int dim>

__host__ __device__ BoxND< dim > amrex::BoxND< dim >::chop	(	int	dir,
		int	chop_pnt
	)

inlinenoexcept

Chop the BoxND at chop_pnt in the dir direction return one BoxND and modify the object BoxND. The union of the two is the original BoxND. The modified BoxND is the low end, the returned BoxND is the high end. If type(dir) = CELL, the Boxes are disjoint with the chop_pnt included in the high end (new BoxND). It is an ERROR if chop_pnt is the low end of the orig BoxND. If type(dir) = NODE, the chop_pnt is included in both Boxes but is the only point in common. It is also an error if the chop_pnt is an end node of the BoxND.

◆ coarsen() [1/2]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::coarsen ( const IntVectND< dim > & ref_ratio )

inlinenoexcept

Coarsen BoxND by given (positive) refinement ratio. NOTE: if type(dir) = CELL centered: lo <- lo/ratio and hi <- hi/ratio. NOTE: if type(dir) = NODE centered: lo <- lo/ratio and hi <- hi/ratio + ((hiratio)==0 ? 0 : 1). That is, refinement of coarsened BoxND must contain the original BoxND.

◆ coarsen() [2/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::coarsen ( int ref_ratio )

inlinenoexcept

Coarsen BoxND by given (positive) refinement ratio. NOTE: if type(dir) = CELL centered: lo <- lo/ratio and hi <- hi/ratio. NOTE: if type(dir) = NODE centered: lo <- lo/ratio and hi <- hi/ratio + ((hiratio)==0 ? 0 : 1). That is, refinement of coarsened BoxND must contain the original BoxND.

◆ coarsenable() [1/3]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::coarsenable	(	const IntVectND< dim > &	refrat,
		const IntVectND< dim > &	min_width
	)		const

inlinenoexcept

Return whether this Box is coarsenable.

A coasrenable Box means box.coarsen(ratio).refine(ratio) == box. A Box is considered uncoarsenable if the coarsened Box would have a length smaller than the given minimum width.

Parameters

refrat	coarsening ratio
min_width	minimum width of coarsened Box.

Returns: whether this Box is coarsenable.

◆ coarsenable() [2/3]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::coarsenable	(	const IntVectND< dim > &	refrat,
		int	min_width = `1`
	)		const

inlinenoexcept

Return whether this Box is coarsenable.

A coasrenable Box means box.coarsen(ratio).refine(ratio) == box. A Box is considered uncoarsenable if the coarsened Box would have a length smaller than the given minimum width.

Parameters

refrat	coarsening ratio
min_width	minimum width of coarsened Box.

Returns: whether this Box is coarsenable.

◆ coarsenable() [3/3]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::coarsenable	(	int	refrat,
		int	min_width = `1`
	)		const

inlinenoexcept

Return whether this Box is coarsenable.

A coasrenable Box means box.coarsen(ratio).refine(ratio) == box. A Box is considered uncoarsenable if the coarsened Box would have a length smaller than the given minimum width.

Parameters

refrat	coarsening ratio
min_width	minimum width of coarsened Box.

Returns: whether this Box is coarsenable.

◆ contains() [1/4]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::contains ( const BoxND< dim > & b ) const

inlinenoexcept

Return true if argument is contained within BoxND. It is an error if the Boxes have different types.

◆ contains() [2/4]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::contains ( const Dim3 & p ) const

inlinenoexcept

Return true if argument is contained within BoxND.

◆ contains() [3/4]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::contains ( const IntVectND< dim > & p ) const

inlinenoexcept

Return true if argument is contained within BoxND.

◆ contains() [4/4]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::contains	(	int	i,
		int	j,
		int	k
	)		const

inlinenoexcept

Return true if argument is contained within BoxND.

◆ convert() [1/2]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::convert ( const IntVectND< dim > & typ )

inlinenoexcept

Convert the BoxND from the current type into the argument type. This may change the BoxND coordinates: type CELL -> NODE : increase coordinate by one on high end type NODE -> CELL : reduce coordinate by one on high end other type mappings make no change.

◆ convert() [2/2]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::convert ( IndexTypeND< dim > typ )

inlinenoexcept

Convert the BoxND from the current type into the argument type. This may change the BoxND coordinates: type CELL -> NODE : increase coordinate by one on high end type NODE -> CELL : reduce coordinate by one on high end other type mappings make no change.

◆ d_numPts()

template<int dim>

__host__ __device__ double amrex::BoxND< dim >::d_numPts ( ) const

inlinenoexcept

Return the number of points contained in the BoxND. This is intended for use only in diagnostic messages.

◆ enclosedCells() [1/3]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::enclosedCells ( )

inlinenoexcept

Convert to CELL type in all directions.

◆ enclosedCells() [2/3]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::enclosedCells ( Direction d )

inlinenoexcept

Convert to CELL type in given Direction d.

◆ enclosedCells() [3/3]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::enclosedCells ( int dir )

inlinenoexcept

Convert to CELL type in given direction.

◆ expand()

template<int dim>

template<int new_dim>

__host__ __device__ BoxND< new_dim > amrex::BoxND< dim >::expand ( ) const

inlinenoexcept

Return a new BoxND of size new_dim and assigns all values of this BoxND to it and (small=0, big=0, typ=CELL) to the remaining elements.

◆ grow() [1/5]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::grow ( const IntVectND< dim > & v )

inlinenoexcept

Grow in each direction by the supplied amount (negative shrinks).

◆ grow() [2/5]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::grow	(	Direction	d,
		int	n_cell
	)

inlinenoexcept

Grow on both ends in direction d by n_cell cells (negative shrinks).

◆ grow() [3/5]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::grow ( int i )

inlinenoexcept

Grow in all directions by i cells (negative shrinks).

◆ grow() [4/5]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::grow	(	int	idir,
		int	n_cell
	)

inlinenoexcept

Grow on both ends in direction idir by n_cell cells (negative shrinks).

◆ grow() [5/5]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::grow	(	Orientation	face,
		int	n_cell = `1`
	)

inlinenoexcept

Grow in the direction of the given face.

◆ growHi() [1/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::growHi	(	Direction	d,
		int	n_cell = `1`
	)

inlinenoexcept

Grow on the high end by n_cell cells in direction d (negative shrinks).

◆ growHi() [2/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::growHi	(	int	idir,
		int	n_cell = `1`
	)

inlinenoexcept

Grow on the high end by n_cell cells in direction idir (negative shrinks).

◆ growLo() [1/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::growLo	(	Direction	d,
		int	n_cell = `1`
	)

inlinenoexcept

Grow on the low end by n_cell cells in direction d (negative shrinks).

◆ growLo() [2/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::growLo	(	int	idir,
		int	n_cell = `1`
	)

inlinenoexcept

Grow on the low end by n_cell cells in direction idir (negative shrinks).

◆ hiVect() [1/2]

template<int dim>

__host__ __device__ const int * amrex::BoxND< dim >::hiVect ( ) &&

delete

◆ hiVect() [2/2]

template<int dim>

__host__ __device__ const int * amrex::BoxND< dim >::hiVect ( ) const &

inlinenoexcept

Return a pointer to the high-end coordinates (useful for Fortran calls).

◆ hiVect3d()

template<int dim>

__host__ __device__ GpuArray< int, 3 > amrex::BoxND< dim >::hiVect3d ( ) const

inlinenoexcept

Return high-end coordinates padded to 3D (missing dims default to 0).

◆ index()

template<int dim>

__host__ __device__ Long amrex::BoxND< dim >::index ( const IntVectND< dim > & v ) const

inlinenoexcept

Return offset of point from smallend; i.e. index(smallend) -> 0, bigend would return numPts()-1. Is used in accessing FArrayBox.

◆ indims()

template<int dim>

__host__ static __device__ constexpr int amrex::BoxND< dim >::indims ( )

inlinestaticconstexprnoexcept

◆ intersects()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::intersects ( const BoxND< dim > & b ) const

inlinenoexcept

Return true if Boxes have non-null intersections. It is an error if the Boxes have different types.

◆ isEmpty()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::isEmpty ( ) const

inlinenoexcept

Checks if it is an empty BoxND.

◆ isSquare()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::isSquare ( ) const

inlinenoexcept

◆ iterator()

template<int dim>

BoxIteratorND< dim > amrex::BoxND< dim >::iterator ( ) const

inlinenoexcept

Return a BoxIteratorND that can be used to loop over the IntVects contained by the BoxND.

Box b;
...
for (IntVect iv : b.iterator()) {
    // do operations involving iv
}

◆ ixType()

template<int dim>

__host__ __device__ IndexTypeND< dim > amrex::BoxND< dim >::ixType ( ) const

inlinenoexcept

Return the indexing type.

◆ length() [1/2]

template<int dim>

__host__ __device__ IntVectND< dim > amrex::BoxND< dim >::length ( ) const

inlinenoexcept

Return the length of the BoxND.

◆ length() [2/2]

template<int dim>

__host__ __device__ int amrex::BoxND< dim >::length ( int dir ) const

inlinenoexcept

Return the length of the BoxND in given direction.

◆ length3d()

template<int dim>

__host__ __device__ GpuArray< int, 3 > amrex::BoxND< dim >::length3d ( ) const

inlinenoexcept

Return lengths padded to 3D (missing dims default to 1).

◆ longside() [1/2]

template<int dim>

__host__ __device__ int amrex::BoxND< dim >::longside ( ) const

inlinenoexcept

Return length of longest side. Ignores type.

◆ longside() [2/2]

template<int dim>

__host__ __device__ int amrex::BoxND< dim >::longside ( int & dir ) const

inlinenoexcept

Return length of longest side. dir is modified to give direction with longest side: 0...dim-1. Ignores type.

◆ loVect() [1/2]

template<int dim>

__host__ __device__ const int * amrex::BoxND< dim >::loVect ( ) &&

delete

◆ loVect() [2/2]

template<int dim>

__host__ __device__ const int * amrex::BoxND< dim >::loVect ( ) const &

inlinenoexcept

Return a pointer to the low-end coordinates (useful for Fortran calls).

◆ loVect3d()

template<int dim>

__host__ __device__ GpuArray< int, 3 > amrex::BoxND< dim >::loVect3d ( ) const

inlinenoexcept

Return low-end coordinates padded to 3D (missing dims default to 0).

◆ makeSlab()

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::makeSlab	(	int	direction,
		int	slab_index
	)

inlinenoexcept

Collapse the box to a single slab at coordinate slab_index along direction.

◆ minBox()

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::minBox ( const BoxND< dim > & b )

inlinenoexcept

Modify BoxND to that of the minimum BoxND containing both the original BoxND and the argument. Both Boxes must have identical type.

◆ ndims()

template<int dim>

__host__ static __device__ constexpr std::size_t amrex::BoxND< dim >::ndims ( )

inlinestaticconstexprnoexcept

◆ next()

template<int dim>

__host__ __device__ void amrex::BoxND< dim >::next ( IntVectND< dim > & p ) const

inlinenoexcept

Step through the rectangle. It is a runtime error to give a point not inside rectangle. Iteration may not be efficient.

◆ normalize()

template<int dim>

__host__ __device__ void amrex::BoxND< dim >::normalize ( )

inlinenoexcept

Ensure each dimension has at least one cell or node by expanding empty directions.

◆ numPts()

template<int dim>

__host__ __device__ Long amrex::BoxND< dim >::numPts ( ) const

inlinenoexcept

Return the number of points contained in the BoxND.

◆ ok()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::ok ( ) const

inlinenoexcept

Return true if high bounds are >= low bounds and the index type is valid.

◆ operator!=()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::operator!= ( const BoxND< dim > & b ) const

inlinenoexcept

Return true if Boxes differ (including type).

◆ operator&()

template<int dim>

__host__ __device__ BoxND amrex::BoxND< dim >::operator& ( const BoxND< dim > & rhs ) const

inlinenoexcept

Return BoxND that is intersection of this BoxND and argument. The Boxes MUST be of same type.

◆ operator&=()

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::operator&= ( const BoxND< dim > & rhs )

inlinenoexcept

Intersect this BoxND with its argument. The Boxes MUST be of the same type.

◆ operator+()

template<int dim>

__host__ __device__ BoxND amrex::BoxND< dim >::operator+ ( const IntVectND< dim > & v ) const

inlinenoexcept

Shift BoxND (relative) by given IntVectND<dim>.

◆ operator+=()

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::operator+= ( const IntVectND< dim > & v )

inlinenoexcept

Shift BoxND (relative) by given IntVectND<dim>.

◆ operator-()

template<int dim>

__host__ __device__ BoxND amrex::BoxND< dim >::operator- ( const IntVectND< dim > & v ) const

inlinenoexcept

Shift BoxND (relative) by given IntVectND<dim>.

◆ operator-=()

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::operator-= ( const IntVectND< dim > & v )

inlinenoexcept

Shift BoxND (relative) by given IntVectND<dim>.

◆ operator<()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::operator< ( const BoxND< dim > & rhs ) const

inlinenoexcept

Lexicographic ordering (type, then lower, then upper corners).

◆ operator<=()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::operator<= ( const BoxND< dim > & rhs ) const

inlinenoexcept

Return true if this box is <= rhs in the lexicographic ordering.

◆ operator==()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::operator== ( const BoxND< dim > & b ) const

inlinenoexcept

Return true if Boxes are identical (including type).

◆ operator>()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::operator> ( const BoxND< dim > & rhs ) const

inlinenoexcept

Return true if this box is > rhs in the lexicographic ordering.

◆ operator>=()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::operator>= ( const BoxND< dim > & rhs ) const

inlinenoexcept

Return true if this box is >= rhs in the lexicographic ordering.

◆ operator[]()

template<int dim>

__host__ __device__ int amrex::BoxND< dim >::operator[] ( Orientation face ) const

inlinenoexcept

Return the coordinate normal to the given face.

◆ refine() [1/2]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::refine ( const IntVectND< dim > & ref_ratio )

inlinenoexcept

Refine BoxND by given (positive) refinement ratio. NOTE: if type(dir) = CELL centered: lo <- lo*ratio and hi <- (hi+1)*ratio - 1. NOTE: if type(dir) = NODE centered: lo <- lo*ratio and hi <- hi*ratio.

◆ refine() [2/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::refine ( int ref_ratio )

inlinenoexcept

Refine BoxND by given (positive) refinement ratio. NOTE: if type(dir) = CELL centered: lo <- lo*ratio and hi <- (hi+1)*ratio - 1. NOTE: if type(dir) = NODE centered: lo <- lo*ratio and hi <- hi*ratio.

◆ resize()

template<int dim>

template<int new_dim>

__host__ __device__ BoxND< new_dim > amrex::BoxND< dim >::resize ( ) const

inlinenoexcept

Return a new BoxND of size new_dim by either shrinking or expanding this BoxND.

◆ sameSize()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::sameSize ( const BoxND< dim > & b ) const

inlinenoexcept

Return true is Boxes same size, ie translates of each other,. It is an error if they have different types.

◆ sameType()

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::sameType ( const BoxND< dim > & b ) const

inlinenoexcept

Return true if Boxes have same type.

◆ setBig() [1/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::setBig ( const IntVectND< dim > & bg )

inlinenoexcept

Redefine the big end of the BoxND.

◆ setBig() [2/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::setBig	(	int	dir,
		int	bg_index
	)

inlinenoexcept

Redefine the big end of the BoxND.

◆ setRange()

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::setRange	(	int	dir,
		int	sm_index,
		int	n_cells = `1`
	)

inlinenoexcept

Set the entire range in a given direction, starting at sm_index with length n_cells. NOTE: This will yield an illegal BoxND if n_cells <= 0.

◆ setSmall() [1/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::setSmall ( const IntVectND< dim > & sm )

inlinenoexcept

◆ setSmall() [2/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::setSmall	(	int	dir,
		int	sm_index
	)

inlinenoexcept

Redefine the small end of the BoxND.

◆ setType()

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::setType ( const IndexTypeND< dim > & t )

inlinenoexcept

Set indexing type.

◆ shift() [1/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::shift ( const IntVectND< dim > & iv )

inlinenoexcept

Equivalent to b.shift(0,iv[0]).shift(1,iv[1]) ....

◆ shift() [2/2]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::shift	(	int	dir,
		int	nzones
	)

inlinenoexcept

Shift this BoxND nzones indexing positions in coordinate direction dir.

◆ shiftHalf() [1/2]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::shiftHalf ( const IntVectND< dim > & iv )

inlinenoexcept

Equivalent to b.shiftHalf(0,iv[0]).shiftHalf(1,iv[1]) ...

◆ shiftHalf() [2/2]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::shiftHalf	(	int	dir,
		int	num_halfs
	)

inlinenoexcept

This member shifts the BoxND by "half" indices, thereby converting the BoxND from type CELL to NODE and visa-versa. b.shiftHalf(0,1) shifts b to the right by 1/2 cells. b.shiftHalf(1,-3) shifts b in the -j direction by 3/2 cells. NOTE: If num_halfs is EVEN the shift is num_halfs/2 full zones and hence will not change the type. This is: b.shifthalf(4) == b.shift(2).

◆ shortside() [1/2]

template<int dim>

__host__ __device__ int amrex::BoxND< dim >::shortside ( ) const

inlinenoexcept

Return length of shortest side. Ignores type.

◆ shortside() [2/2]

template<int dim>

__host__ __device__ int amrex::BoxND< dim >::shortside ( int & dir ) const

inlinenoexcept

Return length of shortest side. dir is modified to give direction with shortest side: 0...dim-1. Ignores type.

◆ shrink()

template<int dim>

template<int new_dim>

__host__ __device__ BoxND< new_dim > amrex::BoxND< dim >::shrink ( ) const

inlinenoexcept

Return a new BoxND of dimension new_dim and assigns the first new_dim dimension of this BoxND to it.

◆ size()

template<int dim>

__host__ __device__ IntVectND< dim > amrex::BoxND< dim >::size ( ) const

inlinenoexcept

Return the length of the BoxND.

◆ smallEnd() [1/2]

template<int dim>

__host__ __device__ const IntVectND< dim > & amrex::BoxND< dim >::smallEnd ( ) const &

inlinenoexcept

Return the inclusive lower bound of the box.

◆ smallEnd() [2/2]

template<int dim>

__host__ __device__ int amrex::BoxND< dim >::smallEnd ( int dir ) const &

inlinenoexcept

Return the inclusive lower bound in the given direction.

◆ strictly_contains() [1/4]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::strictly_contains ( const BoxND< dim > & b ) const

inlinenoexcept

Return true if argument is strictly contained within BoxND. It is an error if the Boxes have different types.

◆ strictly_contains() [2/4]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::strictly_contains ( const Dim3 & p ) const

inlinenoexcept

Return true if argument is strictly contained within BoxND.

◆ strictly_contains() [3/4]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::strictly_contains ( const IntVectND< dim > & p ) const

inlinenoexcept

Return true if argument is strictly contained within BoxND.

◆ strictly_contains() [4/4]

template<int dim>

__host__ __device__ bool amrex::BoxND< dim >::strictly_contains	(	int	i,
		int	j,
		int	k
	)		const

inlinenoexcept

Return true if argument is strictly contained within BoxND.

◆ surroundingNodes() [1/3]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::surroundingNodes ( )

inlinenoexcept

Convert to NODE type in all directions.

◆ surroundingNodes() [2/3]

template<int dim>

__host__ __device__ BoxND & amrex::BoxND< dim >::surroundingNodes ( Direction d )

inlinenoexcept

Convert to NODE type in given direction.

◆ surroundingNodes() [3/3]

template<int dim>

__host__ __device__ BoxND< dim > & amrex::BoxND< dim >::surroundingNodes ( int dir )

inlinenoexcept

Convert to NODE type in given direction.

◆ TheUnitBox()

template<int dim>

__host__ static __device__ BoxND amrex::BoxND< dim >::TheUnitBox ( )

inlinestaticnoexcept

This static member function returns a constant reference to an object of type BoxND representing the unit BoxND in dim-dimensional space.

◆ type() [1/2]

template<int dim>

__host__ __device__ IntVectND< dim > amrex::BoxND< dim >::type ( ) const

inlinenoexcept

Return the indexing type.

◆ type() [2/2]

template<int dim>

__host__ __device__ IndexType::CellIndex amrex::BoxND< dim >::type ( int dir ) const

inlinenoexcept

Return the indexing type in the specified direction.

◆ volume()

template<int dim>

__host__ __device__ Long amrex::BoxND< dim >::volume ( ) const

inlinenoexcept

Return the volume, in indexing space, of region enclosed by this BoxND. This is identical to numPts() for CELL centered BoxND; otherwise, numPts() > volume().

Friends And Related Symbol Documentation

◆ BoxCommHelper

template<int dim>

friend class BoxCommHelper

friend

◆ ParallelDescriptor::Mpi_typemap

template<int dim>

MPI_Datatype ParallelDescriptor::Mpi_typemap ( )

friend

The documentation for this class was generated from the following files:

/home/runner/work/amrex/amrex/Src/Base/AMReX_Array4.H
/home/runner/work/amrex/amrex/Src/Base/AMReX_Box.H

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BoxND() [1/6]

◆ BoxND() [2/6]

◆ BoxND() [3/6]

◆ BoxND() [4/6]

◆ BoxND() [5/6]

◆ BoxND() [6/6]

Member Function Documentation

◆ atOffset()

◆ atOffset3d()

◆ bigEnd() [1/2]

◆ bigEnd() [2/2]

◆ cellCentered()

◆ chop()

◆ coarsen() [1/2]

◆ coarsen() [2/2]

◆ coarsenable() [1/3]

◆ coarsenable() [2/3]

◆ coarsenable() [3/3]

◆ contains() [1/4]

◆ contains() [2/4]

◆ contains() [3/4]

◆ contains() [4/4]

◆ convert() [1/2]

◆ convert() [2/2]

◆ d_numPts()

◆ enclosedCells() [1/3]

◆ enclosedCells() [2/3]

◆ enclosedCells() [3/3]

◆ expand()

◆ grow() [1/5]

◆ grow() [2/5]

◆ grow() [3/5]

◆ grow() [4/5]

◆ grow() [5/5]

◆ growHi() [1/2]

◆ growHi() [2/2]

◆ growLo() [1/2]

◆ growLo() [2/2]

◆ hiVect() [1/2]

◆ hiVect() [2/2]

◆ hiVect3d()

◆ index()

◆ indims()

◆ intersects()

◆ isEmpty()

◆ isSquare()

◆ iterator()

◆ ixType()

◆ length() [1/2]

◆ length() [2/2]

◆ length3d()

◆ longside() [1/2]

◆ longside() [2/2]

◆ loVect() [1/2]

◆ loVect() [2/2]

◆ loVect3d()

◆ makeSlab()

◆ minBox()

◆ ndims()

◆ next()

◆ normalize()

◆ numPts()

◆ ok()

◆ operator!=()

◆ operator&()

◆ operator&=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()