Entity forward and reverse local map interface definition. More...

#include <DTK_BasicGeometryLocalMap.hpp>

Inheritance diagram for DataTransferKit::BasicGeometryLocalMap:

Public Member Functions
	BasicGeometryLocalMap ()
	Constructor. More...

double	measure (const Entity &entity) const override
	Return the entity measure with respect to the parameteric dimension (volume for a 3D entity, area for 2D, and length for 1D). More...

void	centroid (const Entity &entity, const Teuchos::ArrayView< double > &centroid) const override
	Return the centroid of the entity. More...

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

bool	checkPointInclusion (const Entity &entity, 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 Entity &entity, const Teuchos::ArrayView< const double > &reference_point, const Teuchos::ArrayView< double > &physical_point) const override
	(Forward Map) Map a reference point to the physical space of an entity. More...

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

virtual	~EntityLocalMap ()
	Destructor. More...

virtual bool	isSafeToMapToReferenceFrame (const Entity &entity, const Teuchos::ArrayView< const double > &physical_point) const
	(Safeguard the reverse map) Perform a safeguard check for mapping a point to the reference space of an entity using the given tolerance. More...

virtual void	normalAtReferencePoint (const Entity &entity, const Entity &parent_entity, const Teuchos::ArrayView< const double > &reference_point, const Teuchos::ArrayView< double > &normal) const
	Compute the normal on a face (3D) or edge (2D) at a given reference point. A default implementation is provided using a finite difference scheme. More...

Detailed Description

Entity forward and reverse local map interface definition.

An BasicGeometryLocalMap provides an interface for accessing forward and reverse maps for an entity's local coordinates as well as related convenience functions.

Definition at line 63 of file DTK_BasicGeometryLocalMap.hpp.

Constructor & Destructor Documentation

DataTransferKit::BasicGeometryLocalMap::BasicGeometryLocalMap ( )

Constructor.

Definition at line 50 of file DTK_BasicGeometryLocalMap.cpp.

Member Function Documentation

double DataTransferKit::BasicGeometryLocalMap::measure ( const Entity & entity ) const

overridevirtual

Return the entity measure with respect to the parameteric dimension (volume for a 3D entity, area for 2D, and length for 1D).

Parameters

entity Compute the measure for this entity.

Returns: The measure of the entity.

Implements DataTransferKit::EntityLocalMap.

Definition at line 69 of file DTK_BasicGeometryLocalMap.cpp.

void DataTransferKit::BasicGeometryLocalMap::centroid	(	const Entity &	entity,
		const Teuchos::ArrayView< double > &	centroid
	)		const

overridevirtual

Return the centroid of the entity.

Parameters

centroid A view of the centroid coordinates. This view will be allocated. Assign a view of your centroid to this view.

Implements DataTransferKit::EntityLocalMap.

Definition at line 79 of file DTK_BasicGeometryLocalMap.cpp.

bool DataTransferKit::BasicGeometryLocalMap::mapToReferenceFrame	(	const Entity &	entity,
		const Teuchos::ArrayView< const double > &	physical_point,
		const Teuchos::ArrayView< double > &	reference_point
	)		const

overridevirtual

(Reverse Map) Map a point to the reference space of an entity. Return the parameterized point.

Parameters

entity	Perfrom the mapping for this entity.
parameters	Parameters to be used for the mapping procedure.
A	view into an array of size physicalDimension() containing the coordinates of the point to map.
reference_point	A view into an array of size physicalDimension() to write the reference coordinates of the mapped point.

Returns: Return true if the map to reference frame succeeded.

Implements DataTransferKit::EntityLocalMap.

Definition at line 90 of file DTK_BasicGeometryLocalMap.cpp.

bool DataTransferKit::BasicGeometryLocalMap::checkPointInclusion	(	const Entity &	entity,
		const Teuchos::ArrayView< const double > &	reference_point
	)		const

overridevirtual

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

Parameters

entity	Perfrom the mapping for this entity.
parameters	Parameters to be used for the point inclusion check.
reference_point	A view into an array of size physicalDimension() containing the reference coordinates of the mapped point.

Returns: True if the point is in the reference space, false if not.

Implements DataTransferKit::EntityLocalMap.

Definition at line 103 of file DTK_BasicGeometryLocalMap.cpp.

void DataTransferKit::BasicGeometryLocalMap::mapToPhysicalFrame	(	const Entity &	entity,
		const Teuchos::ArrayView< const double > &	reference_point,
		const Teuchos::ArrayView< double > &	physical_point
	)		const

overridevirtual

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

Parameters

entity	Perfrom the mapping for this entity.
reference_point	A view into an array of size physicalDimension() containing the reference coordinates of the mapped point.
A	view into an array of size physicalDimension() to write the coordinates of physical point.

Implements DataTransferKit::EntityLocalMap.

Definition at line 115 of file DTK_BasicGeometryLocalMap.cpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation