STK mesh forward and reverse local map implementation. More...

#include <DTK_STKMeshEntityLocalMap.hpp>

Inheritance diagram for DataTransferKit::STKMeshEntityLocalMap:

Public Member Functions
	STKMeshEntityLocalMap (const Teuchos::RCP< stk::mesh::BulkData > &bulk_data)
	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	isSafeToMapToReferenceFrame (const Entity &entity, const Teuchos::ArrayView< const double > &physical_point) const override
	(Safeguard the reverse map) Perform a safeguard check for mapping a point to the reference space of an entity using the given tolerance. 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...

void	normalAtReferencePoint (const Entity &entity, const Entity &parent_entity, const Teuchos::ArrayView< const double > &reference_point, const Teuchos::ArrayView< double > &normal) const override
	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...

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

virtual	~EntityLocalMap ()
	Destructor. More...

Detailed Description

STK mesh forward and reverse local map implementation.

Definition at line 65 of file DTK_STKMeshEntityLocalMap.hpp.

Constructor & Destructor Documentation

DataTransferKit::STKMeshEntityLocalMap::STKMeshEntityLocalMap ( const Teuchos::RCP< stk::mesh::BulkData > & bulk_data )

Constructor.

Definition at line 58 of file DTK_STKMeshEntityLocalMap.cpp.

Member Function Documentation

double DataTransferKit::STKMeshEntityLocalMap::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 79 of file DTK_STKMeshEntityLocalMap.cpp.

void DataTransferKit::STKMeshEntityLocalMap::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 119 of file DTK_STKMeshEntityLocalMap.cpp.

bool DataTransferKit::STKMeshEntityLocalMap::isSafeToMapToReferenceFrame	(	const Entity &	entity,
		const Teuchos::ArrayView< const double > &	physical_point
	)		const

overridevirtual

(Safeguard the reverse map) Perform a safeguard check for mapping a point to the reference space of an entity using the given tolerance.

Parameters

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

Returns: Return true if it is safe to map to the reference frame.

Reimplemented from DataTransferKit::EntityLocalMap.

Definition at line 167 of file DTK_STKMeshEntityLocalMap.cpp.

bool DataTransferKit::STKMeshEntityLocalMap::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 207 of file DTK_STKMeshEntityLocalMap.cpp.

bool DataTransferKit::STKMeshEntityLocalMap::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 252 of file DTK_STKMeshEntityLocalMap.cpp.

void DataTransferKit::STKMeshEntityLocalMap::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 291 of file DTK_STKMeshEntityLocalMap.cpp.

void DataTransferKit::STKMeshEntityLocalMap::normalAtReferencePoint	(	const Entity &	entity,
		const Entity &	parent_entity,
		const Teuchos::ArrayView< const double > &	reference_point,
		const Teuchos::ArrayView< double > &	normal
	)		const

overridevirtual

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.

Parameters

entity	Compute the normal for this entity.
parent_entity	The adjacent parent entity used to determine which direction is outward. The parent entity should be of a higher topological dimension than the entity and be adjacent to the entity.
reference_point	Compute the normal at this reference point.
normal	A view into an array of size physicalDimension() to write the normal.

Reimplemented from DataTransferKit::EntityLocalMap.

Definition at line 331 of file DTK_STKMeshEntityLocalMap.cpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation