MxPyramidCellExtract Class Reference
[Cell]

Utility class for pyramid cells. More...

#include <MeshVizXLM/extractors/MxPyramidCellExtract.h>

Static Public Member Functions
static void	getIsosurfTopology (unsigned char caseId, std::vector< std::pair< size_t, size_t > > &edgeList)
static MbVec3d	getIsoParametricCoord (const MiGeometryI &meshGeometry, const MiVolumeCell *pyramidCell, const MbVec3d &point)
static void	getWeight (const MiGeometryI &meshGeometry, const MiVolumeCell *pyramidCell, const MbVec3d &point, std::vector< double > &weights)
static void	getWeight (const MbVec3d &ipcoord, std::vector< double > &weights)
static void	getDerivs (const MbVec3d &ipcoord, std::vector< double > &derivs)
static bool	isPointInsideCell (const MiGeometryI &meshGeometry, const MiVolumeCell *pyramidCell, const MbVec3d &point, std::vector< double > &weights)
static double	getVolume (const MiGeometryI &meshGeometry, const MiVolumeCell *pyramidCell)
static MbVec3d	getFacetNormal (size_t facetId, const MiGeometryI &meshGeometry, const MiVolumeCell *pyramidCell)
static double	getLongestEdgeLength (const MiGeometryI &meshGeometry, const MiVolumeCell *cell)
static double	getShortestEdgeLength (const MiGeometryI &meshGeometry, const MiVolumeCell *cell)

Detailed Description

Utility class for pyramid cells.

Utility class that provides a static implementation of the MiVolumeCell's methods in a pyramid cell. This class is provided to make easier the creation of a class in the application that implements the MiVolumeCell interface for a pyramid cell.

extraction of the topology of an isosurface in a pyramid. (see getIsosurfTopology())
value of iso parametric coordinates in a linear pyramid cell. (see getIsoParametricCoord())
value of the 5 weights (aka shape functions) in a pyramid cell. (see getWeight())
localization test (see isPointInsideCell())

The following image shows the nodes numbering and the faces numbering used by this class. The isosurface topology (see getIsosurfTopology()), weights (see getWeight()), and parametric coordinates (see getIsoParametricCoord()) are defined according to this node numbering.

Nodes and faces numbering

Member Function Documentation

static void MxPyramidCellExtract::getDerivs	(	const MbVec3d &	ipcoord,
		std::vector< double > &	derivs
	)			`[static]`

Gets the value of the derivatives of the shape functions (aka weights) at the point given by its iso parametric coordinates.

Parameters:

`[in]`	ipcoord	The iso parametric coordinates of the input point. The reference space for the iso parametric coordinates is assumed to be [0-1]. Thus any point inside the cell has iso parametric coordinates in the interval [0-1].
`[out]`	derivs	This method computes the 24 values derivs[0-23]. It assumes the derivs vector array has been already allocated. Its size must be set to 24 (at least) before calling this method, using for instance the derivs::resize(24)

static MbVec3d MxPyramidCellExtract::getFacetNormal	(	size_t	facetId,
		const MiGeometryI &	meshGeometry,
		const MiVolumeCell *	pyramidCell
	)			`[static]`

Gets the normal of the given facet in a tetrahedron cell.

static MbVec3d MxPyramidCellExtract::getIsoParametricCoord	(	const MiGeometryI &	meshGeometry,
		const MiVolumeCell *	pyramidCell,
		const MbVec3d &	point
	)			`[static]`

Computes the iso parametric coordinates of the given point in the given cell with the given geometry.

As computing the iso parametric coordinates of a point needs the coordinates of the cell's nodes, the given pyramidCell is assumed to contain 5 nodes.

Note:

Each node coordinate of the given cell is retrieved in the following way:

     meshGeometry.getCoord(pyramidCell->getNodeIndex(i))

for each i in the range [0-4].

Parameters:

`[in]`	meshGeometry	The geometry of the mesh.
`[in]`	pyramidCell	The input cell.
`[in]`	point	The input point given in the same space coordinate as meshGeometry.

