DataTransferKit::EntityImpl Class Reference

Geometric entity implementation definition. More...

#include <DTK_EntityImpl.hpp>

Inheritance diagram for DataTransferKit::EntityImpl:

Public Member Functions
	EntityImpl ()
	Constructor. More...
virtual	~EntityImpl ()
	Destructor. More...
virtual EntityId	id () const =0
	Get the unique global identifier for the entity. More...
virtual int	ownerRank () const =0
	Get the parallel rank that owns the entity. More...
virtual int	topologicalDimension () const =0
	Return the topological dimension of the entity. More...
virtual int	physicalDimension () const =0
	Return the physical dimension of the entity. More...
virtual void	boundingBox (Teuchos::Tuple< double, 6 > &bounds) const =0
	Return the Cartesian bounding box around an entity. More...
virtual bool	inBlock (const int block_id) const =0
	Determine if an entity is in the block with the given id. More...
virtual bool	onBoundary (const int boundary_id) const =0
	Determine if an entity is on the boundary with the given id. More...
virtual Teuchos::RCP< EntityExtraData >	extraData () const
	Get the extra data on the entity. More...
virtual std::string	description () const
	Provide a one line description of the object. More...
virtual void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel) const
	Provide a verbose description of the object. More...

Detailed Description

Geometric entity implementation definition.

Definition at line 58 of file DTK_EntityImpl.hpp.

Constructor & Destructor Documentation

DataTransferKit::EntityImpl::EntityImpl ( )

inline

Constructor.

Definition at line 64 of file DTK_EntityImpl.hpp.

virtual DataTransferKit::EntityImpl::~EntityImpl ( )

inlinevirtual

Destructor.

Definition at line 69 of file DTK_EntityImpl.hpp.

Member Function Documentation

virtual EntityId DataTransferKit::EntityImpl::id ( ) const

pure virtual

Get the unique global identifier for the entity.

Returns

A unique global identifier for the entity.

Implemented in DataTransferKit::BasicGeometryEntityImpl, DataTransferKit::BoxGeometryImpl, DataTransferKit::CylinderGeometryImpl, and DataTransferKit::STKMeshEntityImpl.

virtual int DataTransferKit::EntityImpl::ownerRank ( ) const

pure virtual

Get the parallel rank that owns the entity.

Returns

The parallel rank that owns the entity.

Implemented in DataTransferKit::BasicGeometryEntityImpl, DataTransferKit::BoxGeometryImpl, DataTransferKit::CylinderGeometryImpl, and DataTransferKit::STKMeshEntityImpl.

virtual int DataTransferKit::EntityImpl::topologicalDimension ( ) const

pure virtual

Return the topological dimension of the entity.

Returns

The topological dimension of the entity. Any parametric coordinates describing the entity will be of this dimension.

Implemented in DataTransferKit::BasicGeometryEntityImpl, DataTransferKit::STKMeshEntityImpl, DataTransferKit::BoxGeometryImpl, and DataTransferKit::CylinderGeometryImpl.

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

pure virtual

Return the physical dimension of the entity.

Returns

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

Implemented in DataTransferKit::BasicGeometryEntityImpl, DataTransferKit::STKMeshEntityImpl, DataTransferKit::BoxGeometryImpl, and DataTransferKit::CylinderGeometryImpl.

virtual void DataTransferKit::EntityImpl::boundingBox ( Teuchos::Tuple< double, 6 > &  bounds ) const

pure virtual

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).

Implemented in DataTransferKit::BasicGeometryEntityImpl, DataTransferKit::STKMeshEntityImpl, DataTransferKit::BoxGeometryImpl, and DataTransferKit::CylinderGeometryImpl.

virtual bool DataTransferKit::EntityImpl::inBlock ( const int  block_id ) const

pure virtual

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

Implemented in DataTransferKit::BasicGeometryEntityImpl, DataTransferKit::STKMeshEntityImpl, DataTransferKit::BoxGeometryImpl, and DataTransferKit::CylinderGeometryImpl.

virtual bool DataTransferKit::EntityImpl::onBoundary ( const int  boundary_id ) const

pure virtual

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

Implemented in DataTransferKit::BasicGeometryEntityImpl, DataTransferKit::STKMeshEntityImpl, DataTransferKit::BoxGeometryImpl, and DataTransferKit::CylinderGeometryImpl.

virtual Teuchos::RCP<EntityExtraData> DataTransferKit::EntityImpl::extraData ( ) const

inlinevirtual

Get the extra data on the entity.

Reimplemented in DataTransferKit::BasicGeometryEntityImpl, and DataTransferKit::STKMeshEntityImpl.

Definition at line 122 of file DTK_EntityImpl.hpp.

virtual std::string DataTransferKit::EntityImpl::description ( ) const

inlinevirtual

Provide a one line description of the object.

Reimplemented in DataTransferKit::BasicGeometryEntityImpl, DataTransferKit::STKMeshEntityImpl, DataTransferKit::BoxGeometryImpl, and DataTransferKit::CylinderGeometryImpl.

Definition at line 130 of file DTK_EntityImpl.hpp.

virtual void DataTransferKit::EntityImpl::describe ( Teuchos::FancyOStream &  out, const Teuchos::EVerbosityLevel    ) const

inlinevirtual

Provide a verbose description of the object.

Reimplemented in DataTransferKit::BasicGeometryEntityImpl, DataTransferKit::STKMeshEntityImpl, DataTransferKit::BoxGeometryImpl, and DataTransferKit::CylinderGeometryImpl.

Definition at line 138 of file DTK_EntityImpl.hpp.

---

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

• DTK_EntityImpl.hpp