Z-axis-aligned Cartesian cylinder container implementation. More...

#include <DTK_CylinderGeometryImpl.hpp>

Inheritance diagram for DataTransferKit::CylinderGeometryImpl:

Public Member Functions
	CylinderGeometryImpl ()
	Default constructor. More...

	CylinderGeometryImpl (const EntityId global_id, const int owner_rank, const int block_id, const double length, const double radius, const double centroid_x, const double centroid_y, const double centroid_z)
	Constructor. More...

double	length () const
	Get the length of the cylinder. More...

double	radius () const
	Get the radius of the cylinder. More...

EntityId	id () const override
	EntityImpl interface. More...

int	ownerRank () const override
	Get the parallel rank that owns the entity. More...

int	topologicalDimension () const override
	Return the topological dimension of the entity. More...

int	physicalDimension () const override
	Return the physical dimension of the entity. More...

void	boundingBox (Teuchos::Tuple< double, 6 > &bounds) const override
	Compute the bounding box around the box. More...

bool	inBlock (const int block_id) const override
	Determine if an entity is in the block with the given id. More...

bool	onBoundary (const int boundary_id) const override
	Determine if an entity is on the boundary with the given id. More...

std::string	description () const override
	Provide a one line description of the object. More...

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verb_level) const override
	Provide a verbose description of the object. More...

double	measure () const override
	Compute the measure of the box. More...

void	centroid (const Teuchos::ArrayView< double > &centroid) const override
	Get the centroid of the box. More...

bool	mapToReferenceFrame (const Teuchos::ArrayView< const double > &point, const Teuchos::ArrayView< double > &reference_point) const override
	Map a point to the reference space of an entity. Return the. More...

bool	checkPointInclusion (const double tolerance, const Teuchos::ArrayView< const double > &reference_point) const override
	Determine if a reference point is in the parameterized space of an entity. More...

void	mapToPhysicalFrame (const Teuchos::ArrayView< const double > &reference_point, const Teuchos::ArrayView< double > &point) const override
	Map a reference point to the physical space of an entity. More...

Public Member Functions inherited from DataTransferKit::BasicGeometryEntityImpl
virtual Teuchos::RCP< EntityExtraData >	extraData () const override
	Get the extra data on the entity. More...

Public Member Functions inherited from DataTransferKit::EntityImpl
	EntityImpl ()
	Constructor. More...

virtual	~EntityImpl ()
	Destructor. More...

Detailed Description

Z-axis-aligned Cartesian cylinder container implementation.

All three dimensions are explictly represented in this cylinder.

Definition at line 59 of file DTK_CylinderGeometryImpl.hpp.

Constructor & Destructor Documentation

DataTransferKit::CylinderGeometryImpl::CylinderGeometryImpl ( )

Default constructor.

Definition at line 52 of file DTK_CylinderGeometryImpl.cpp.

DataTransferKit::CylinderGeometryImpl::CylinderGeometryImpl	(	const EntityId	global_id,
		const int	owner_rank,
		const int	block_id,
		const double	length,
		const double	radius,
		const double	centroid_x,
		const double	centroid_y,
		const double	centroid_z
	)

Constructor.

Parameters

length	Length of cylinder along Z-axis.
radius	Radius of cylinder.
centroid_x	Centroid X-coordinate.
centroid_y	Centroid Y-coordinate.
centroid_z	Centroid Z-coordinate.

Definition at line 78 of file DTK_CylinderGeometryImpl.cpp.

Member Function Documentation

double DataTransferKit::CylinderGeometryImpl::length ( ) const

inline

Get the length of the cylinder.

Definition at line 73 of file DTK_CylinderGeometryImpl.hpp.

double DataTransferKit::CylinderGeometryImpl::radius ( ) const

inline

Get the radius of the cylinder.

Definition at line 76 of file DTK_CylinderGeometryImpl.hpp.

EntityId DataTransferKit::CylinderGeometryImpl::id ( ) const

overridevirtual

EntityImpl interface.

Get the unique global identifier for the entity.

Returns: A unique global identifier for the entity.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 97 of file DTK_CylinderGeometryImpl.cpp.

int DataTransferKit::CylinderGeometryImpl::ownerRank ( ) const

overridevirtual

Get the parallel rank that owns the entity.

Returns: The parallel rank that owns the entity.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 101 of file DTK_CylinderGeometryImpl.cpp.

int DataTransferKit::CylinderGeometryImpl::topologicalDimension ( ) const

overridevirtual

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::BasicGeometryEntityImpl.

Definition at line 105 of file DTK_CylinderGeometryImpl.cpp.

int DataTransferKit::CylinderGeometryImpl::physicalDimension ( ) const

overridevirtual

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::BasicGeometryEntityImpl.

Definition at line 109 of file DTK_CylinderGeometryImpl.cpp.

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

overridevirtual

Compute the bounding box around the box.

Returns: The bounding box bounds.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 117 of file DTK_CylinderGeometryImpl.cpp.

bool DataTransferKit::CylinderGeometryImpl::inBlock ( const int block_id ) const

overridevirtual

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

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 128 of file DTK_CylinderGeometryImpl.cpp.

bool DataTransferKit::CylinderGeometryImpl::onBoundary ( const int boundary_id ) const

overridevirtual

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

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 135 of file DTK_CylinderGeometryImpl.cpp.

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

inlineoverridevirtual

Provide a one line description of the object.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 100 of file DTK_CylinderGeometryImpl.hpp.

void DataTransferKit::CylinderGeometryImpl::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verb_level
	)		const

overridevirtual

Provide a verbose description of the object.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 141 of file DTK_CylinderGeometryImpl.cpp.

double DataTransferKit::CylinderGeometryImpl::measure ( ) const

overridevirtual

Compute the measure of the box.

Returns: Return the measure of the box.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 162 of file DTK_CylinderGeometryImpl.cpp.

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

overridevirtual

Get the centroid of the box.

Returns: The centroid coordinates.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 175 of file DTK_CylinderGeometryImpl.cpp.

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

overridevirtual

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

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 187 of file DTK_CylinderGeometryImpl.cpp.

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

overridevirtual

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

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 200 of file DTK_CylinderGeometryImpl.cpp.

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

overridevirtual

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

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 221 of file DTK_CylinderGeometryImpl.cpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation