DataTransferKit - Multiphysics Solution Transfer Services  2.0
List of all members
DataTransferKit::BasicGeometryEntity Class Reference

BasicGeometryEntity interface. More...

#include <DTK_BasicGeometryEntity.hpp>

Inheritance diagram for DataTransferKit::BasicGeometryEntity:
DataTransferKit::Entity DataTransferKit::BoxGeometry DataTransferKit::CylinderGeometry DataTransferKit::Point

Public Member Functions

virtual double measure () const
 BasicGeometryEntity interface. More...
 
virtual void centroid (const Teuchos::ArrayView< double > &centroid) const
 Get the centroid of the entity. More...
 
virtual bool mapToReferenceFrame (const Teuchos::ArrayView< const double > &point, const Teuchos::ArrayView< double > &reference_point) const
 Map a point to the reference space of an entity. Return the. More...
 
virtual bool checkPointInclusion (const double tolerance, const Teuchos::ArrayView< const double > &reference_point) const
 Determine if a reference point is in the parameterized space of an entity. More...
 
virtual void mapToPhysicalFrame (const Teuchos::ArrayView< const double > &reference_point, const Teuchos::ArrayView< double > &point) const
 Map a reference point to the physical space of an entity. 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

BasicGeometryEntity interface.

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

Definition at line 66 of file DTK_BasicGeometryEntity.hpp.

Member Function Documentation

double DataTransferKit::BasicGeometryEntity::measure ( ) const
virtual

BasicGeometryEntity interface.

Compute the measure of the entity.

Returns
Return the measure of the entity.

Reimplemented in DataTransferKit::BoxGeometry, and DataTransferKit::CylinderGeometry.

Definition at line 62 of file DTK_BasicGeometryEntity.cpp.

void DataTransferKit::BasicGeometryEntity::centroid ( const Teuchos::ArrayView< double > &  centroid) const
virtual

Get the centroid of the entity.

Returns
The centroid coordinates.

Reimplemented in DataTransferKit::BoxGeometry, and DataTransferKit::CylinderGeometry.

Definition at line 76 of file DTK_BasicGeometryEntity.cpp.

bool DataTransferKit::BasicGeometryEntity::mapToReferenceFrame ( const Teuchos::ArrayView< const double > &  point,
const Teuchos::ArrayView< double > &  reference_point 
) const
virtual

Map a point to the reference space of an entity. Return the.

Reimplemented in DataTransferKit::BoxGeometry, and DataTransferKit::CylinderGeometry.

Definition at line 88 of file DTK_BasicGeometryEntity.cpp.

bool DataTransferKit::BasicGeometryEntity::checkPointInclusion ( const double  tolerance,
const Teuchos::ArrayView< const double > &  reference_point 
) const
virtual

Determine if a reference point is in the parameterized space of an entity.

Reimplemented in DataTransferKit::BoxGeometry, and DataTransferKit::CylinderGeometry.

Definition at line 103 of file DTK_BasicGeometryEntity.cpp.

void DataTransferKit::BasicGeometryEntity::mapToPhysicalFrame ( const Teuchos::ArrayView< const double > &  reference_point,
const Teuchos::ArrayView< double > &  point 
) const
virtual

Map a reference point to the physical space of an entity.

Reimplemented in DataTransferKit::BoxGeometry, and DataTransferKit::CylinderGeometry.

Definition at line 117 of file DTK_BasicGeometryEntity.cpp.


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