DataTransferKit - Multiphysics Solution Transfer Services  2.0
Public Member Functions | List of all members
DataTransferKit::STKMeshEntitySet Class Reference

STK mesh entity set. More...

#include <DTK_STKMeshEntitySet.hpp>

Inheritance diagram for DataTransferKit::STKMeshEntitySet:
DataTransferKit::EntitySet

Public Member Functions

 STKMeshEntitySet (const Teuchos::RCP< stk::mesh::BulkData > &bulk_data)
 Constructor. 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) const override
 Get a iterator of the given entity type that satisfy the given predicate. More...
 
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 topological dimension 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

STK mesh entity set.

Entity set implementation for STK.

Definition at line 68 of file DTK_STKMeshEntitySet.hpp.

Constructor & Destructor Documentation

DataTransferKit::STKMeshEntitySet::STKMeshEntitySet ( const Teuchos::RCP< stk::mesh::BulkData > &  bulk_data)

Constructor.

Definition at line 60 of file DTK_STKMeshEntitySet.cpp.

Member Function Documentation

Teuchos::RCP< const Teuchos::Comm< int > > DataTransferKit::STKMeshEntitySet::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 69 of file DTK_STKMeshEntitySet.cpp.

int DataTransferKit::STKMeshEntitySet::physicalDimension ( ) const
overridevirtual

Geometric data functions.

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

Returns
The physical dimension of the set.

Implements DataTransferKit::EntitySet.

Definition at line 76 of file DTK_STKMeshEntitySet.cpp.

void DataTransferKit::STKMeshEntitySet::getEntity ( const EntityId  entity_id,
const int  topological_dimension,
Entity entity 
) const
overridevirtual

Entity access functions.

Given an EntityId, get the entity.

Parameters
entity_idGet the entity with this id.
topological_dimensionGet the entity with this topological dimension.
entityThe entity with the given id.

Implements DataTransferKit::EntitySet.

Definition at line 83 of file DTK_STKMeshEntitySet.cpp.

EntityIterator DataTransferKit::STKMeshEntitySet::entityIterator ( const int  topological_dimension,
const PredicateFunction predicate 
) const
overridevirtual

Get a iterator of the given entity type that satisfy the given predicate.

Parameters
topological_dimensionThe topological dimension of entity to get an iterator for.
predicateThe selection predicate.
Returns
A iterator of entities of the given type.

Implements DataTransferKit::EntitySet.

Definition at line 98 of file DTK_STKMeshEntitySet.cpp.

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

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

Implements DataTransferKit::EntitySet.

Definition at line 115 of file DTK_STKMeshEntitySet.cpp.


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