MiStreamlineExtractUnstructured Class Reference
[Streamline]

Streamline extractor for unstructured volume meshes. More...

#include <MeshVizXLM/extractors/MiStreamlineExtractUnstructured.h>

Inheritance diagram for MiStreamlineExtractUnstructured:

List of all members.

Public Member Functions
virtual const std::vector < const MeXLineMeshCurvilinear * > &	extractStreamline (const MiVec3dSetI &inputDataSet, const std::vector< MbVec3d > &startPoints, const MiCellFilterI *cellFilter=NULL)=0
virtual const std::vector < const MeXScalardSetI * > &	extractScalarSet (const MiScalardSetI &inputSet)=0
virtual const std::vector < const MeXVec3dSetI * > &	extractVec3Set (const MiVec3dSetI &inputSet)=0
virtual const std::vector < const MeXLineMeshCurvilinear * > &	getExtract () const =0
static MiStreamlineExtractUnstructured *	getNewInstance (const MiVolumeMeshUnstructured &mesh, bool parallel=true)
static MiStreamlineExtractUnstructured *	getNewInstance (const MiSurfaceMeshUnstructured &mesh, bool parallel=true)

---

Detailed Description

Streamline extractor for unstructured volume meshes.

Builds a list of MiLineMeshCurvilinear interfaces containing streamlines starting from a list of source points and probes the input mesh to compute the values at the streamline nodes (See MiPointProbeUnstructured for settings).
A streamline is a line that is everywhere tangent to a vector field. Streamlines are meaningless for unsteady flow, because time is not taken into account during the computation of the line. Streamlines are integrated from a given set of vectors using a Runge/Kutta method of order 2 .

---

Member Function Documentation

virtual const std::vector< const MeXScalardSetI* >& MiStreamlineExtractUnstructured::extractScalarSet

(

const MiScalardSetI &

inputSet

)

[pure virtual]

Extracts from the mesh a list of scalar sets. The scalars are mapped onto the current extracted streamlines. If the dataset is binded PER_NODE the scalars are interpolated and one scalar is binded per node of the extracted streamlines. Otherwise one scalar is binded per edge of the extracted streamlines.

Parameters:

inputSet

the input scalar set defined on the original volume mesh

Returns:

the output scalar sets defined on the resulting edge meshes

virtual const std::vector<const MeXLineMeshCurvilinear*>& MiStreamlineExtractUnstructured::extractStreamline	(	const MiVec3dSetI &	inputDataSet,
		const std::vector< MbVec3d > &	startPoints,
		const MiCellFilterI *	cellFilter = NULL
	)			[pure virtual]

Builds the topology and geometry of the streamlines starting at the given points in the given dataset.

The resulting streamlines can be retrieved by calling getExtract().

Parameters:

	inputDataSet	Defines the vector field for the streamlines integration
	startPoints	Defines the list of start points for the streamlines integration
	cellFilter	The cell filter

Returns:

the extracted streamlines as curvilinear line meshes

virtual const std::vector< const MeXVec3dSetI* >& MiStreamlineExtractUnstructured::extractVec3Set

(

const MiVec3dSetI &

inputSet

)

[pure virtual]

Extracts from the mesh a vector set. The vectors are mapped onto the current extracted streamlines. If the dataset is binded PER_NODE the vectors are interpolated and one vector is binded per node of the extracted streamlines. Otherwise one vector is binded per edge of the extracted streamlines.

Parameters:

inputSet

the input vector set defined on the original volume mesh

Returns:

the output scalar sets defined on the resulting edge meshes

virtual const std::vector<const MeXLineMeshCurvilinear*>& MiStreamlineExtractUnstructured::getExtract

(

)

const [pure virtual]

Returns the result of the extraction as a mesh.

static MiStreamlineExtractUnstructured* MiStreamlineExtractUnstructured::getNewInstance	(	const MiSurfaceMeshUnstructured &	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 MiStreamlineExtractUnstructured* MiStreamlineExtractUnstructured::getNewInstance	(	const MiVolumeMeshUnstructured &	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/MiStreamlineExtractUnstructured.h