class VoF

VoF-- fundamental computational unit

Inheritance:

public members:

enumVoFType

Constructors, destructors

VoF()

VoF(const VoF & nc)

~VoF()

Query Functions

bool isValid() const

bool isRegular() const

bool isIrregular() const

bool isCovered() const

bool operator== (const VoF & n) const

bool operator!= (const VoF & n) const

bool isConnected( VoF N) const

bool hasLowFaces(int idir) const

bool hasHighFaces(int idir) const

bool hasFaces(int dir, Side::LoHiSide sd) const

Access Functions

Vector < Face > getLowFaces(int dir) const

Vector < Face > getHighFaces(int dir) const

Vector < Face > getFaces(int dir, Side::LoHiSide sd) const

VoFType vofType() const

int irregVoFIndex() const

Real volFrac() const

Real lowArea(int dir) const

Real highArea(int dir) const

Real normal(int dir) const

Real boundaryArea() const

Tuple <Real, SpaceDim > boundaryCentroid() const

Tuple <Real, BL_SPACEDIM > centroid() const

Tuple <Real, BL_SPACEDIM > centroidXArea() const

Vector < Tuple <REAL, BL_SPACEDIM > > polygonCoords() const

const EBIndexSpace * ebisPtr() const

IntVect gridIndex() const

Vector < VoF > refine() const

friend Vector < VoF > refine(const VoF & vof, int refine_ratio)

VoF coarsen() const

friend VoF coarsen(const VoF & vof, int coarsen_ratio)

Modification functions

VoF & operator= (const VoF & n)

enum VoFType

the types of VoFs:
Regular: unit volume fraction, has exactly 2*SpaceDim Faces, each of unit area fraction.
Covered: zero volume fraction.
Irregular: any other valid VoF.
Invalid: VoF is incompletely defined. The default when you create a VoF, and used as the out-of-domain VoF of a boundary Face.

VoF ()

default constructor Creates an invalid VoF.

VoF (const VoF & nc)

copy constructor

~VoF ()

default destructor

bool isValid () const

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

bool isRegular () const

isRegular returns true if the vof is regular
Arguments: none
Returns:
true if the vof is a regular vof.
false otherwise.
This:
This object is not modified.

bool isIrregular () const

isIrregular returns true if the vof is irregular
Arguments: none
Returns:
true if the vof is an irregular vof.
false otherwise.
This:
This object is not modified.

bool isCovered () const

isCovered returns true if the vof is covered
Arguments: none
Returns:
true if the vof is a covered vof.
false otherwise.
This:
This object is not modified.

bool operator== (const VoF & n) const

comparison operator returns true if the vofs are equal if the vof is regular, just compare the intvect; if the vof is irregular, compare indices in record. Arguments:
n (not modified) vof with which to compare
Returns:
true if vofs are equal.
false otherwise.
This:
This object is not modified.

bool operator!= (const VoF & n) const

!= operator returns true if the vofs are not equal opposite of == operator

bool isConnected ( VoF N) const

isConnected returns true if the vofs are connected by an face
Arguments:
n (not modified) vof with which to compare
Returns:
true if the vofs are connected by an face.
false otherwise.
This:
This object is not modified.

bool hasLowFaces (int idir) const

hasLowFaces returns true if the vof has any low faces in the indicated direction
Arguments:
dir (not modified) integer direction of face (0, 1, 2)
Returns:
true if the vofs has any low faces in the dir direction.
false otherwise.
This:
This object is not modified.

bool hasHighFaces (int idir) const

hasHighFaces returns true if the vof has any high faces in the indicated direction
Arguments:
dir (not modified) integer direction of face (0, 1, 2)
Returns:
true if the vofs has any high faces in the dir direction.
false otherwise.
This:
This object is not modified.

bool hasFaces (int dir, Side::LoHiSide sd) const

hasFaces returns true if the vof has any faces in the indicated direction and side
Arguments:
dir (not modified): integer direction of face (0, 1, 2)
sd (not modified): hi or lo side.
Returns:
true if the vofs has any faces in the dir direction and sd side.
false otherwise.
This:
This object is not modified.

Vector < Face > getLowFaces (int dir) const

gets the low Faces of the VoF in the specified direction.
Arguments:
dir (not modified): direction perpendicular to the Faces you want.
Returns:
Vector of low Faces in the specified direction.
This:
The object is not modified.

Vector < Face > getHighFaces (int dir) const

gets the high Faces of the VoF in the specified direction.
Arguments:
dir (not modified): direction perpendicular to the Faces you want.
Returns:
Vector of high Faces in the specified direction.
This:
The object is not modified.

Vector < Face > getFaces (int dir, Side::LoHiSide sd) const

gets the Faces of the VoF in the specified direction and side.
Arguments:
dir (not modified): direction perpendicular to the Faces you want.
sd (not modified): side of the Faces you want.
Returns:
Vector of Faces in the specified direction.
This:
The object is not modified.

VoFType vofType () const

vofType returns type of vof
Arguments: none
Returns:
the vof type of the vof This:
This object is not modified.

int irregVoFIndex () const

irregVoFIndex returns the integer index of the EBIS vector of irregular vofs.
Arguments: none
Returns:
returns the integer index of the EBIS vector of irregular vofs.
If the vof is covered or regular, the vof is not explictly stored and this routine returns -1; This:
This object is not modified.

Real volFrac () const

volfrac returning volume fraction of this vof
Arguments: none
Returns:
volume fraction of the vof
This:
This object is not modified.

Real lowArea (int dir) const

lowArea returns the sum of the high areas of the vof (there can be multiple vofs border a cell on a side)
Arguments:
dir (not modified) direction in which to look (0 1 or 2)
Returns:
if vofs type is irregular, returns, sum of the area at the low side of the vof
if vofs type is regular, returns 1.0
if vofs type is covered, returns 0.0
This:
This object is not modified.

Real highArea (int dir) const

highArea returns the sum of the high areas of the vof (there can be multiple vofs border a cell on a side)
Arguments:
dir (not modified) direction in which to look (0 1 or 2)
Returns:
if vofs type is irregular, returns, sum of the area at the high side of the vof
if vofs type is regular, returns 1.0
if vofs type is covered, returns 0.0
This:
This object is not modified.

Real normal (int dir) const

normal returns the normal to the body in a particular direction
Arguments:
dir (not modified) direction in which to look (0 1 or 2)
Returns:
if vofs type is irregular, returns, the normal to the body at the vof
if vofs type is regular, returns 0.0
if vofs type is covered, returns 0.0
This:
This object is not modified.

Real boundaryArea () const

boundaryArea returns the area of the body at the vof
Arguments: none
Returns:
if vofs type is irregular, returns the area of the body at the vof
if vofs type is regular, returns 0.0
if vofs type is covered, returns 0.0
This:
This object is not modified.

Tuple <Real, SpaceDim > boundaryCentroid () const

Returns the centroid of the irregular face of this VoF. Arguments: none
Returns:
if vof type is irregular, returns the centroid of the irregular face of the vof
if vofs type is regular, returns (0.0,0.0,0.0)
if vofs type is covered, returns (0.0,0.0,0.0)
This:
This object is not modified.

Tuple <Real, BL_SPACEDIM > centroid () const

centroid returns the centroid of the vof
Arguments: none
Returns:
if vofs type is irregular, returns the centroid of the body at the vof
if vofs type is regular, returns (0.0,0.0,0.0)
if vofs type is covered, returns (0.0,0.0,0.0)
This:
This object is not modified.

Tuple <Real, BL_SPACEDIM > centroidXArea () const

centroidxarea returns the centroid * area of the vof
Arguments: none
Returns:
if vofs type is irregular, returns the centroid x area of the body at the vof
if vofs type is regular, returns (0.0,0.0,0.0)
if vofs type is covered, returns (0.0,0.0,0.0)
This:
This object is not modified.

Vector < Tuple <REAL, BL_SPACEDIM > > polygonCoords () const

polygonCoords returns the coordinates of every point of the polygon
Arguments: none
Returns:
if the vof is irregular, returns a vector of coordinates of the polygon
if vofs type is regular, returns a vector of (0.0,0.0,0.0)
if vofs type is covered, returns a vector of (0.0,0.0,0.0)
This:
This object is not modified.

const EBIndexSpace * ebisPtr () const

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

IntVect gridIndex () const

gridIndex returns the intvect of the vof
Arguments: none
Returns:
returns the intvect of the vof
This:
This object is not modified.

Vector < VoF > refine () const

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

friend Vector < VoF > refine (const VoF & vof, int refine_ratio)

Returns the corresponding set of VoFs 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 VoF.
Arguments:
vof (not modified): the VoF 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 VoFs. Vector is empty if there are no finer VoFs.

VoF coarsen () const

Returns the corresponding VoF from the next coarser EBIndexSpace. It is an error to coarsen a Covered or Invalid VoF.

Arguments: none
Returns:
Coarser VoF. Its type is VoF::Invalid if there is no coarser VoF.
This: This object is not modified.

friend VoF coarsen (const VoF & vof, int coarsen_ratio)

Returns the corresponding VoF 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 VoF. It is an error to coarsen a Covered or Invalid VoF.
Arguments:
vof (not modified): the VoF to coarsen.
coarsen_ratio (not modified): the factor by which to coarsen. The only legal values are 1, 2 and 4.
Returns:
Coarser VoF. Its type is VoF::Invalid if there is no coarser VoF.

VoF & operator= (const VoF & n)

assignment operator
sets the vof equal to the input vof
Arguments:
n (not modified) the input vof
Returns:
a reference to the input vof for chaining
This:
--The object is modified! (set equal to the input vof)---

this class has no child classes.

this page has been generated automatically by doc++