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

#include <DTK_CylinderGeometry.hpp>

Inheritance diagram for DataTransferKit::CylinderGeometry:

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

	CylinderGeometry (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...

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::Entity
	Entity ()
	Constructor. More...

	Entity (const Entity &rhs)
	Copy constructor. More...

Entity &	operator= (const Entity &rhs)
	Copy assignment operator. More...

	Entity (Entity &&rhs)
	Move constructor. More...

Entity &	operator= (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< EntityExtraData >	extraData () 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

Z-axis-aligned Cartesian cylinder container.

All three dimensions are explictly represented in this cylinder.

Definition at line 61 of file DTK_CylinderGeometry.hpp.

Constructor & Destructor Documentation

DataTransferKit::CylinderGeometry::CylinderGeometry ( )

Default constructor.

Definition at line 53 of file DTK_CylinderGeometry.cpp.

DataTransferKit::CylinderGeometry::CylinderGeometry	(	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 72 of file DTK_CylinderGeometry.cpp.

Member Function Documentation

double DataTransferKit::CylinderGeometry::length ( ) const

Get the length of the cylinder.

Definition at line 86 of file DTK_CylinderGeometry.cpp.

double DataTransferKit::CylinderGeometry::radius ( ) const

Get the radius of the cylinder.

Definition at line 95 of file DTK_CylinderGeometry.cpp.

double DataTransferKit::CylinderGeometry::measure ( ) const

overridevirtual

Compute the measure of the box.

Returns: Return the measure of the box.

Reimplemented from DataTransferKit::BasicGeometryEntity.

Definition at line 108 of file DTK_CylinderGeometry.cpp.

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

overridevirtual

Get the centroid of the box.

Returns: The centroid coordinates.

Reimplemented from DataTransferKit::BasicGeometryEntity.

Definition at line 121 of file DTK_CylinderGeometry.cpp.

bool DataTransferKit::CylinderGeometry::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.

Reimplemented from DataTransferKit::BasicGeometryEntity.

Definition at line 132 of file DTK_CylinderGeometry.cpp.

bool DataTransferKit::CylinderGeometry::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.

Reimplemented from DataTransferKit::BasicGeometryEntity.

Definition at line 146 of file DTK_CylinderGeometry.cpp.

void DataTransferKit::CylinderGeometry::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.

Reimplemented from DataTransferKit::BasicGeometryEntity.

Definition at line 159 of file DTK_CylinderGeometry.cpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation