DataTransferKit::Entity Class Reference

Geometric entity interface definition. More...

#include <DTK_Entity.hpp>

Inheritance diagram for DataTransferKit::Entity:

Public Member Functions
	Entity ()
	Constructor. More...
	Entity (const Entity &rhs)
	Copy constructor. More...
Entity &	operator= (const Entity &rhs)
	Copy assignment operator. More...
	Entity (Entity &&rhs)
	Move constructor. More...
Entity &	operator= (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< EntityExtraData >	extraData () 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

Geometric entity interface definition.

Definition at line 61 of file DTK_Entity.hpp.

Constructor & Destructor Documentation

DataTransferKit::Entity::Entity

(

)

Constructor.

Definition at line 50 of file DTK_Entity.cpp.

DataTransferKit::Entity::Entity

(

const Entity &

rhs

)

Copy constructor.

Definition at line 54 of file DTK_Entity.cpp.

DataTransferKit::Entity::Entity

(

Entity &&

rhs

)

Move constructor.

Definition at line 66 of file DTK_Entity.cpp.

DataTransferKit::Entity::~Entity ( )

virtual

Destructor.

Definition at line 78 of file DTK_Entity.cpp.

Member Function Documentation

Entity & DataTransferKit::Entity::operator=

(

const Entity &

rhs

)

Copy assignment operator.

Definition at line 58 of file DTK_Entity.cpp.

Entity & DataTransferKit::Entity::operator=

(

Entity &&

rhs

)

Move assignment operator.

Definition at line 70 of file DTK_Entity.cpp.

EntityId DataTransferKit::Entity::id

(

)

const

Client interface.

Get the unique global identifier for the entity. Entities of different topological dimensions may have the same id.

Returns

A unique global identifier for the entity.

Definition at line 82 of file DTK_Entity.cpp.

int DataTransferKit::Entity::ownerRank

(

)

const

Get the parallel rank that owns the entity.

Returns

The parallel rank that owns the entity.

Definition at line 90 of file DTK_Entity.cpp.

int DataTransferKit::Entity::topologicalDimension

(

)

const

Return the topological dimension of the entity.

Returns

The topological dimension of the entity. This is the dimension of the entity reference frame. Any parametric coordinates describing the entity will be of this dimension.

Definition at line 98 of file DTK_Entity.cpp.

int DataTransferKit::Entity::physicalDimension

(

)

const

Return the physical dimension of the entity.

Returns

The physical dimension of the entity. This is the dimension of the entity physical frame. Any physical coordinates describing the entity will be of this dimension.

Definition at line 106 of file DTK_Entity.cpp.

void DataTransferKit::Entity::boundingBox

(

Teuchos::Tuple< double, 6 > &

bounds

)

const

Return the Cartesian bounding box around an entity.

Parameters

bounds

The bounds of the box (x_min,y_min,z_min,x_max,y_max,z_max).

Definition at line 114 of file DTK_Entity.cpp.

bool DataTransferKit::Entity::inBlock

(

const int

block_id

)

const

Determine if an entity is in the block with the given id.

Definition at line 122 of file DTK_Entity.cpp.

bool DataTransferKit::Entity::onBoundary

(

const int

boundary_id

)

const

Determine if an entity is on the boundary with the given id.

Definition at line 130 of file DTK_Entity.cpp.

Teuchos::RCP< EntityExtraData > DataTransferKit::Entity::extraData

(

)

const

Get the extra data on the entity. This is a convenient helper for implementing the other interfaces.

Definition at line 138 of file DTK_Entity.cpp.

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

override

Teuchos::Describable interface.

Provide a one line description of the object.

Definition at line 146 of file DTK_Entity.cpp.

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

override

Provide a verbose description of the object.

Definition at line 158 of file DTK_Entity.cpp.

---

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

• DTK_Entity.hpp
• DTK_Entity.cpp