static void MxPyramidCellExtract::getIsosurfTopology	(	unsigned char	caseId,
		std::vector< std::pair< size_t, size_t > > &	edgeList
	)			`[static]`

Returns the isosurface topology of the associated caseId.

This method can be used in the getIsosurfTopology(...) implementation of a pyramid cell interface to return the information to the isosurface extraction module.

static double MxPyramidCellExtract::getLongestEdgeLength	(	const MiGeometryI &	meshGeometry,
		const MiVolumeCell *	cell
	)			`[static]`

Gets the longest edge of a pyramid cell.

static double MxPyramidCellExtract::getShortestEdgeLength	(	const MiGeometryI &	meshGeometry,
		const MiVolumeCell *	cell
	)			`[static]`

Gets the shortest edge of a pyramid cell.

static double MxPyramidCellExtract::getVolume	(	const MiGeometryI &	meshGeometry,
		const MiVolumeCell *	pyramidCell
	)			`[static]`

Gets the volume of the cell.

static void MxPyramidCellExtract::getWeight	(	const MbVec3d &	ipcoord,
		std::vector< double > &	weights
	)			`[inline, static]`

Gets the weights of a point defined by its iso parametric coordinates.

This static method helps to implement the method MiCell::getWeight(ipcoord,weights) for a pyramid cell.

Parameters:

`[in]`	ipcoord	The iso parametric coordinates of the input point. The reference space for the iso parametric coordinates is assumed to be [0-1]. Thus any point inside the cell has iso parametric coordinates in the interval [0-1].
`[out]`	weights	This method computes the 5 values weights[0-4]. It assumes the weights vector array has been already allocated. Its size must be set to 5 (at least) before calling this method, using for instance the weights::resize(5)

static void MxPyramidCellExtract::getWeight	(	const MiGeometryI &	meshGeometry,
		const MiVolumeCell *	pyramidCell,
		const MbVec3d &	point,
		std::vector< double > &	weights
	)			`[inline, static]`

Gets the weights in the given cell of the given point.

This static method helps to implement the method MiCell::getWeight(meshGeometry,point,weights) for a pyramid cell. As computing the weights of a point needs the coordinates of the cell's nodes, the given pyramidCell is assumed to contain 5 nodes.

Note:

Each node coordinate of the given cell is retrieved in the following way:

     meshGeometry.getCoord(pyramidCell->getNodeIndex(i))

for each i in the range [0-4].

Parameters:

`[in]`	meshGeometry	The geometry of the mesh.
`[in]`	pyramidCell	The input cell.
`[in]`	point	The input point given in the same space coordinate as meshGeometry.
`[out]`	weights	This method computes the 5 values weights[0-4]. It assumes the weights vector array has been already allocated. Its size must be set to 5 (at least) before calling this method, using for instance the weights.resize(5)

static bool MxPyramidCellExtract::isPointInsideCell	(	const MiGeometryI &	meshGeometry,
		const MiVolumeCell *	pyramidCell,
		const MbVec3d &	point,
		std::vector< double > &	weights
	)			`[inline, static]`

Checks if a point is inside or outside a pyramid cell.

This static method helps to implement the method MiCell::isPointInsideCell(meshGeometry,point,weights) for a pyramid cell.

Parameters:

`[in]`	meshGeometry	The geometry of the mesh.
`[in]`	pyramidCell	The input cell.
`[in]`	point	The input point given in the same space coordinate as meshGeometry.
`[out]`	weights	This method computes the 5 values weights[0-4] if the point is inside the cell. It assumes the weights vector array has been already allocated. Its size must be set to 5 (at least) before calling this method, using for instance the weights::resize(5)

Returns:: true if the point is inside the cell.

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

MeshVizXLM/extractors/MxPyramidCellExtract.h

MxPyramidCellExtract Class Reference [Cell]

Static Public Member Functions

Detailed Description

Member Function Documentation

MxPyramidCellExtract Class Reference
[Cell]