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

STKMesh entity interface definition. More...

#include <DTK_STKMeshEntity.hpp>

Inheritance diagram for DataTransferKit::STKMeshEntity:
DataTransferKit::Entity

Public Member Functions

 STKMeshEntity (const stk::mesh::Entity &stk_entity, const Teuchos::Ptr< stk::mesh::BulkData > &bulk_data)
 Constructor. More...
 
- Public Member Functions inherited from DataTransferKit::Entity
 Entity ()
 Constructor. More...
 
 Entity (const Entity &rhs)
 Copy constructor. More...
 
Entityoperator= (const Entity &rhs)
 Copy assignment operator. More...
 
 Entity (Entity &&rhs)
 Move constructor. More...
 
Entityoperator= (Entity &&rhs)
 Move assignment operator. More...
 
virtual ~Entity ()
 Destructor. More...
 
EntityId id () const
 Client interface. More...
 
int ownerRank () const
 Get the parallel rank that owns the entity. More...
 
int topologicalDimension () const
 Return the topological dimension of the entity. More...
 
int physicalDimension () const
 Return the physical dimension of the entity. More...
 
void boundingBox (Teuchos::Tuple< double, 6 > &bounds) const
 Return the Cartesian bounding box around an entity. More...
 
bool inBlock (const int block_id) const
 Determine if an entity is in the block with the given id. More...
 
bool onBoundary (const int boundary_id) const
 Determine if an entity is on the boundary with the given id. More...
 
Teuchos::RCP< EntityExtraDataextraData () const
 Get the extra data on the entity. This is a convenient helper for implementing the other interfaces. More...
 
std::string description () const override
 Teuchos::Describable interface. More...
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verb_level=Teuchos::Describable::verbLevel_default) const override
 Provide a verbose description of the object. More...
 

Detailed Description

STKMesh entity interface definition.

Definition at line 60 of file DTK_STKMeshEntity.hpp.

Constructor & Destructor Documentation

DataTransferKit::STKMeshEntity::STKMeshEntity ( const stk::mesh::Entity &  stk_entity,
const Teuchos::Ptr< stk::mesh::BulkData > &  bulk_data 
)

Constructor.

Parameters
stk_entityThe entity to wrap this interface around.
bulk_dataA pointer to the bulk data. We will store a copy of this pointer but not reference count it. We do this because we will create many copies of this pointer and do not want to incur the reference counting overhead. We will always make sure that the pointer is in scope both inside and outside of this class while this class exists.

Definition at line 48 of file DTK_STKMeshEntity.cpp.


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