Probe at a given location in an hexahedron IJK volume mesh More...

#include <MeshVizXLM/extractors/MiPointProbeHexahedronIjk.h>

Inheritance diagram for MiPointProbeHexahedronIjk:

Public Member Functions
template<typename _T >
_T	getValue (const MiDataSetI< _T > &dataset) const
	Gets the value at the current probe location in the given PER_NODE dataset.

template<typename _T >
_T	getValue (const MiDataSetIjk< _T > &dataset) const
	Gets the value at the current probe location in the given PER_CELL dataset.

Public Member Functions inherited from MiPointProbeIjk
virtual	~MiPointProbeIjk ()

virtual bool	setLocation (const MbVec3d &point, const MiCellFilterIjk *cellFilter=NULL)=0
	Sets the current probe location at the given point and looks for the cell containing this point.

virtual bool	moveLocation (const MbVec3d &point, size_t cellIdI, size_t cellIdJ, size_t cellIdK, const MiCellFilterIjk *cellFilter=NULL)=0
	Moves the current probe location at the given point.

virtual bool	isFound () const =0

template<typename _T >
_T	getValue (const MiDataSetIjk< _T > &dataset) const
	Gets the value at the current probe location in the given dataset.

virtual void	getCellId (size_t &i, size_t &j, size_t &k) const =0
	Gets the ids of the cell of the mesh containing the current location of the probe.

Static Public Member Functions
static MiPointProbeHexahedronIjk *	getNewInstance (const MiVolumeMeshHexahedronIjk &mesh, bool parallel=true)
	Factory method returning a new instance of a class implementing this abstract class.

Static Public Member Functions inherited from MiPointProbeIjk
static MiPointProbeIjk *	getNewInstance (const MiVolumeMeshRegular &mesh, bool parallel=true)
	Factory method returning a new instance of a class implementing this abstract class.

static MiPointProbeIjk *	getNewInstance (const MiVolumeMeshRectilinear &mesh, bool parallel=true)

static MiPointProbeIjk *	getNewInstance (const MiVolumeMeshCurvilinear &mesh, bool parallel=true)

Protected Member Functions
virtual const MiVolumeCell *	getCell () const =0
	Gets the cell of the mesh containing the current location of the probe.

Protected Member Functions inherited from MiPointProbeIjk
virtual void	getWeight (std::vector< double > &weight) const =0
	Gets the weights at the current probe location.

Detailed Description

Probe at a given location in an hexahedron IJK volume mesh

This class can be used to evaluate the value of a data set in the given mesh at any location. The probe is internally building an octree onto the mesh. This octree can be optimized by setting three environment variables (see MiPointProbeUnstructured and SoPreferences).

Definition at line 43 of file MiPointProbeHexahedronIjk.h.

Member Function Documentation

◆ getCell()

virtual const MiVolumeCell * MiPointProbeHexahedronIjk::getCell ( ) const

protectedpure virtual

Gets the cell of the mesh containing the current location of the probe.

This method is protected to have a public api the most similar to the MiPointProbeIjk.

Returns: NULL if the current location of the probe is outside the mesh.

◆ getNewInstance()

static MiPointProbeHexahedronIjk * MiPointProbeHexahedronIjk::getNewInstance	(	const MiVolumeMeshHexahedronIjk &	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.

◆ getValue() [1/2]

template<typename _T >

_T MiPointProbeHexahedronIjk::getValue ( const MiDataSetI< _T > & dataset ) const

inline

Gets the value at the current probe location in the given PER_NODE dataset.

The returned value is meaningless if the probe location is outside the mesh (when isFound() is false).

Definition at line 85 of file MiPointProbeHexahedronIjk.h.

◆ getValue() [2/2]

template<typename _T >

_T MiPointProbeHexahedronIjk::getValue ( const MiDataSetIjk< _T > & dataset ) const

inline

Gets the value at the current probe location in the given PER_CELL dataset.

The returned value is meaningless if the probe location is outside the mesh (when isFound() is false).

Definition at line 102 of file MiPointProbeHexahedronIjk.h.

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

MeshVizXLM/extractors/MiPointProbeHexahedronIjk.h

Open Inventor Release 2024.1.3

Public Member Functions