class Face

Face --- a connection between two vofs

Inheritance:

public members:

enumFaceType

enumFaceLocationType

enumFaceBoundaryType

Constructors, destructors

Face()

Face(const Face & ec)

~Face()

Access Functions

const VoF & lowVoF() const

const VoF & highVoF() const

IntVect gridIndex() const

Real areaFrac() const

Tuple <REAL, BL_SPACEDIM > centroid() const

FaceType faceType() const

int direction() const

int faceEBIndex() const

const EBIndexSpace * ebisPtr() const

Vector < Face > refine() const

friend Vector < Face > refine(const Face & face, int refine_ratio)

Face coarsen() const

friend Face coarsen(const Face & face, int coarsen_ratio)

Query Functions

bool isValid() const

bool isRegular() const

bool isIrregular() const

bool isCovered() const

bool isLoBoundary() const

bool isHiBoundary() const

bool isBoundary() const

bool isLoOuter() const

bool isHiOuter() const

bool isInterior() const

bool isConnected(const VoF & N)

bool operator== (const Face & e) const

bool operator!= (const Face & e) const

Modification functions

Face & operator= (const Face & e)

enum FaceType

The types of Faces:
Regular: high or low VoF is regular. Area fraction is unity.
Covered: high or low VoF is covered. Area fraction is zero.
Irregular: high and low VoFs are irregular.
Invalid: Face has incomplete information. The default when you create an Face.

enum FaceLocationType

enum to tell where the Face is in relation to the irregular VoFs.
Interior: both Irregular
LoOuter: low Regular, high Irregular
HiOuter: low Irregular, high Regular

enum FaceBoundaryType

enum to tell whether an Face is on the physical boundary box.

Face ()

default constructor -- make an invalid face

Face (const Face & ec)

copy constructor

~Face ()

destructor

const VoF & lowVoF () const

return the low VoF of the Face.
This:
the object is not modified.

const VoF & highVoF () const

return the high VoF of the Face.
This:
the object is not modified.

IntVect gridIndex () const

gridIndex returns the intvect of the high vof of the face
this is once again the i-1/2 convention
Arguments: none
Returns:
returns the intvect of the high vof of the face
This:
This object is not modified.

Real areaFrac () const

returns area fraction of the face
Arguments: none
Returns:
if the face is irregular, returns the area fraction
if the face is regular, returns 1.0
if the face is covered, returns 0.0
This:
This object is not modified.

Tuple <REAL, BL_SPACEDIM > centroid () const

centroid return centroid of Face
Arguments: none
Returns:
if the face is irregular, returns the centroid
if the face is regular, returns tuple of zeroes
if the face is covered, returns tuple of zeroes
This:
This object is not modified.

FaceType faceType () const

facetype return type of Face
Arguments: none
Returns:
if either vof is covered returns covered
if either vof is regular, returns regular
else if both vofs are irregular, returns irregular
This:
This object is not modified.

int direction () const

direction returning direction of the face. The direction of an face is the integer coordinate direction (0, 1, ..., d-1) that is perpendicular to the face. Arguments: none
Returns:
the direction of the face. (0, 1, 2)
This:
This object is not modified.

int faceEBIndex () const

faceEBIndex return the integer index where the geometric information of the face is stored in the EBIS. Arguments: none
Returns:
if the face is irregular
the integer index for the vector where the face is stored in the ebis
otherwise returns -1
This:
This object is not modified.

const EBIndexSpace * ebisPtr () const

ebisPtr returns pointer to the associated EBIS
Arguments: none
Returns:
returns pointer to the associated EBIS
This:
This object is not modified.

Vector < Face > refine () const

Returns the corresponding set of Faces from the next finer EBIndexSpace. It is an error to refine a Covered or Invalid Face.
Arguments: none
Returns:
Vector of finer Faces. Vector is empty if there are no finer Faces.
This: This object is not modified.

friend Vector < Face > refine (const Face & face, int refine_ratio)

