MiPlaneSliceExtractIjk Class Reference
[Slice]

Plane slice extractor for structured volume meshes More...

#include <MeshVizXLM/extractors/MiPlaneSliceExtractIjk.h>

Inheritance diagram for MiPlaneSliceExtractIjk:

List of all members.

Public Member Functions
virtual	~MiPlaneSliceExtractIjk ()
virtual const MeXSurfaceMeshUnstructured &	extractSlice (const MbVec3< double > &normal, double distance, const MiCellFilterIjk *cellFilter=NULL)=0
virtual const MeXScalardSetI &	extractScalarSet (const MiScalardSetIjk &inputSet)=0
virtual const MeXVec3dSetI &	extractVec3Set (const MiVec3dSetIjk &inputSet)=0
virtual const MeXSurfaceMeshUnstructured &	getExtract () const =0
static MiPlaneSliceExtractIjk *	getNewInstance (const MiVolumeMeshRegular &mesh, bool parallel=true, MiTessellator *tessellator=NULL)
static MiPlaneSliceExtractIjk *	getNewInstance (const MiVolumeMeshCurvilinear &mesh, bool parallel=true, MiTessellator *tessellator=NULL)
static MiPlaneSliceExtractIjk *	getNewInstance (const MiVolumeMeshRectilinear &mesh, bool parallel=true, MiTessellator *tessellator=NULL)
static MiPlaneSliceExtractIjk *	getNewInstance (const MiVolumeMeshVertexHexahedronIjk &mesh, bool parallel=true, MiTessellator *tessellator=NULL)

---

Detailed Description

Plane slice extractor for structured volume meshes

A plane slice is the intersection of a given plane with the mesh volume. The extracted plane slice is an unstructured surface.

See related examples:

MultipleBenchmark, Bench_PlaneSlice, TutorialComputeSliceArea

---

Constructor & Destructor Documentation

virtual MiPlaneSliceExtractIjk::~MiPlaneSliceExtractIjk

(

)

[inline, virtual]

---

Member Function Documentation

virtual const MeXScalardSetI& MiPlaneSliceExtractIjk::extractScalarSet

(

const MiScalardSetIjk &

inputSet

)

[pure virtual]

Extracts a scalar set from the volume mesh.

The scalars are mapped onto the current extracted plane slice.

Parameters:

inputSet

the input scalar set defined on the volume mesh

Returns:

the output scalar set defined on the resulting surface mesh

virtual const MeXSurfaceMeshUnstructured& MiPlaneSliceExtractIjk::extractSlice	(	const MbVec3< double > &	normal,
		double	distance,
		const MiCellFilterIjk *	cellFilter = NULL
	)			[pure virtual]

Builds the topology and geometry of a plane slice intersecting the volume mesh.

Returns:

the plane slice extracted as an unstructured surface mesh.

Parameters:

	normal	Vector normal to the plane slice
	distance	Position of the plane relatively to the origin along the normal
	cellFilter	The cell filter object.

Returns:

An unstructured surface mesh representing the plane slice

virtual const MeXVec3dSetI& MiPlaneSliceExtractIjk::extractVec3Set

(

const MiVec3dSetIjk &

inputSet

)

[pure virtual]

Extracts a vector set from the volume mesh.

The vectors are mapped onto the current extracted plane slice.

Parameters:

inputSet

the input vec3 set defined on the volume mesh

Returns:

the output scalar set defined on the resulting surface mesh

virtual const MeXSurfaceMeshUnstructured& MiPlaneSliceExtractIjk::getExtract

(

)

const [pure virtual]

Returns the result of the extraction as a mesh.

static MiPlaneSliceExtractIjk* MiPlaneSliceExtractIjk::getNewInstance	(	const MiVolumeMeshVertexHexahedronIjk &	mesh,
		bool	parallel = true,
		MiTessellator *	tessellator = NULL
	)			[static]

Factory method returning a new instance of a class implementing this interface.

Parameters:

	mesh	The input mesh
	parallel	When true, tries to create an extract module using a parallel algorithm to speed up the extraction.
	tessellator	The tessellator object used for tessellating non linear cells (quadratic,...).

Note:

Only some of the extraction algorithms have a parallel implementation.

static MiPlaneSliceExtractIjk* MiPlaneSliceExtractIjk::getNewInstance	(	const MiVolumeMeshRectilinear &	mesh,
		bool	parallel = true,
		MiTessellator *	tessellator = NULL
	)			[static]

Factory method returning a new instance of a class implementing this interface.

Parameters:

	mesh	The input mesh
	parallel	When true, tries to create an extract module using a parallel algorithm to speed up the extraction.
	tessellator	The tessellator object used for tessellating non linear cells (quadratic,...).

Note:

Only some of the extraction algorithms have a parallel implementation.

static MiPlaneSliceExtractIjk* MiPlaneSliceExtractIjk::getNewInstance	(	const MiVolumeMeshCurvilinear &	mesh,
		bool	parallel = true,
		MiTessellator *	tessellator = NULL
	)			[static]

Factory method returning a new instance of a class implementing this interface.

Parameters:

	mesh	The input mesh
	parallel	When true, tries to create an extract module using a parallel algorithm to speed up the extraction.
	tessellator	The tessellator object used for tessellating non linear cells (quadratic,...).

Note:

Only some of the extraction algorithms have a parallel implementation.

static MiPlaneSliceExtractIjk* MiPlaneSliceExtractIjk::getNewInstance	(	const MiVolumeMeshRegular &	mesh,
		bool	parallel = true,
		MiTessellator *	tessellator = NULL
	)			[static]

Factory method returning a new instance of a class implementing this interface.

Parameters:

	mesh	The input mesh
	parallel	When true, tries to create an extract module using a parallel algorithm to speed up the extraction.
	tessellator	The tessellator object used for tessellating non linear cells (quadratic,...).

Note:

Only some of the extraction algorithms have a parallel implementation.

---

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

• MeshVizXLM/extractors/MiPlaneSliceExtractIjk.h