Geometric entity set interface definition. More...

#include <DTK_EntitySet.hpp>

Inheritance diagram for DataTransferKit::EntitySet:

Public Member Functions
	EntitySet ()
	Constructor. More...

virtual	~EntitySet ()
	Destructor. More...


virtual Teuchos::RCP< const Teuchos::Comm< int > >	communicator () const =0
	Parallel functions. More...


virtual int	physicalDimension () const =0
	Geometric data functions. More...

virtual void	localBoundingBox (Teuchos::Tuple< double, 6 > &bounds) const
	Get the local bounding box of entities of the set. More...

virtual void	globalBoundingBox (Teuchos::Tuple< double, 6 > &bounds) const
	Get the global bounding box of entities of the set. More...


virtual void	getEntity (const EntityId entity_id, const int topological_dimension, Entity &entity) const =0
	Entity access functions. More...

virtual EntityIterator	entityIterator (const int topological_dimension, const PredicateFunction &predicate=selectAll) const =0
	Get an iterator of the given entity type that satisfies the given predicate. More...

virtual void	getAdjacentEntities (const Entity &entity, const int adjacent_dimension, Teuchos::Array< Entity > &adjacent_entities) const =0
	Given an entity, get the entities of the given type that are adjacent to it. More...


virtual std::string	description () const override
	Teuchos::Describable interface. More...

virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verb_level=Teuchos::Describable::verbLevel_default) const override
	Provide a verbose description of the object. More...

Static Public Member Functions
static bool	selectAll (Entity)
	Select all entities predicate. More...

Detailed Description

Geometric entity set interface definition.

An entity set is a coherent collection of geometric entities with a parallel distribution.

Definition at line 67 of file DTK_EntitySet.hpp.

Constructor & Destructor Documentation

DataTransferKit::EntitySet::EntitySet ( )

Constructor.

Definition at line 51 of file DTK_EntitySet.cpp.

DataTransferKit::EntitySet::~EntitySet ( )

virtual

Destructor.

Definition at line 55 of file DTK_EntitySet.cpp.

Member Function Documentation

virtual Teuchos::RCP<const Teuchos::Comm<int> > DataTransferKit::EntitySet::communicator ( ) const

pure virtual

Parallel functions.

Get the parallel communicator for the entity set.

Returns: A reference-counted pointer to the parallel communicator.

Implemented in DataTransferKit::BasicEntitySet, and DataTransferKit::STKMeshEntitySet.

virtual int DataTransferKit::EntitySet::physicalDimension ( ) const

pure virtual

Geometric data functions.

Return the largest physical dimension of the entities in the set.

Returns: The physical dimension of the set.

Implemented in DataTransferKit::BasicEntitySet, and DataTransferKit::STKMeshEntitySet.

void DataTransferKit::EntitySet::localBoundingBox ( Teuchos::Tuple< double, 6 > & bounds ) const

virtual

Get the local bounding box of entities of the set.

Returns: A Cartesian box the bounds all local entities in the set.

Definition at line 60 of file DTK_EntitySet.cpp.

void DataTransferKit::EntitySet::globalBoundingBox ( Teuchos::Tuple< double, 6 > & bounds ) const

virtual

Get the global bounding box of entities of the set.

Requires global communication: a single all-reduce call

Returns: A Cartesian box the bounds all global entities in the set.

Definition at line 91 of file DTK_EntitySet.cpp.

virtual void DataTransferKit::EntitySet::getEntity	(	const EntityId	entity_id,
		const int	topological_dimension,
		Entity &	entity
	)		const

pure virtual

Entity access functions.

Given an EntityId and topological dimension, get the entity.

Parameters

entity_id	Get the entity with this id.
topological_dimension	Get the entity with this topological dimension.
entity	The entity with the given id.

Implemented in DataTransferKit::BasicEntitySet, and DataTransferKit::STKMeshEntitySet.

virtual EntityIterator DataTransferKit::EntitySet::entityIterator	(	const int	topological_dimension,
		const PredicateFunction &	predicate = `selectAll`
	)		const

pure virtual

Get an iterator of the given entity type that satisfies the given predicate.

Parameters

topological_dimension	The topological dimension of entity to get an iterator for.
predicate	The selection predicate.

Returns: A iterator of entities of the given type.

Implemented in DataTransferKit::BasicEntitySet, and DataTransferKit::STKMeshEntitySet.

virtual void DataTransferKit::EntitySet::getAdjacentEntities	(	const Entity &	entity,
		const int	adjacent_dimension,
		Teuchos::Array< Entity > &	adjacent_entities
	)		const

pure virtual

Given an entity, get the entities of the given type that are adjacent to it.

Parameters

entity	Get the adjacencies of this entity.
adjacent_dimension	Get adjacencies of this topological dimension.

Implemented in DataTransferKit::BasicEntitySet, and DataTransferKit::STKMeshEntitySet.

std::string DataTransferKit::EntitySet::description ( ) const

overridevirtual

Teuchos::Describable interface.

Provide a one line description of the object.

Definition at line 112 of file DTK_EntitySet.cpp.

void DataTransferKit::EntitySet::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verb_level = `Teuchos::Describable::verbLevel_default`
	)		const

overridevirtual

Provide a verbose description of the object.

Definition at line 119 of file DTK_EntitySet.cpp.

static bool DataTransferKit::EntitySet::selectAll ( Entity )

inlinestatic

Select all entities predicate.

Definition at line 181 of file DTK_EntitySet.hpp.

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation