Box Class Reference
[Chombo]
#include <Box.H>
Detailed Description
A Rectangular Domain on an Integer Lattice.A Box is an abstraction for defining discrete rectangular regions of SpaceDim-dimensioned 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 Box. Boxes can exist in positive and negative indexing space.
Box is a dimension dependent class, so SpaceDim must be defined as either 1, 2, or 3 when compiling.
Public Member Functions | |
| Box () | |
| ~Box () | |
| Box (const IntVect &small, const IntVect &big) | |
| void | define (const IntVect &small, const IntVect &big) |
| Box (const IntVect &small, const int *vec_len) | |
| Box (const IntVect &small, const IntVect &big, const IntVect &typ) | |
| void | define (const IntVect &small, const IntVect &big, const IntVect &typ) |
| Box (const IntVect &small, const IntVect &big, const IndexType &t) | |
| void | define (const IntVect &small, const IntVect &big, const IndexType &t) |
| Box (const Box &b) | |
| void | define (const Box &b) |
| Box | copy () const |
| const IntVect & | smallEnd () const |
| { Accessors} | |
| IntVect | sideEnd (Side::LoHiSide a_side) const |
| int | smallEnd (int dir) const |
| const IntVect & | bigEnd () const |
| int | bigEnd (int dir) const |
| const int * | loVect () const |
| const int * | hiVect () const |
| const int * | getVect () const |
| long | index (const IntVect &v) const |
| IndexType | ixType () const |
| centering | |
| IntVect | type () const |
| IndexType::CellIndex | type (int dir) const |
| IntVect | size () const |
| size functions | |
| int | size (int dir) const |
| bool | numPtsOK () const |
| long | numPts () const |
| bool | volumeOK () const |
| long | volume () const |
| int | longside (int &dir) const |
| int | longside () const |
| int | shortside (int &dir) const |
| int | shortside () const |
| bool | isEmpty () const |
| { Comparison Functions} | |
| bool | ok () const |
| bool | contains (const IntVect &p) const |
| bool | contains (const Box &b) const |
| bool | intersects (const Box &b) const |
| bool | intersectsNotEmpty (const Box &b) const |
| bool | sameSize (const Box &b) const |
| bool | sameType (const Box &b) const |
| bool | operator== (const Box &b) const |
| bool | eq (const Box &b) const |
| bool | operator!= (const Box &b) const |
| bool | neq (const Box &b) const |
| bool | cellCentered () const |
| bool | operator< (const Box &rhs) const |
| bool | lt (const Box &rhs) const |
| Box & | operator= (const Box &b) |
| { Modification Functions} | |
| Box & | setSmall (const IntVect &sm) |
| Box & | setSmall (int dir, int sm_index) |
| Box & | setBig (const IntVect &bg) |
| Box & | setBig (int dir, int bg_index) |
| Box & | setRange (int dir, int sm_index, int n_cells=1) |
| Box & | convert (IndexType typ) |
| centering type conversion functions | |
| Box & | convert (const IntVect &typ) |
| Box & | convert (int dir, IndexType::CellIndex typ) |
| Box & | surroundingNodes () |
| Box & | surroundingNodes (int dir) |
| Box & | surroundingNodes_int (int dir) |
| Box & | enclosedCells () |
| Box & | enclosedCells (int dir) |
| Box & | enclosedCells_int (int dir) |
| Box & | shift (int dir, int nzones) |
| shift functions | |
| Box & | shift (const IntVect &iv) |
| Box & | shift_intvect (const IntVect &iv) |
| Box & | shiftHalf (int dir, int num_halfs) |
| Box & | shiftHalf (const IntVect &iv) |
| Box & | shiftHalf_intvect (const IntVect &iv) |
| Box & | operator+= (const IntVect &v) |
| Box | operator+ (const IntVect &v) const |
| Box & | operator-= (const IntVect &v) |
| Box | operator- (const IntVect &v) const |
| Box | operator & (const Box &) const |
| intersection functions | |
| Box & | operator &= (const Box &) |
| Box & | minBox (const Box &b) |
| Box & | grow (int i) |
| grow functions | |
| Box & | grow (const IntVect &v) |
| Box & | grow (int idir, int n_cell) |
| Box & | growLo (int idir, int n_cell=1) |
| Box & | growDir (int a_idir, const Side::LoHiSide &a_sd, int a_cell) |
| Box & | growHi (int idir, int n_cell=1) |
| Box & | refine (int refinement_ratio) |
| refinement | |
| Box & | refine (const IntVect &refinement_ratio) |
| Box & | coarsen (int refinement_ratio) |
| coarsening | |
| Box & | coarsen (const IntVect &refinement_ratio) |
| void | next (IntVect &) const |
| void | next (IntVect &p, const int *shv) const |
| Box | chop (int dir, int chop_pnt) |
| misc | |
| void | degenerate (Box &a_to, const SliceSpec &a_sliceSpec, bool *a_outofbounds=0) const |
| void | p () const |
| void | dumpOn (std::ostream &strm) const |
| void | computeBoxLen () |
| { Box Constants} | |
| void | computeBoxLenNotEmpty () |
Static Public Member Functions | |
| static void | setTempestOutputFormat (bool) |
Protected Member Functions | |
| bool | numPtsOK (long &N) const |
| bool | volumeOK (long &N) const |
Protected Attributes | |
| IntVect | smallend |
| IntVect | bigend |
| IndexType | btype |
Static Protected Attributes | |
| static bool | s_tempestOutputFormat |
Friends | |
| class | HDF5Handle |
| Box | surroundingNodes (const Box &b, int dir) |
| Box | surroundingNodes (const Box &b) |
| Box | enclosedCells (const Box &b, int dir) |
| Box | enclosedCells (const Box &b) |
| Box | bdryBox (const Box &b, int dir, Side::LoHiSide a_sd, int len) |
| neighbor box functions | |
| Box | bdryLo (const Box &b, int dir, int len) |
| Box | bdryHi (const Box &b, int dir, int len) |
| Box | adjCellLo (const Box &b, int dir, int len) |
| Box | adjCellHi (const Box &b, int dir, int len) |
| Box | adjCellBox (const Box &b, int dir, Side::LoHiSide a_side, int len) |
| Box | minBox (const Box &b1, const Box &b2) |
| Box | grow (const Box &b, int i) |
| Box | grow (const Box &b, const IntVect &v) |
| Box | refine (const Box &b, int refinement_ratio) |
| Box | refine (const Box &b, const IntVect &refinement_ratio) |
| Box | coarsen (const Box &b, int refinement_ratio) |
| Box | coarsen (const Box &b, const IntVect &refinement_ratio) |
| std::ostream & | operator<< (std::ostream &os, const Box &bx) |
| { I/O Functions} | |
| std::istream & | operator>> (std::istream &os, Box &bx) |
Constructor & Destructor Documentation
| Box::Box | ( | ) |
The default constructor. The constructed Box is empty.
Referenced by grow(), grow(), growHi(), growLo(), operator+(), and operator-().
| Box::~Box | ( | ) | [inline] |
The destructor.
Construct cell-centered type Box. It is an error if small is greater than big.
| Box::Box | ( | const IntVect & | small, | |
| const int * | vec_len | |||
| ) |
Construct Box with specified lengths. It is an error if the lengths are negative.
Construct Box with given type. small and big are expected to be consistent with given type. It is an error if small is greater than big.
| Box::Box | ( | const Box & | b | ) | [inline] |
The copy constructor.
Member Function Documentation
Modify cell-centered type Box. It is an error if small is greater than big.
Modify Box with given type. small and big are expected to be consistent with given type. It is an error if small is greater than big.
| void Box::define | ( | const Box & | b | ) |
| Box Box::copy | ( | ) | const [inline] |
| const IntVect & Box::smallEnd | ( | ) | const [inline] |
{ Accessors}
Returns the lower corner of this Box.
References smallend.
Referenced by ProblemDomain::contains(), BaseIF::corners(), BaseIFFAB< T >::define(), ProblemDomain::image(), sideEnd(), and BaseFab< T >::smallEnd().
| IntVect Box::sideEnd | ( | Side::LoHiSide | a_side | ) | const [inline] |
return smallend if side is low, bigend if side is high.
References bigEnd(), Side::Lo, and smallEnd().
| int Box::smallEnd | ( | int | dir | ) | const [inline] |
| const IntVect & Box::bigEnd | ( | ) | const [inline] |
Returns the upper corner of this Box.
References bigend.
Referenced by BaseFab< T >::bigEnd(), ProblemDomain::contains(), BaseIF::corners(), BaseIFFAB< T >::define(), ProblemDomain::image(), and sideEnd().
| int Box::bigEnd | ( | int | dir | ) | const [inline] |
| const int * Box::loVect | ( | ) | const [inline] |
Returns a constant pointer to the array of low end coordinates. Useful for calls to Fortran. It should not be used in any other circumstances.
References IntVect::getVect(), and smallend.
Referenced by BaseFab< T >::loVect().
| const int * Box::hiVect | ( | ) | const [inline] |
Returns a constant pointer the array of high end coordinates. Useful for calls to Fortran. It should not be used in any other circumstances.
References bigend, and IntVect::getVect().
Referenced by BaseFab< T >::hiVect().
| const int * Box::getVect | ( | ) | const [inline] |
Returns a constant pointer to the array of coordinates in the Box. Useful for calls to Fortran, but otherwise too dangerous for use.
References IntVect::getVect(), and smallend.
| long Box::index | ( | const IntVect & | v | ) | const [inline] |
Returns offset of point from smallend; i.e. index(smallend) -> 0, bigend would return volume()-1. Is used in accessing FArrayBox.
References bigend, smallend, and IntVect::vect.
Referenced by BaseFab< T >::getVal(), BaseFab< T >::operator()(), and DenseIntVectSet::operator-=().
| IndexType Box::ixType | ( | ) | const [inline] |
| IntVect Box::type | ( | ) | const [inline] |
Return the indexing type of this Box.
References btype, and IndexType::ixType().
Referenced by ProblemDomain::contains().
| IndexType::CellIndex Box::type | ( | int | dir | ) | const [inline] |
Return the indexing type of this Box in the specified direction. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.
References btype, and IndexType::ixType().
| IntVect Box::size | ( | ) | const [inline] |
size functions
Return an IntVect containing the size of this Box in each coordinate direction.
References bigend, and smallend.
Referenced by ProblemDomain::image(), ProblemDomain::shiftIt(), ProblemDomain::size(), BaseFab< T >::size(), and ProblemDomain::unshiftIt().
| int Box::size | ( | int | dir | ) | const [inline] |
| bool Box::numPtsOK | ( | ) | const [inline] |
Is the number calculated by numPts() representable in a long?
Referenced by volumeOK().
| long Box::numPts | ( | ) | const |
Return the volume, in indexing space, of region enclosed by this Box. This is identical to volume(). Abort()s if the number cannot be represented in a long.\
Referenced by MultiGrid< T >::define(), BaseFab< T >::getVal(), BaseFab< T >::resize(), BaseFab< T >::size(), and MergeSolver< T >::solve().
| bool Box::volumeOK | ( | ) | const [inline] |
Is the number calculated by volume() representable in a long?
References numPtsOK().
| long Box::volume | ( | ) | const |
| int Box::longside | ( | int & | dir | ) | const |
Returns length of the longest side of this Box. The argument dir is modified to give direction with longest side: 0...SpaceDim-1. Ignores type.
| int Box::longside | ( | ) | const |
Returns length of the longest side of this Box. Ignores type.
| int Box::shortside | ( | int & | dir | ) | const |
Returns length of shortest side of this Box. The argument dir is modified to give direction with shortest side: 0...SpaceDim-1. Ignores type.
| int Box::shortside | ( | ) | const |
Returns length of the shortest side of this Box. Ignores type.
| bool Box::isEmpty | ( | ) | const [inline] |
{ Comparison Functions}
Returns true if this Box is empty.
References bigend, and smallend.
Referenced by contains(), convert(), BaseFab< T >::copy(), BaseEBCellFAB< T >::copy(), BaseEBFaceFAB< T >::define(), BaseEBCellFAB< T >::define(), MultilevelLinearOp< T >::dotProduct(), enclosedCells(), grow(), grow(), growHi(), growLo(), ProblemDomain::isEmpty(), operator+(), operator+=(), operator-(), operator-=(), operator<(), BaseEBCellFAB< T >::setVal(), shift(), and surroundingNodes().
| bool Box::ok | ( | ) | const [inline] |
| bool Box::contains | ( | const IntVect & | p | ) | const [inline] |
Returns true if argument is contained within this Box. An empty Box does not contain and is not contained by any Box, including itself.
References bigend, and smallend.
Referenced by BaseEBCellFAB< T >::assign(), BaseFab< T >::contains(), BaseFab< T >::copy(), BaseEBFaceFAB< T >::copy(), BaseEBFaceFAB< T >::define(), BaseEBCellFAB< T >::fill(), MiniIFFAB< T >::getFaceSubset(), ProblemDomain::image(), MiniIVFAB< T >::linearOut(), BaseFab< T >::operator()(), BaseEBFaceFAB< T >::operator()(), BaseEBCellFAB< T >::operator()(), DenseIntVectSet::operator-=(), BaseFab< T >::performCopy(), BaseFab< T >::performSetVal(), and MiniIVFAB< T >::size().
| bool Box::contains | ( | const Box & | b | ) | const [inline] |
| bool Box::intersects | ( | const Box & | b | ) | const |
| bool Box::intersectsNotEmpty | ( | const Box & | b | ) | const |
Returns true if this Box and the argument have non-null intersections. It is an error if the Boxes have different types. This routine does not perform the check to see if *this or b are empty boxes. It is the callers responsibility to ensure that this never happens. If you are unsure, the use the .intersects(..) routine.
| bool Box::sameSize | ( | const Box & | b | ) | const [inline] |
Returns true if this Box and the argument are the same size, ie translates of each other. It is an error if they have different types.
References bigend, sameType(), and smallend.
Referenced by BaseFab< T >::copy(), and BaseFab< T >::performCopy().
| bool Box::sameType | ( | const Box & | b | ) | const [inline] |
Returns true if this Box and the argument have same type.
References btype.
Referenced by contains(), BaseFab< T >::copy(), BaseEBFaceFAB< T >::copy(), BaseEBCellFAB< T >::copy(), and sameSize().
| bool Box::operator== | ( | const Box & | b | ) | const [inline] |
Returns true if this Box and the argument are identical, including type.
References bigend, btype, and smallend.
Referenced by operator!=().
| bool Box::eq | ( | const Box & | b | ) | const |
| bool Box::operator!= | ( | const Box & | b | ) | const [inline] |
Returns true if this Box and the argument differ, including type.
References operator==().
| bool Box::neq | ( | const Box & | b | ) | const |
| bool Box::cellCentered | ( | ) | const [inline] |
Returns true if this Box is cell-centered in all indexing directions.
References IndexType::any(), and btype.
Referenced by BaseEBFaceFAB< T >::copy(), BaseEBFaceFAB< T >::define(), and BaseEBCellFAB< T >::define().
| bool Box::operator< | ( | const Box & | rhs | ) | const [inline] |
Returns true if this Box is lexigraphically less than rhs box. All comparison is based on lower box corner. In the name of coding efficiency, we do not handle the case where two boxes have the same lower left corner. In DEBUG mode, this is checked for with an assert.
References bigend, isEmpty(), IntVect::lexLT(), and smallend.
| bool Box::lt | ( | const Box & | rhs | ) | const |
Redefine the lower corner of this Box. It is an error if the specified corner is greater than the exisiting upper corner of this Box.
References bigend, computeBoxLen(), and smallend.
| Box & Box::setSmall | ( | int | dir, | |
| int | sm_index | |||
| ) | [inline] |
Redefines the lower end of this Box in the specified coordinate direction. It is an error if the specified value is greater than the exisiting upper end of this Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.
References bigend, computeBoxLen(), IntVect::setVal(), and smallend.
Redefines the upper corner of this Box. It is an error if the specified corner is less than the exisiting lower corner of this Box.
References bigend, computeBoxLen(), and smallend.
| Box & Box::setBig | ( | int | dir, | |
| int | bg_index | |||
| ) | [inline] |
Redefines the upper end of this Box in the specified coordinate direction. It is an error if the specified value is less than the exisiting lower end of this Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.
References bigend, computeBoxLen(), IntVect::setVal(), and smallend.
| Box & Box::setRange | ( | int | dir, | |
| int | sm_index, | |||
| int | n_cells = 1 | |||
| ) | [inline] |
Set the entire range in a given direction, starting at sm_index with length n_cells. It is an error if n_cells <= 0.
References bigend, computeBoxLen(), IntVect::setVal(), and smallend.
centering type conversion functions
Modifies this Box by converting from the current type into the argument type. This may change the Box 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.
Referenced by operator+(), and operator-().
Modifies this Box by converting from the current type into the argument type. This may change the Box 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. It is an error if typ is not convertible to an IndexType.
References bigend, btype, computeBoxLen(), isEmpty(), IndexType::ixType(), IntVect::Unit, and IntVect::Zero.
| Box& Box::convert | ( | int | dir, | |
| IndexType::CellIndex | typ | |||
| ) |
Modifies this Box by converting from the current type into the argument type. This may change the Box 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. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.
| Box& Box::surroundingNodes | ( | ) |
Modifies this Box by converting it to NODE type in all directions. This increases all components of the upper corner by one. The Empty Box is not modified by this function except for changing of type.
Referenced by ProblemDomain::contains(), and surroundingNodes().
| Box & Box::surroundingNodes | ( | int | dir | ) | [inline] |
Modifies this Box by converting it to NODE type in given direction. This increases the component of the upper corner in the given direction by one. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.
References bigend, btype, computeBoxLen(), isEmpty(), IndexType::set(), and IntVect::shift().
| Box& Box::surroundingNodes_int | ( | int | dir | ) |
| Box& Box::enclosedCells | ( | ) |
Modifies this Box by converting it to CELL type in all directions. This decreases all components of the upper corner by one. The Empty Box is not modified by this function except for changing of type.
Referenced by ProblemDomain::contains(), and enclosedCells().
| Box & Box::enclosedCells | ( | int | dir | ) | [inline] |
Modifies this Box by converting it to CELL type in given direction. This decreases the component of the upper corner in the given direction by one. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.
References bigend, btype, computeBoxLen(), isEmpty(), IntVect::shift(), and IndexType::unset().
| Box& Box::enclosedCells_int | ( | int | dir | ) |
| Box & Box::shift | ( | int | dir, | |
| int | nzones | |||
| ) | [inline] |
shift functions
Modifies this Box by shifting it nzones indexing positions in coordinate direction dir. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function.
References bigend, isEmpty(), IntVect::shift(), and smallend.
Referenced by ProblemDomain::shift(), DenseIntVectSet::shift(), BaseFab< T >::shift(), ProblemDomain::shiftIt(), and ProblemDomain::unshiftIt().
| Box& Box::shiftHalf | ( | int | dir, | |
| int | num_halfs | |||
| ) |
This member modifies this Box by shifting by "half" indices, thereby converting the Box from type CELL to NODE or vice-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). Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.
Referenced by BaseFab< T >::shiftHalf().
Modifies this Box to that of the minimum Box containing both this Box and the argument Box. Both Boxes must have identical type.
Referenced by MergeSolver< T >::solve().
| Box & Box::grow | ( | int | i | ) | [inline] |
grow functions
Modifies this Box by growing it in all directions by given amount. The Empty Box is not modified by this function. NOTE: n_cell negative shrinks the Box by that number of cells. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box.
References bigend, Box(), btype, computeBoxLen(), IntVect::diagShift(), isEmpty(), and smallend.
Referenced by BoxLayoutData< T >::allocateGhostVector(), BaseEBFaceFAB< T >::define(), EBAMRPoissonOp::getFlux(), and ProblemDomain::grow().
Modifies this Box by growing it in each direction by specified amount. The Empty Box is not modified by this function. NOTE: components of iv may be negative, which would shrink this Box. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box.
References bigend, Box(), btype, computeBoxLen(), isEmpty(), and smallend.
| Box & Box::grow | ( | int | idir, | |
| int | n_cell | |||
| ) | [inline] |
Modifies this Box by growing it on the low and high end by n_cell cells in direction idir. The Empty Box is not modified by this function. NOTE: n_cell negative shrinks this Box by that number of cells. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.
References bigend, Box(), btype, computeBoxLen(), isEmpty(), IntVect::shift(), and smallend.
| Box & Box::growLo | ( | int | idir, | |
| int | n_cell = 1 | |||
| ) | [inline] |
Modifies this Box by growing it on the low end by n_cell cells in direction idir. The Empty Box is not modified by this function. NOTE: n_cell negative shrinks this Box by that number of cells. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.
References bigend, Box(), btype, computeBoxLen(), isEmpty(), IntVect::shift(), and smallend.
Referenced by growDir(), and ProblemDomain::growLo().
| Box & Box::growDir | ( | int | a_idir, | |
| const Side::LoHiSide & | a_sd, | |||
| int | a_cell | |||
| ) | [inline] |
| Box & Box::growHi | ( | int | idir, | |
| int | n_cell = 1 | |||
| ) | [inline] |
Modifies this Box by growing it on the high end by n_cell cells in direction idir. The Empty Box is not modified by this function. NOTE: n_cell negative shrinks the Box by that number of cells. If shrinking produces an empty Box, the Box is transformed into the canonical Empty Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.
References bigend, Box(), btype, computeBoxLen(), isEmpty(), IntVect::shift(), and smallend.
Referenced by growDir(), and ProblemDomain::growHi().
| Box& Box::refine | ( | int | refinement_ratio | ) |
| Box& Box::coarsen | ( | int | refinement_ratio | ) |
coarsening
Modifies this Box by coarsening it by given (positive) refinement ratio. The Empty Box is not modified by this function. \
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 Box must contain the original Box.
Referenced by MultilevelLinearOp< T >::dotProduct().
Modifies this Box by coarsening by given (positive) refinement ratio. The Empty Box is not modified by this function. \
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 Box must contain the original Box.
| void Box::next | ( | IntVect & | ) | const |
| void Box::next | ( | IntVect & | p, | |
| const int * | shv | |||
| ) | const |
| Box Box::chop | ( | int | dir, | |
| int | chop_pnt | |||
| ) |
misc
Chops the Box at the chop_pnt in the dir direction returns one Box, modifies the object Box. The union of the two is the original Box. The modified Box is the low end, the returned Box is the high end. If type(dir) = CELL, the Boxes are disjoint with the chop_pnt included in the high end (new Box). It is an ERROR if chop_pnt is the low end of the orig Box. 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 Box. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim.
Makes a_to a box that's the same as *this except that it's just one cell thick in the a_sliceSpec.direction-th direction, and its (one) coordinate in that direction is a_sliceSpec.position.
If a_sliceSpec.position is outside the range of *this, and a_outofbounds isn't null, then we set *a_outofbounds to true, otherwise to false.
It would be more natural to return a Box, than to set the value of a Box reference, but we do it this way to be consistent with BaseFab::degenerate() where we can't return an object because of the policy of disallowing copy constructors for heavyweight classes.
Referenced by BaseFab< T >::degenerate().
| void Box::p | ( | ) | const |
print to pout()
| void Box::dumpOn | ( | std::ostream & | strm | ) | const |
Gives more detail than printOn. Useful for exiting due to an error.
| void Box::computeBoxLen | ( | ) | [inline] |
{ Box Constants}
This is a canonical empty Box of cell-centered type.
Referenced by convert(), enclosedCells(), grow(), growHi(), growLo(), setBig(), setRange(), setSmall(), and surroundingNodes().
| void Box::computeBoxLenNotEmpty | ( | ) | [inline] |
| static void Box::setTempestOutputFormat | ( | bool | ) | [static] |
Doesn't print the IndexType, and uses square outer brackets.
| bool Box::numPtsOK | ( | long & | N | ) | const [protected] |
| bool Box::volumeOK | ( | long & | N | ) | const [protected] |
Friends And Related Function Documentation
friend class HDF5Handle [friend] |
Returns a Box with NODE based coordinates in direction dir that encloses the argument Box. NOTE: equivalent to b.convert(dir,NODE). NOTE: error if b.type(dir) == NODE. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.
Returns a Box with CELL based coordinates in direction dir that is enclosed by argument Box. NOTE: equivalent to b.convert(dir,CELL). NOTE: error if b.type(dir) == CELL. Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The Empty Box is not modified by this function except for changing of type.
| Box bdryBox | ( | const Box & | b, | |
| int | dir, | |||
| Side::LoHiSide | a_sd, | |||
| int | len | |||
| ) | [friend] |
neighbor box functions
Returns the cell centered Box of the given length adjacent to the argument Box on the low end along the given coordinate direction. The return Box is identical to the argument Box in the other directions. The return Box and the argument Box have an empty intersection. \
NOTE: len != 0. A negative length results in cells _inside_ the original box. \
NOTE: Box retval = adjCellLo(b,dir,len) is equivalent to the following set of operations: \
Box retval(b); \
retval.convert(dir,Box::CELL); \
retval.setrange(dir,retval.smallEnd(dir)-len,len); \
Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The neighbor of an Empty Box is an Empty Box of the appropriate type.
Returns the cell centered Box of the given length adjacent to the argument Box on the high end along the given coordinate direction. The return Box is identical to the argument Box in the other directions. The return Box and the argument Box have an empty intersection. \
NOTE: len != 0. A Negative length results in cells _inside_ the original box. \
NOTE: Box retval = adjCellHi(b,dir,len) is equivalent to the following set of operations: \
Box retval(b); \
retval.convert(dir,Box::CELL); \
retval.setrange(dir,retval.bigEnd(dir)+1,len);\
Directions are zero-based. It is an error if not 0 <= dir < SpaceDim. The neighbor of an Empty Box is an Empty Box of the appropriate type.
| Box adjCellBox | ( | const Box & | b, | |
| int | dir, | |||
| Side::LoHiSide | a_side, | |||
| int | len | |||
| ) | [friend] |
Returns a Box that is the argument Box coarsened by given (positive) refinement ratio. The Empty Box is not modified by this function. \
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 Box must contain the original Box.
Returns a Box that is the argument Box coarsened by given (positive) refinement ratio. The Empty Box is not modified by this function. \
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 Box must contain the original Box.
| std::ostream& operator<< | ( | std::ostream & | os, | |
| const Box & | bx | |||
| ) | [friend] |
{ I/O Functions}
Write an ASCII representation to the ostream.
| std::istream& operator>> | ( | std::istream & | os, | |
| Box & | bx | |||
| ) | [friend] |
Read from istream.
Member Data Documentation
IntVect Box::smallend [protected] |
Referenced by contains(), getVect(), grow(), grow(), growHi(), growLo(), index(), isEmpty(), loVect(), ok(), operator+(), operator+=(), operator-(), operator-=(), operator<(), operator=(), operator==(), sameSize(), setBig(), setRange(), setSmall(), shift(), size(), and smallEnd().
IntVect Box::bigend [protected] |
Referenced by bigEnd(), contains(), convert(), enclosedCells(), grow(), grow(), growHi(), growLo(), hiVect(), index(), isEmpty(), ok(), operator+(), operator+=(), operator-(), operator-=(), operator<(), operator=(), operator==(), sameSize(), setBig(), setRange(), setSmall(), shift(), size(), and surroundingNodes().
IndexType Box::btype [protected] |
Referenced by cellCentered(), convert(), enclosedCells(), grow(), grow(), growHi(), growLo(), ixType(), operator+(), operator-(), operator=(), operator==(), sameType(), surroundingNodes(), and type().
bool Box::s_tempestOutputFormat [static, protected] |
The documentation for this class was generated from the following file:
