class FaceSet

Set of irregular Faces

Inheritance:


public members:

friend classFaceIterator<FaceSet>

Constructors, destructor and define
FaceSet()
FaceSet(const EBIndexSpace * Isp, int dirin)
~FaceSet()
void define(const EBIndexSpace * Isp, int dirin)

Modification functions
void addFace( Face Ed)

Documentation

An FaceSet is a collection of Faces of an EBIndexSpace. All the Faces must have the same spatial orientation, but there is no other restriction on the relationship they must have to each other.

There are no access functions. The Faces are accessed through FaceIterator<FaceSet>. The FaceIteratorType of all FaceSet's Faces is always EIType::Interior.

friend class FaceIterator<FaceSet>

FaceSet has no direct access functions. The contents of an FaceSet are accessed through an iterator class.

FaceSet ()

Default constructor. Constructs an uninitialized FaceSet. You must subsequently call define before using this FaceSet.

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

FaceSet (const EBIndexSpace * Isp, int dirin)

Defining constructor. Specifies the EBIndexSpace that the Faces inhabit, and the spatial orientation of the Faces.

After this constructor, Faces may be added with addFace.

Arguments:
Isp (not modified): pointer to the EBIndexSpace
dirin (not modified): the spatial orientation of the Faces.
Returns: none
This:
----- This object is modified. -----

~FaceSet ()

Destructor. Destroys internal data.

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

void define (const EBIndexSpace * Isp, int dirin)

Define this FaceSet. Specifies the EBIndexSpace that the Faces inhabit, and the spatial orientation of the Faces.

After define returns, Faces may be added with addFace.

Arguments:
Isp (not modified): pointer to the EBIndexSpace
dirin (not modified): the spatial orientation of the Faces.
Returns: none
This:
----- This object is modified. -----

void addFace ( Face Ed)

Add an Face to this FaceSet. It is an error if the Face is not in this FaceSet's same EBIndexSpace, or if the Face does not have the correct spatial orientation.

Arguments:
Ed (not modified): the Face to add
Returns: none
This:
----- This object is modified. -----


this class has no child classes.

alphabetic index hierarchy of classes


this page has been generated automatically by doc++