Axis-aligned Cartesian box container implementation. More...

#include <DTK_BoxGeometryImpl.hpp>

Inheritance diagram for DataTransferKit::BoxGeometryImpl:

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

	BoxGeometryImpl (const EntityId global_id, const int owner_rank, const int block_id, const double x_min, const double y_min, const double z_min, const double x_max, const double y_max, const double z_max)
	Constructor. More...

	BoxGeometryImpl (const EntityId global_id, const int owner_rank, const int block_id, const Teuchos::Tuple< double, 6 > &bounds)
	Tuple constructor. 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

Axis-aligned Cartesian box container implementation.

All three dimensions are explictly represented in this bounding box. This is different from a bounding box in that it must always be finite and of a fixed 3 dimensions.

Definition at line 61 of file DTK_BoxGeometryImpl.hpp.

Constructor & Destructor Documentation

DataTransferKit::BoxGeometryImpl::BoxGeometryImpl ( )

Default constructor.

Definition at line 50 of file DTK_BoxGeometryImpl.cpp.

DataTransferKit::BoxGeometryImpl::BoxGeometryImpl	(	const EntityId	global_id,
		const int	owner_rank,
		const int	block_id,
		const double	x_min,
		const double	y_min,
		const double	z_min,
		const double	x_max,
		const double	y_max,
		const double	z_max
	)

Constructor.

Parameters

x_min	Minimum x coordinate value in the box.
y_min	Minimum y coordinate value in the box.
z_min	Minimum z coordinate value in the box.
x_max	Maximum x coordinate value in the box.
y_max	Maximum y coordinate value in the box.
z_max	Maximum z coordinate value in the box.

Definition at line 79 of file DTK_BoxGeometryImpl.cpp.

DataTransferKit::BoxGeometryImpl::BoxGeometryImpl	(	const EntityId	global_id,
		const int	owner_rank,
		const int	block_id,
		const Teuchos::Tuple< double, 6 > &	bounds
	)

Tuple constructor.

Parameters

bounds Tuple containing {x_min, y_min, z_min, x_max, y_max, z_max}.

Definition at line 105 of file DTK_BoxGeometryImpl.cpp.

Member Function Documentation

EntityId DataTransferKit::BoxGeometryImpl::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 125 of file DTK_BoxGeometryImpl.cpp.

int DataTransferKit::BoxGeometryImpl::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 129 of file DTK_BoxGeometryImpl.cpp.

int DataTransferKit::BoxGeometryImpl::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 133 of file DTK_BoxGeometryImpl.cpp.

int DataTransferKit::BoxGeometryImpl::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 137 of file DTK_BoxGeometryImpl.cpp.

void DataTransferKit::BoxGeometryImpl::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 145 of file DTK_BoxGeometryImpl.cpp.

bool DataTransferKit::BoxGeometryImpl::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 153 of file DTK_BoxGeometryImpl.cpp.

bool DataTransferKit::BoxGeometryImpl::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 160 of file DTK_BoxGeometryImpl.cpp.

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

inlineoverridevirtual

Provide a one line description of the object.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 100 of file DTK_BoxGeometryImpl.hpp.

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

overridevirtual

Provide a verbose description of the object.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 166 of file DTK_BoxGeometryImpl.cpp.

double DataTransferKit::BoxGeometryImpl::measure ( ) const

overridevirtual

Compute the measure of the box.

Returns: Return the measure of the box.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 186 of file DTK_BoxGeometryImpl.cpp.

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

overridevirtual

Get the centroid of the box.

Returns: The centroid coordinates.

Implements DataTransferKit::BasicGeometryEntityImpl.

Definition at line 198 of file DTK_BoxGeometryImpl.cpp.

bool DataTransferKit::BoxGeometryImpl::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 210 of file DTK_BoxGeometryImpl.cpp.

bool DataTransferKit::BoxGeometryImpl::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 223 of file DTK_BoxGeometryImpl.cpp.

void DataTransferKit::BoxGeometryImpl::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 250 of file DTK_BoxGeometryImpl.cpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation