class IrregGeom

Irregular domain for embedded boundaries

Inheritance:

public members:

Constructors, Destructor, and defines

IrregGeom()

IrregGeom(const IntVectSet & IVS, const EBIndexSpace * Isp, int depth)

void define(const IntVectSet & IVS, const EBIndexSpace * Isp, int depth)

IrregGeom(const EBIndexSpace * Isp, const Box & BoundingBox,int Depth)

~IrregGeom()

void clear()

void define(const EBIndexSpace * Isp, const Box & BoundingBox, int Depth)

Modification functions

void addVoFs( IntVect Iv)

void close()

Access functions

Vector < VoF > getVoFs( IntVect Iv) const

const EBIndexSpace * ebisPtr() const

Box box() const

Inquiry functions

bool isInitialized() const

bool isClosed() const

int vofSize() const

int faceSize(int dir) const

bool contains(const IntVect & iv) const

bool contains(const VoF & vof) const

bool contains(const Face & face) const

IrregGeom ()

Default constructor. Builds an uninitialized IrregGeom. VoFs may not be added until define has been called.

Arguments: none
Returns: none
This:
----- This object is modified. -----

IrregGeom (const IntVectSet & IVS, const EBIndexSpace * Isp, int depth)

IVS, EBIS constructor. Builds an irreggeom from an ebis and an IVS. All vofs in every cell of IVS are added

Returns: none
This:
----- This object is modified. -----

void define (const IntVectSet & IVS, const EBIndexSpace * Isp, int depth)

IVS, EBIS define. Builds an irreggeom from an ebis and an IVS. All vofs in every cell of IVS are added

Returns: none
This:
----- This object is modified. -----

IrregGeom (const EBIndexSpace * Isp, const Box & BoundingBox,int Depth)

Defining constructor. Initializes this IrregGeom with an EBIndexSpace, a bounding box, and a depth for the Quad/Octree representation.

After this constructor, vofs may be added to the IrregGeom.

Arguments:
Isp (not modified): pointer to the EBIndexSpace
BoundingBox (not modified): the bounding box
Depth (not modified): the depth of the Quad/Octree representation
Returns: none
This:
----- This object is modified. -----

~IrregGeom ()

Destructor. Destroys internal data.

Arguments: none
Returns: none
This:
----- This object is modified. -----

void clear ()

Reset internal data as if this IrregGeom were newly constructed. You may call define again on it.
Arguments: none
Returns: none
This:
----- This object is modified. -----

void define (const EBIndexSpace * Isp, const Box & BoundingBox, int Depth)

Define this IrregGeom. Initializes this IrregGeom with an EBIndexSpace, a bounding box, and a depth for the Quad/Octree representation.

After define returns, VoFs may be added to this IrregGeom.

This function may not be called after close.

Arguments:
Isp (not modified): pointer to the EBIndexSpace
BoundingBox (not modified): the bounding box
Depth (not modified): the depth of the Quad/Octree representation
Returns: none
This:
----- This object is modified. -----

void addVoFs ( IntVect Iv)

Add data to this IrregGeom. All VoFs in the specified cell are added to this IrregGeom. All Faces that border those VoFs are added to this IrregGeom.

This function may not be called before define (or the full constructor) or after close.

Arguments:
Iv (not modified): the grid location of the cell to add.
Returns: none
This:
----- This object is modified. -----

void close ()

Perform closing operations. This is called after all VoFs have been added, and forbids further modification of this IrregGeom.

After close returns, define and addVoFs may not be called.

Arguments: none
Returns: none
This:
----- This object is modified. -----

Vector < VoF > getVoFs ( IntVect Iv) const

Return the VoFs in a specified cell. If there are no VoFs in the cell, the Vector is empty.

Arguments:
Iv (not modified): the grid location of the cell.
Returns:
Vector of all vofs in the specified cell.
This:
The object is not modified.

const EBIndexSpace * ebisPtr () const

Return a pointer to the underlying EBIndexSpace of this IrregGeom.

Arguments: none
Returns:
pointer to the EBIndexSpace
This:
This object is not modified.

Box box () const

Return the bounding box of this IrregGeom.

Arguments: none
Returns:
the bounding box
This:
This object is not modified.

bool isInitialized () const

is this IrregGeom initialized?

bool isClosed () const

is this IrregGeom closed?

int vofSize () const

Number of VoFs.

int faceSize (int dir) const

Number of Faces.

bool contains (const IntVect & iv) const

Does this IrregGeom contain the specified cell?

Arguments:
iv (not modified): the grid location of the cell
Returns:
true if the cell is contained in this IrregGeom, false otherwise
This:
This object is not modified.

bool contains (const VoF & vof) const

Does this IrregGeom contain the specified vof?

Arguments:
vof (not modified): the VoF
Returns:
true if the VoF is contained in this IrregGeom, false otherwise
This:
This object is not modified.

bool contains (const Face & face) const

Does this IrregGeom contain this face?

Arguments:
face (not modified): the Face
Returns:
true if the Face is contained in this IrregGeom, false otherwise
This:
This object is not modified.

this class has no child classes.

this page has been generated automatically by doc++