Sundance::CellSet Class Reference

CellSet is, you guessed it, a set of cells in a mesh. More...

Inheritance diagram for Sundance::CellSet:

Playa::Handle< CellSetBase >

List of all members.

Public Member Functions

 CellSet ()
 Empty ctor.
 CellSet (Handleable< CellSetBase > *rawPtr)
 Construct a CellSet with a raw pointer to a CellSetBase.
 CellSet (const RefCountPtr< CellSetBase > &smartPtr)
 Construct a CellSet with a smart pointer to a CellSetBase.
 CellSet (const Mesh &mesh, int cellDim, const CellType &cellType, const Set< int > &cellLIDs)
 Construct from an explicit set of cells.
int meshID () const
 The ID number of the mesh in which these cells exist.
const Meshmesh () const
 The mesh in which these cells exist.
bool isNull () const
 Indicate whether the cells in this set are null cells.
int dimension () const
 The dimension of the cells contained in this set.
const CellTypecellType () const
 The type of the cells contained in this set.
CellIterator begin () const
 An iterator pointing to the beginning of the set.
CellIterator end () const
 An iterator pointing to the end of the set.
CellSet setUnion (const CellSet &other) const
 Return a cell set that is the union of this set and another set.
CellSet setIntersection (const CellSet &other) const
 Return a cell set that is the intersection of this set and another set.
CellSet setDifference (const CellSet &other) const
 Return a cell set that is the difference of this set and another set.
CellSet subset (const RCP< CellPredicate > &test) const
bool areFacetsOf (const CellSet &other) const
 Determine whether all cells in this set are facets of cells in the other set.
bool operator< (const CellSet &other) const
int numCells () const

Private Member Functions

void checkCompatibility (const std::string &op, const CellSet &other) const


Detailed Description

CellSet is, you guessed it, a set of cells in a mesh.

Cells are represented by their LID relative to the mesh.

See also:
CellFilter, CellIterator

Definition at line 51 of file SundanceCellSet.hpp.


Constructor & Destructor Documentation

Sundance::CellSet::CellSet (  )  [inline]

Empty ctor.

Definition at line 55 of file SundanceCellSet.hpp.

Sundance::CellSet::CellSet ( Handleable< CellSetBase > *  rawPtr  )  [inline]

Construct a CellSet with a raw pointer to a CellSetBase.

Definition at line 55 of file SundanceCellSet.hpp.

Sundance::CellSet::CellSet ( const RefCountPtr< CellSetBase > &  smartPtr  )  [inline]

Construct a CellSet with a smart pointer to a CellSetBase.

Definition at line 55 of file SundanceCellSet.hpp.

CellSet::CellSet ( const Mesh mesh,
int  cellDim,
const CellType cellType,
const Set< int > &  cellLIDs 
)

Construct from an explicit set of cells.

Definition at line 46 of file SundanceCellSet.cpp.


Member Function Documentation

bool CellSet::areFacetsOf ( const CellSet other  )  const

Determine whether all cells in this set are facets of cells in the other set.

Definition at line 133 of file SundanceCellSet.cpp.

References begin(), cellType(), dimension(), end(), Sundance::Mesh::getCofacets(), mesh(), Sundance::Set< Key, Compare >::put(), and setIntersection().

Referenced by Sundance::DOFMapBuilder::reduceCellFilters().

CellIterator Sundance::CellSet::begin (  )  const [inline]

const CellType& Sundance::CellSet::cellType (  )  const [inline]

The type of the cells contained in this set.

Definition at line 76 of file SundanceCellSet.hpp.

References Playa::Handle< CellSetBase >::ptr().

Referenced by areFacetsOf(), checkCompatibility(), setDifference(), setIntersection(), and setUnion().

void CellSet::checkCompatibility ( const std::string &  op,
const CellSet other 
) const [private]

int Sundance::CellSet::dimension (  )  const [inline]

The dimension of the cells contained in this set.

Definition at line 73 of file SundanceCellSet.hpp.

References Playa::Handle< CellSetBase >::ptr().

Referenced by areFacetsOf(), checkCompatibility(), Sundance::connectedNodeSet(), setDifference(), setIntersection(), and setUnion().

CellIterator Sundance::CellSet::end (  )  const [inline]

bool Sundance::CellSet::isNull (  )  const [inline]

Indicate whether the cells in this set are null cells.

Definition at line 70 of file SundanceCellSet.hpp.

References Playa::Handle< CellSetBase >::ptr().

Referenced by setDifference(), setIntersection(), and setUnion().

const Mesh& Sundance::CellSet::mesh (  )  const [inline]

The mesh in which these cells exist.

Definition at line 67 of file SundanceCellSet.hpp.

References Playa::Handle< CellSetBase >::ptr().

Referenced by areFacetsOf(), setDifference(), setIntersection(), and setUnion().

int Sundance::CellSet::meshID (  )  const [inline]

The ID number of the mesh in which these cells exist.

Definition at line 64 of file SundanceCellSet.hpp.

References Playa::Handle< CellSetBase >::ptr().

Referenced by checkCompatibility().

int CellSet::numCells (  )  const

Definition at line 168 of file SundanceCellSet.cpp.

References begin(), and end().

Referenced by Sundance::DOFMapBuilder::isWholeDomain().

bool CellSet::operator< ( const CellSet other  )  const

CellSet CellSet::setDifference ( const CellSet other  )  const

CellSet CellSet::setIntersection ( const CellSet other  )  const

Return a cell set that is the intersection of this set and another set.

Definition at line 69 of file SundanceCellSet.cpp.

References Sundance::Set< Key, Compare >::begin(), begin(), Sundance::ExplicitCellSet::cells(), cellType(), checkCompatibility(), dimension(), end(), isNull(), and mesh().

Referenced by areFacetsOf(), and Sundance::CellFilter::isSubsetOf().

CellSet CellSet::setUnion ( const CellSet other  )  const

Return a cell set that is the union of this set and another set.

Definition at line 52 of file SundanceCellSet.cpp.

References Sundance::Set< Key, Compare >::begin(), begin(), Sundance::ExplicitCellSet::cells(), cellType(), checkCompatibility(), dimension(), end(), isNull(), and mesh().

CellSet Sundance::CellSet::subset ( const RCP< CellPredicate > &  test  )  const

Site Contact