MiGridPlaneSliceExtractIjk Class Reference
[Slice]

Grid plane slice extractor on structured volume meshes More...

#include <MeshVizXLM/extractors/MiGridPlaneSliceExtractIjk.h>

Inheritance diagram for MiGridPlaneSliceExtractIjk:

List of all members.

Public Member Functions
virtual	~MiGridPlaneSliceExtractIjk ()
virtual const MeXSurfaceMeshCurvilinear &	extractGrid (const MbVec3< double > &normal, double distance, double step, const MiCellFilterIjk *cellFilter=NULL)=0
virtual const MeXScalardSetIj &	extractScalarSet (const MiScalardSetIjk &inputSet)=0
virtual const MeXVec3dSetIj &	extractVec3Set (const MiVec3dSetIjk &inputSet)=0
virtual const MeXSurfaceMeshCurvilinear &	getExtract () const =0
static MiGridPlaneSliceExtractIjk *	getNewInstance (const MiVolumeMeshRegular &mesh, bool parallel=true)
static MiGridPlaneSliceExtractIjk *	getNewInstance (const MiVolumeMeshRectilinear &mesh, bool parallel=true)
static MiGridPlaneSliceExtractIjk *	getNewInstance (const MiVolumeMeshCurvilinear &mesh, bool parallel=true)

---

Detailed Description

Grid plane slice extractor on structured volume meshes

This extractor is similar to the plane slice extractor except that it creates a structured mesh and probes the input volume to compute the values at the surface nodes and cells (See MiPointProbeUnstructured for settings on curvilinear mesh). The grid created by this extractor is computed so that it encloses completely the cross section of the input volume mesh marking as dead the cells outside the volume.

---

Constructor & Destructor Documentation

virtual MiGridPlaneSliceExtractIjk::~MiGridPlaneSliceExtractIjk

(

)

[inline, virtual]

---

Member Function Documentation

virtual const MeXSurfaceMeshCurvilinear& MiGridPlaneSliceExtractIjk::extractGrid	(	const MbVec3< double > &	normal,
		double	distance,
		double	step,
		const MiCellFilterIjk *	cellFilter = NULL
	)			[pure virtual]

Builds the topology and geometry of a curvilinear surface mesh defined by the given plane normal and distance to origin.

This grid is computed so that it encloses completely the cross section of the input volume mesh.

Parameters:

	normal	Vector normal to the grid plane slice
	distance	Position of the plane relatively to the origin along the normal
	step	Distance between two consecutive nodes in both directions of the plane
	cellFilter	The cell filter object.

Returns:

A curvilinear surface mesh representing the grid plane slice

virtual const MeXScalardSetIj& MiGridPlaneSliceExtractIjk::extractScalarSet

(

const MiScalardSetIjk &

inputSet

)

[pure virtual]

Extracts a scalar set from the original mesh. The scalars are mapped onto the current extracted mesh.

Parameters:

inputSet

The input scalar set defined on the original mesh.

Returns:

The output scalar set defined on the extracted mesh.

Implemented in MiGridPlaneSliceExtractUnstructuredIjk.

virtual const MeXVec3dSetIj& MiGridPlaneSliceExtractIjk::extractVec3Set

(

const MiVec3dSetIjk &

inputSet

)

[pure virtual]

Extracts a vector set from the original mesh. The vectors are mapped onto the current extracted mesh.

Parameters:

inputSet

The input vector set defined on the original mesh.

Returns:

The output vector set defined on the extracted mesh.

Implemented in MiGridPlaneSliceExtractUnstructuredIjk.

virtual const MeXSurfaceMeshCurvilinear& MiGridPlaneSliceExtractIjk::getExtract

(

)

const [pure virtual]

Returns the result of the extraction as a mesh.

static MiGridPlaneSliceExtractIjk* MiGridPlaneSliceExtractIjk::getNewInstance	(	const MiVolumeMeshCurvilinear &	mesh,
		bool	parallel = true
	)			[static]

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

Parameters:

	mesh	The input mesh
	parallel	When true, tries to create an extract module using a parallel algorithm to speed up the extraction.

Note:

Only some of the extraction algorithms have a parallel implementation.

static MiGridPlaneSliceExtractIjk* MiGridPlaneSliceExtractIjk::getNewInstance	(	const MiVolumeMeshRectilinear &	mesh,
		bool	parallel = true
	)			[static]

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

Parameters:

	mesh	The input mesh
	parallel	When true, tries to create an extract module using a parallel algorithm to speed up the extraction.

Note:

Only some of the extraction algorithms have a parallel implementation.

static MiGridPlaneSliceExtractIjk* MiGridPlaneSliceExtractIjk::getNewInstance	(	const MiVolumeMeshRegular &	mesh,
		bool	parallel = true
	)			[static]

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

Parameters:

	mesh	The input mesh
	parallel	When true, tries to create an extract module using a parallel algorithm to speed up the extraction.

Note:

Only some of the extraction algorithms have a parallel implementation.

---

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

• MeshVizXLM/extractors/MiGridPlaneSliceExtractIjk.h