SpatialOps
SpatialOps::BoundaryCellInfo Class Reference

Provides information about boundary cells for various fields. More...

#include <BoundaryCellInfo.h>

Public Member Functions

BoundaryCellInfooperator= (const BoundaryCellInfo &bc)
 assignment operator
 
 BoundaryCellInfo (const BoundaryCellInfo &bc)
 copy constructor
 
bool has_bc (const int dir, const BCSide side) const
 query to see if a physical boundary is present in the given direction (0=x, 1=y, 2=z) and the specified side.
 
IntVec has_bc (const BCSide side) const
 obtain an IntVec indicating the presence of physical boundaries on the (+) faces
 
int num_extra (const int dir) const
 obtain the number of extra cells potentially present on this field due to presence of physical boundaries More...
 
IntVec num_extra () const
 obtain the number of extra cells present on this field due to presence of physical boundaries. If no physical boundary is present, this returns zero.
 
int has_extra (const int dir) const
 obtain the number of extra cells actually present on this field due to presence of physical boundaries More...
 
IntVec has_extra () const
 obtain the number of extra cells actually present on this field due to presence of physical boundaries
 
BoundaryCellInfo limit_by_extent (const IntVec &extent) const
 limit extra cells to dimensions with extents > 1
 
bool operator== (const BoundaryCellInfo &other) const
 compare for equality
 

Static Public Member Functions

template<typename FieldT >
static BoundaryCellInfo build (const bool bcmx, const bool bcpx, const bool bcmy, const bool bcpy, const bool bcmz, const bool bcpz)
 obtain a BoundaryCellInfo object for the requested field type More...
 
template<typename FieldT >
static BoundaryCellInfo build (const IntVec &bcm, const IntVec &bcp)
 obtain a BoundaryCellInfo object for the requested field type More...
 
template<typename FieldT >
static BoundaryCellInfo build ()
 obtain a BoundaryCellInfo object for the requested field type, assuming that there is no physical boundary present on the (+) faces. More...
 

Detailed Description

Provides information about boundary cells for various fields.

Date
Jul 10, 2013
Author
"James C. Sutherland"

Definition at line 46 of file BoundaryCellInfo.h.

Member Function Documentation

◆ build() [1/3]

template<typename FieldT >
static BoundaryCellInfo SpatialOps::BoundaryCellInfo::build ( const bool  bcmx,
const bool  bcpx,
const bool  bcmy,
const bool  bcpy,
const bool  bcmz,
const bool  bcpz 
)
inlinestatic

obtain a BoundaryCellInfo object for the requested field type

Parameters
bcmxtrue if a physical boundary is present on the (-x) face
bcpxtrue if a physical boundary is present on the (+x) face
bcmytrue if a physical boundary is present on the (-y) face
bcpytrue if a physical boundary is present on the (+y) face
bcmztrue if a physical boundary is present on the (-z) face
bcpztrue if a physical boundary is present on the (+z) face
Returns
the constructed BoundaryCellInfo object

Definition at line 79 of file BoundaryCellInfo.h.

◆ build() [2/3]

template<typename FieldT >
static BoundaryCellInfo SpatialOps::BoundaryCellInfo::build ( const IntVec bcm,
const IntVec bcp 
)
inlinestatic

obtain a BoundaryCellInfo object for the requested field type

Parameters
bcmindicates if a physical boundary is present on each of the (-) faces
bcpindicates if a physical boundary is present on each of the (+) faces
Returns
the constructed BoundaryCellInfo object

Definition at line 94 of file BoundaryCellInfo.h.

◆ build() [3/3]

template<typename FieldT >
static BoundaryCellInfo SpatialOps::BoundaryCellInfo::build ( )
inlinestatic

obtain a BoundaryCellInfo object for the requested field type, assuming that there is no physical boundary present on the (+) faces.

Returns
the constructed BoundaryCellInfo object

Definition at line 105 of file BoundaryCellInfo.h.

◆ has_extra()

int SpatialOps::BoundaryCellInfo::has_extra ( const int  dir) const
inline

obtain the number of extra cells actually present on this field due to presence of physical boundaries

Parameters
dirthe direction of interest (0=x, 1=y, 2=z)

Definition at line 151 of file BoundaryCellInfo.h.

References has_bc(), num_extra(), and SpatialOps::PLUS_SIDE.

Here is the call graph for this function:

◆ num_extra()

int SpatialOps::BoundaryCellInfo::num_extra ( const int  dir) const
inline

obtain the number of extra cells potentially present on this field due to presence of physical boundaries

Parameters
dirthe direction of interest (0=x, 1=y, 2=z)

Definition at line 140 of file BoundaryCellInfo.h.

Referenced by SpatialOps::SpatialField< SpatialOps::SingleValue, T >::SpatialField().

Here is the caller graph for this function:

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