Basic implementation of the entity set interface. More...

#include <DTK_BasicEntitySet.hpp>

Inheritance diagram for DataTransferKit::BasicEntitySet:

Public Types

typedef std::pair< EntityId, Entity >	EntityIdPair
	Entity map typedefs. More...

Public Member Functions
	BasicEntitySet (const Teuchos::RCP< const Teuchos::Comm< int >> comm, const int physical_dimension)
	Constructor. More...

void	addEntity (const Entity &entity)
	Add an entity to the set. More...


Teuchos::RCP< const Teuchos::Comm< int > >	communicator () const override
	Parallel functions. More...


int	physicalDimension () const override
	Geometric data functions. More...


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

EntityIterator	entityIterator (const int topological_dimension, const PredicateFunction &predicate=EntitySet::selectAll) const override
	Get an iterator over a subset of the entity set that satisfies the given predicate. More...

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

Public Member Functions inherited from DataTransferKit::EntitySet
	EntitySet ()
	Constructor. More...

virtual	~EntitySet ()
	Destructor. 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 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...

Additional Inherited Members
Static Public Member Functions inherited from DataTransferKit::EntitySet
static bool	selectAll (Entity)
	Select all entities predicate. More...

Detailed Description

Basic implementation of the entity set interface.

Definition at line 124 of file DTK_BasicEntitySet.hpp.

Member Typedef Documentation

typedef std::pair<EntityId, Entity> DataTransferKit::BasicEntitySet::EntityIdPair

Entity map typedefs.

Definition at line 129 of file DTK_BasicEntitySet.hpp.

Constructor & Destructor Documentation

DataTransferKit::BasicEntitySet::BasicEntitySet	(	const Teuchos::RCP< const Teuchos::Comm< int >>	comm,
		const int	physical_dimension
	)

Constructor.

Definition at line 185 of file DTK_BasicEntitySet.cpp.

Member Function Documentation

void DataTransferKit::BasicEntitySet::addEntity ( const Entity & entity )

Add an entity to the set.

Definition at line 196 of file DTK_BasicEntitySet.cpp.

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

overridevirtual

Parallel functions.

Get the parallel communicator for the entity set.

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

Implements DataTransferKit::EntitySet.

Definition at line 203 of file DTK_BasicEntitySet.cpp.

int DataTransferKit::BasicEntitySet::physicalDimension ( ) const

overridevirtual

Geometric data functions.

Return the physical dimension of the entities in the set.

Returns: The physical dimension of the set.

Implements DataTransferKit::EntitySet.

Definition at line 210 of file DTK_BasicEntitySet.cpp.

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

overridevirtual

Entity access functions.

Given an EntityId, 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.

Implements DataTransferKit::EntitySet.

Definition at line 214 of file DTK_BasicEntitySet.cpp.

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

overridevirtual

Get an iterator over a subset of the entity set that satisfies the given predicate.

Parameters

topological_dimension	The topological dimension of entity to get an iterator for.
predicate	A predicate to select the entity set to iterate over.

Returns: An iterator to the entities that satisfy the predicate.

Implements DataTransferKit::EntitySet.

Definition at line 226 of file DTK_BasicEntitySet.cpp.

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

overridevirtual

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

Implements DataTransferKit::EntitySet.

Definition at line 237 of file DTK_BasicEntitySet.cpp.

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation