DataTransferKit - Multiphysics Solution Transfer Services  2.0
List of all members
DataTransferKit::BasicGeometryEntityImpl Class Referenceabstract

BasicGeometryEntityImpl interface. More...

#include <DTK_BasicGeometryEntityImpl.hpp>

Inheritance diagram for DataTransferKit::BasicGeometryEntityImpl:
DataTransferKit::EntityImpl DataTransferKit::BoxGeometryImpl DataTransferKit::CylinderGeometryImpl

Public Member Functions

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

Detailed Description

BasicGeometryEntityImpl interface.

BasicGeometryEntityImpl gives an interface for simple geometries. These objects effectivelty define their own EntityImplLocalMap interface as these functions are typically statisfied with analytic expressions for basic geometric objects.

Definition at line 67 of file DTK_BasicGeometryEntityImpl.hpp.

Member Function Documentation

virtual EntityId DataTransferKit::BasicGeometryEntityImpl::id ( ) const
overridepure virtual

EntityImpl interface.

Get the unique global identifier for the entity.

Returns
A unique global identifier for the entity.

Implements DataTransferKit::EntityImpl.

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

virtual int DataTransferKit::BasicGeometryEntityImpl::ownerRank ( ) const
overridepure virtual

Get the parallel rank that owns the entity.

Returns
The parallel rank that owns the entity.

Implements DataTransferKit::EntityImpl.

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

virtual int DataTransferKit::BasicGeometryEntityImpl::topologicalDimension ( ) const
overridepure 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.

Implements DataTransferKit::EntityImpl.

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

virtual int DataTransferKit::BasicGeometryEntityImpl::physicalDimension ( ) const
overridepure 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.

Implements DataTransferKit::EntityImpl.

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

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

Return the Cartesian bounding box around an entity.

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

Implements DataTransferKit::EntityImpl.

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

virtual bool DataTransferKit::BasicGeometryEntityImpl::inBlock ( const int  block_id) const
overridepure virtual

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

Implements DataTransferKit::EntityImpl.

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

virtual bool DataTransferKit::BasicGeometryEntityImpl::onBoundary ( const int  boundary_id) const
overridepure virtual

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

Implements DataTransferKit::EntityImpl.

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

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

Get the extra data on the entity.

Reimplemented from DataTransferKit::EntityImpl.

Definition at line 125 of file DTK_BasicGeometryEntityImpl.hpp.

virtual std::string DataTransferKit::BasicGeometryEntityImpl::description ( ) const
overridepure virtual

Provide a one line description of the object.

Reimplemented from DataTransferKit::EntityImpl.

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

virtual void DataTransferKit::BasicGeometryEntityImpl::describe ( Teuchos::FancyOStream &  out,
const Teuchos::EVerbosityLevel  verb_level 
) const
overridepure virtual

Provide a verbose description of the object.

Reimplemented from DataTransferKit::EntityImpl.

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

virtual double DataTransferKit::BasicGeometryEntityImpl::measure ( ) const
pure virtual

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