Package com.openinventor.meshvizxlm.extractors.pointprobe

Class MiPointProbeHexahedronIjk

java.lang.Object

com.openinventor.meshvizxlm.extractors.pointprobe.MiPointProbeIjk

com.openinventor.meshvizxlm.extractors.pointprobe.MiPointProbeHexahedronIjk

All Implemented Interfaces:

MiBaseExtractor, MiExtractorIjk

public abstract class MiPointProbeHexahedronIjk
extends MiPointProbeIjk

Probe at a given location in an hexahedron IJK 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 volume meshes.
This octree can be optimized by setting three environment variables (see SoPreferences and MiPointProbeUnstructured ).

Method Summary

Modifier and Type	Method	Description
static <T extends MiHexahedronTopologyExplicitIjk,G extends MiGeometryI> MiPointProbeHexahedronIjk	getNewInstance(MiVolumeMeshHexahedronIjk<T,G> mesh)	Create an instance of a probe for IJK Hexahedron volume mesh.
abstract double	getValue(MiScalardSetI dataset)	Gets the scalar value at the current probe location in the given PER_NODE scalar set.
abstract double[]	getValue(MiVec3dSetI dataset)	Gets the vector value at the current probe location in the given PER_NODE vector set.

Methods inherited from class com.openinventor.meshvizxlm.extractors.pointprobe.MiPointProbeIjk

getCellId, getNewInstance, getValue, getValue, isFound, moveLocation, setLocation

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.openinventor.meshvizxlm.extractors.MiBaseExtractor

setExtractorCallback

Methods inherited from interface com.openinventor.meshvizxlm.extractors.MiExtractorIjk

addCellRange, clearCellRanges

Method Detail

getNewInstance

public static <T extends MiHexahedronTopologyExplicitIjk,G extends MiGeometryI> MiPointProbeHexahedronIjk getNewInstance(MiVolumeMeshHexahedronIjk<T,G> mesh)

Create an instance of a probe for IJK Hexahedron volume mesh.

Parameters:

mesh - the input mesh

Returns:

a probe for IJK Hexahedron volume mesh.

getValue

public abstract double getValue(MiScalardSetI dataset)

Gets the scalar value at the current probe location in the given PER_NODE scalar set.
The returned value is meaningless if the probe location is outside the mesh (when MiPointProbeIjk.isFound() is false

Parameters:

dataset - the input scalar set

Returns:

scalar value at the current probe location

Throws:

java.lang.UnsupportedOperationException - if binding of scalar set is not PER_NODE

getValue

public abstract double[] getValue(MiVec3dSetI dataset)

Gets the vector value at the current probe location in the given PER_NODE vector set.
The returned value is null if the probe location is outside the mesh (when MiPointProbeIjk.isFound() is false).

Parameters:

dataset - the input vector set

Returns:

the vector coordinates {x,y,z} at the current probe location or null if the probe location is outside the mesh

Throws:

java.lang.UnsupportedOperationException - if binding of scalar set is not PER_NODE