Sundance::CellPredicateBase Class Reference

Inheritance diagram for Sundance::CellPredicateBase:

Playa::Handleable< CellPredicateBase > Sundance::Noncopyable Sundance::ObjectWithClassVerbosity< CellPredicateBase > Playa::ObjectWithVerbosity Sundance::BoundaryCellPredicate Sundance::CellCurvePredicate Sundance::GIDCellPredicate Sundance::LabelCellPredicate Sundance::PositionalCellPredicate Sundance::CoordinateValueCellPredicate Sundance::PointCellPredicate

List of all members.

Public Member Functions

 CellPredicateBase ()
virtual ~CellPredicateBase ()
virtual void testBatch (const Array< int > &cellLID, Array< int > &results) const =0
virtual void setMesh (const Mesh &mesh, int cellDim) const
virtual XMLObject toXML () const =0
virtual bool lessThan (const CellPredicateBase *other) const =0
virtual std::string description () const =0
virtual std::string typeName () const

Protected Member Functions

const Meshmesh () const
int cellDim () const

Private Attributes

Mesh mesh_
int cellDim_

Detailed Description

CellPredicateBase is the base class for predicate objects that test cells against some condition. A simulation developer needing some specialized method for identifying cells might implement a custom cell predicate by extending this function. However, the most common cases, selection by cell label or cell position, have already been implemented in LabelCellPredicate and PositionalCellPredicate.

Definition at line 59 of file SundanceCellPredicateBase.hpp.

Constructor & Destructor Documentation

CellPredicateBase::CellPredicateBase (  ) 

Empty ctor

Definition at line 38 of file SundanceCellPredicateBase.cpp.

CellPredicateBase::~CellPredicateBase (  )  [virtual]

virtual dtor

Definition at line 43 of file SundanceCellPredicateBase.cpp.

Member Function Documentation

int Sundance::CellPredicateBase::cellDim (  )  const [inline, protected]

virtual std::string Sundance::CellPredicateBase::description (  )  const [pure virtual]

virtual bool Sundance::CellPredicateBase::lessThan ( const CellPredicateBase other  )  const [pure virtual]

const Mesh& Sundance::CellPredicateBase::mesh (  )  const [inline, protected]

virtual void Sundance::CellPredicateBase::setMesh ( const Mesh mesh,
int  cellDim 
) const [inline, virtual]

Set the current mesh and dimension on which cells are to be tested

Definition at line 77 of file SundanceCellPredicateBase.hpp.

References cellDim_, and mesh_.

virtual void Sundance::CellPredicateBase::testBatch ( const Array< int > &  cellLID,
Array< int > &  results 
) const [pure virtual]

virtual XMLObject Sundance::CellPredicateBase::toXML (  )  const [pure virtual]

virtual std::string Sundance::CellPredicateBase::typeName (  )  const [inline, virtual]

Definition at line 91 of file SundanceCellPredicateBase.hpp.

Member Data Documentation

int Sundance::CellPredicateBase::cellDim_ [mutable, private]

Reimplemented in Sundance::GIDCellPredicate.

Definition at line 104 of file SundanceCellPredicateBase.hpp.

Referenced by cellDim(), and setMesh().

Definition at line 102 of file SundanceCellPredicateBase.hpp.

Referenced by mesh(), and setMesh().

Site Contact