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
 query to see if a physical boundary is present in the given direction (0=x, 1=y, 2=z)
 
IntVec has_bc () 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 bcx, const bool bcy, const bool bcz)
 obtain a BoundaryCellInfo object for the requested field type More...
 
template<typename FieldT >
static BoundaryCellInfo build (const IntVec &bc)
 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 45 of file BoundaryCellInfo.h.

Member Function Documentation

◆ build() [1/3]

template<typename FieldT >
static BoundaryCellInfo SpatialOps::BoundaryCellInfo::build ( const bool  bcx,
const bool  bcy,
const bool  bcz 
)
inlinestatic

obtain a BoundaryCellInfo object for the requested field type

Parameters
bcxtrue if a physical boundary is present on the (+x) face
bcytrue if a physical boundary is present on the (+y) face
bcztrue if a physical boundary is present on the (+z) face
Returns
the constructed BoundaryCellInfo object

Definition at line 76 of file BoundaryCellInfo.h.

◆ build() [2/3]

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

obtain a BoundaryCellInfo object for the requested field type

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

Definition at line 87 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 98 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 143 of file BoundaryCellInfo.h.

References has_bc(), and num_extra().

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 132 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: