Sundance::CellPredicateBase Class Reference

CellPredicateBase is the base class for predicate objects that test cells against some condition. More...

Inheritance diagram for Sundance::CellPredicateBase:

List of all members.

Public Member Functions
	CellPredicateBase ()
	Empty ctor.
virtual	~CellPredicateBase ()
	virtual dtor
virtual void	testBatch (const Array< int > &cellLID, Array< int > &results) const =0
	Test the predicate on a batch of cells.
virtual void	setMesh (const Mesh &mesh, int cellDim) const
	Set the current mesh and dimension on which cells are to be tested.
virtual XMLObject	toXML () const =0
	Write to XML.
virtual bool	lessThan (const CellPredicateBase *other) const =0
virtual std::string	description () const =0
virtual std::string	typeName () const
Protected Member Functions
const Mesh &	mesh () 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]

Definition at line 99 of file SundanceCellPredicateBase.hpp.

References cellDim_.

Referenced by setMesh(), Sundance::PositionalCellPredicate::testBatch(), Sundance::LabelCellPredicate::testBatch(), Sundance::CellCurvePredicate::testBatch(), and Sundance::BoundaryCellPredicate::testBatch().

virtual std::string Sundance::CellPredicateBase::description

(

)

const [pure virtual]

Implemented in Sundance::BoundaryCellPredicate, Sundance::CellCurvePredicate, Sundance::GIDCellPredicate, Sundance::LabelCellPredicate, and Sundance::PositionalCellPredicate.

virtual bool Sundance::CellPredicateBase::lessThan

(

const CellPredicateBase *

other

)

const [pure virtual]

Implemented in Sundance::BoundaryCellPredicate, Sundance::CellCurvePredicate, Sundance::GIDCellPredicate, Sundance::LabelCellPredicate, and Sundance::PositionalCellPredicate.

const Mesh& Sundance::CellPredicateBase::mesh

(

)

const [inline, protected]

Definition at line 95 of file SundanceCellPredicateBase.hpp.

References mesh_.

Referenced by setMesh(), Sundance::PositionalCellPredicate::testBatch(), Sundance::LabelCellPredicate::testBatch(), Sundance::GIDCellPredicate::testBatch(), Sundance::CellCurvePredicate::testBatch(), and Sundance::BoundaryCellPredicate::testBatch().

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(), cellDim_, mesh(), and mesh_.

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

Test the predicate on a batch of cells.

Implemented in Sundance::BoundaryCellPredicate, Sundance::CellCurvePredicate, Sundance::GIDCellPredicate, Sundance::LabelCellPredicate, and Sundance::PositionalCellPredicate.

Referenced by Sundance::SubsetCellFilter::internalGetCells().

virtual XMLObject Sundance::CellPredicateBase::toXML

(

)

const [pure virtual]

Write to XML.

Implemented in Sundance::BoundaryCellPredicate, Sundance::CellCurvePredicate, Sundance::GIDCellPredicate, Sundance::LabelCellPredicate, and Sundance::PositionalCellPredicate.

Referenced by Sundance::PositionalCellPredicate::lessThan(), Sundance::LabelCellPredicate::lessThan(), Sundance::GIDCellPredicate::lessThan(), Sundance::CellCurvePredicate::lessThan(), and Sundance::BoundaryCellPredicate::lessThan().

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().

Mesh Sundance::CellPredicateBase::mesh_ [mutable, private]

Definition at line 102 of file SundanceCellPredicateBase.hpp.

Referenced by mesh(), and setMesh().