Returns the corresponding set of Faces from the refined EBIndexSpace. The value of refine_ratio may only be 1, 2 or 4. If a suitably refined EBIndexSpace does not exist, it returns an empty vector. It is an error to refine a Covered or Invalid Face.
Arguments:
face (not modified): the Face to refine
refine_ratio (not modified): the factor by which to refine. The only legal values are 1, 2 and 4.
Returns:
Vector of finer Faces. Vector is empty if there are no finer Faces.

Face coarsen () const

Returns the corresponding Face from the next coarser EBIndexSpace. Faces interior to a cell have no coarse Face. It is an error to coarsen a Covered or Invalid Face.
Arguments: none
Returns:
Coarser Face. Its type is Face::Invalid if there is no coarser Face.
This: This object is not modified.

friend Face coarsen (const Face & face, int coarsen_ratio)

Returns the corresponding Face from the coarsened EBIndexSpace. The value of coarsen_ratio may only be 1, 2 or 4. If a suitably coarsened EBIndexSpace does not exist, it returns an invalid Face. Faces interior to a coarse cell do not have a coarse Face. It is an error to coarsen a Covered or Invalid Face.
Arguments:
face (not modified): the Face to coarsen.
coarsen_ratio (not modified): the factor by which to coarsen. The only legal values are 1, 2 and 4.
Returns:
Coarser Face. Its type is Face::Invalid if there is no coarser Face.

bool isValid () const

isValid returns true if the face has a valid type
Arguments: none
Returns:
returns true if the face has a valid type
returns false otherwise
This:
This object is not modified.

bool isRegular () const

returns true if the face is regular (ie. either vof of the face is regular).
Arguments: none
Returns:
returns true if the face is type regular
This:
This object is not modified.

bool isIrregular () const

isIrregular returns true if the face is irregular (ie. both vofs of the face are irregular).
Arguments: none
Returns:
returns true if the face is type irregular
returns false otherwise
This:
This object is not modified.

bool isCovered () const

isCovered returns true if the face is covered (one vof is covered --- not really an face (zero aperature))
Arguments: none
Returns:
returns true if the face is type covered
returns false otherwise
This:
This object is not modified.

bool isLoBoundary () const

Is theFace on the low boundary of the physical domain.
Returns:
true if the Face's boundary type is LoBoundary.
This:
This object is not modified.

bool isHiBoundary () const

Is theFace on the high boundary of the physical domain.
Returns:
true if the Face's boundary type is HiBoundary.
This:
This object is not modified.

bool isBoundary () const

Is theFace on the boundary of the physical domain.
Returns:
true if the Face's boundary type is HiBoundary or LoBoundary.
This:
This object is not modified. these refer to the EBIS of face

bool isLoOuter () const

Is the Face a low outer Face of its EBIndexSpace.
Returns:
true if the Face's location type is LoOuter.
This:
This object is not modified.

bool isHiOuter () const

Is the Face a high outer Face of its EBIndexSpace.
Returns:
true if the Face's location type is HiOuter.
This:
This object is not modified.

bool isInterior () const

Is the Face an interior Face of its EBIndexSpace.
Returns:
true if the Face's location type is Interior.
This:
This object is not modified.

bool isConnected (const VoF & N)

isConnected returns true if the input vof is part of the face
Arguments:
N (not modified) input vof Returns:
returns true if the input vof is one of the vofs of the face
returns false otherwise
This:
This object is not modified.

bool operator== (const Face & e) const

operator == returns true face is the same as the input face (ie. they are composed of the same vofs.
Arguments:
e (not modified) input face
Returns:
returns true if both vofs of this face are the same as the input face
returns false otherwise
This:
This object is not modified.

bool operator!= (const Face & e) const

operator != opposite of operator ==

Face & operator= (const Face & e)

assignment operator sets this face equal to input face
Arguments:
e (not modified) input face
Returns:
reference to this face for chaining
This:
---------This object is modified.---------

this class has no child classes.

this page has been generated automatically by doc++