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

Point container declaration. More...

#include <DTK_Point.hpp>

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

Public Member Functions

void getCoordinates (const Teuchos::ArrayView< double > &coordinates) const
 Coordinate access functions. More...
 
- Public Member Functions inherited from DataTransferKit::BasicGeometryEntity
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

Point container declaration.

Point container implementation.

Users can subclass this class for more efficient access to and storage of point coordinates while getting the rest of the Entity implementation for free. For example, if a set of point coordinates already existed, a subclass could be used to point to those coordinates through this interface. This interface does assume access to contiguous storage of (x,y,z) coordinates for a given point such that a pointer to these coordinates can be accessed with a Teuchos::ArrayView. Serializing a point accesses coordinates through this interface. Deserializing a point constructs this class directly instead of potential subclasses. If in the future we want to directly deserialize to a subclass of Point through the geometric entity interface we can make the name and serialization functions virtual to permit the subclass to override them. A user could also just directly subclass Entity for their particular point type.

Definition at line 62 of file DTK_Point.hpp.

Member Function Documentation

void DataTransferKit::Point::getCoordinates ( const Teuchos::ArrayView< double > &  coordinates) const

Coordinate access functions.

Definition at line 70 of file DTK_Point.cpp.


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