#include <source/hierarchy/patches/BoundaryBox.h>
Public Member Functions | |
BoundaryBox () | |
BoundaryBox (const Box< DIM > &box, const int bdry_type, const int location_index) | |
BoundaryBox (const BoundaryBox< DIM > &boundary_box) | |
~BoundaryBox () | |
const Box< DIM > & | getBox () const |
int | getBoundaryType () const |
int | getLocationIndex () const |
void | setIsMultiblockSingularity (bool is_mblk_singularity) |
bool | getIsMultiblockSingularity () const |
BoundaryBox< DIM > & | operator= (const BoundaryBox< DIM > &boundary_box) |
|
The default constructor creates an undefined boundary box, with invalid values. |
|
Create a boundary box from a Box<DIM> and integers that indicate the boundary type and the location index |
|
The copy constructor copies the data of the argument box. |
|
The destructor for BoundaryBox. |
|
Return a reference to the Box<DIM> member of the boundary box |
|
Return the boundary type (codimension) of the boundary box.
* Convention: * =========== * * 1d * -- * 1 = node * * 2d * -- * 1 = edge * 2 = node * * 3d * -- * 1 = face * 2 = edge * 3 = node * |
|
Return the location index for the boundary box. The location index is an integer which indicates the location of the boundary box in relation to the location of the associated patch. That is, the location index tells whether the boundary box is ``above'' or ``below'' the patch in each coordinate direction. The conventions for the location index depend on the dimension of the problem and the boundary type of the BoundaryBox.
* Conventions: * ============ * * 1d * -- * node (codimension 1): * x_lo : 0 * x_hi : 1 * * 2d * -- * edge (codimension 1): * x_lo: 0 * x_hi: 1 * y_lo: 2 * y_hi: 3 * * node (codimension 2): * x_lo, y_lo: 0 * x_hi, y_lo: 1 * x_lo, y_hi: 2 * x_hi, y_hi: 3 * * 3d * -- * * face (codimension 1): * x_lo: 0 * x_hi: 1 * y_lo: 2 * y_hi: 3 * z_lo: 4 * z_hi: 5 * * edge (codimension 2): * y_lo, z_lo: 0 * y_hi, z_lo: 1 * y_lo, z_hi: 2 * y_hi, z_hi: 3 * x_lo, z_lo: 4 * x_lo, z_hi: 5 * x_hi, z_lo: 6 * x_hi, z_hi: 7 * x_lo, y_lo: 8 * x_hi, y_lo: 9 * x_lo, y_hi: 10 * x_hi, y_hi: 11 * * node (codimension 3): * x_lo, y_lo, z_lo: 0 * x_hi, y_lo, z_lo: 1 * x_lo, y_hi, z_lo: 2 * x_hi, y_hi, z_lo: 3 * x_lo, y_lo, z_hi: 4 * x_hi, y_lo, z_hi: 5 * x_lo, y_hi, z_hi: 6 * x_hi, y_hi, z_hi: 7 * * |
|
Set the multiblock singularity flag to the argument value. |
|
Get the value of the multiblock singularity flag. This should always return false when not running a problem on a multiblock domain. |
|
The assignment operator copies all data components. |