class VoFSet

Set of irregular VoFs

Inheritance:


public members:

friend classVoFIterator<VoFSet>

Constructors, destructor and define
VoFSet()
VoFSet(const EBIndexSpace * Isp)
~VoFSet()
void define(const EBIndexSpace * Isp)

Access functions
int size() const

Modification functions
void addVoF( VoF Nd)

Documentation

A VoFSet is a collection of VoFs of an EBIndexSpace. There is no restriction on the relationship the VoFs must have to each other. In particular, if multiple VoFs inhabit the same cell, some of them may be in the VoFSet and others may not. This is in constrast to the VoFs of an IrregGeom.

There are no access functions. The VoFs are accessed through VoFIterator<VoFSet>.

friend class VoFIterator<VoFSet>

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

VoFSet ()

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

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

VoFSet (const EBIndexSpace * Isp)

Defining constructor. Specifies the EBIndexSpace that the VoFs inhabit.

After this constructor, VoFs may be added with addVoF.

Arguments:
Isp (not modified): pointer to the EBIndexSpace
Returns: none
This:
----- This object is modified. -----

~VoFSet ()

Destructor. Destroys internal data.

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

void define (const EBIndexSpace * Isp)

Define this VoFSet. Specifies the EBIndexSpace that the VoFs inhabit.

After define returns, VoFs may be added with addVoF.

Arguments:
Isp (not modified): pointer to the EBIndexSpace
Returns: none
This:
----- This object is modified. -----

int size () const

Return the number of VoFs.

void addVoF ( VoF Nd)

Add a VoF to this VoFSet. It is an error if the VoF is not in this VoFSet's EBIndexSpace.

Arguments:
Nd (not modified): the VoF 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++