Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
MiPlaneSliceExtractHexahedronIjk Class Referenceabstract

MeshViz Plane slice extractor for hexahedron IJK volume meshes More...

#include <MeshVizXLM/extractors/MiPlaneSliceExtractHexahedronIjk.h>

+ Inheritance diagram for MiPlaneSliceExtractHexahedronIjk:

Public Member Functions

virtual ~MiPlaneSliceExtractHexahedronIjk ()
 
virtual const MeXSurfaceMeshUnstructuredextractSlice (const MbVec3< double > &normal, double distance, const MiCellFilterIjk *cellFilter=NULL)=0
 Builds the topology and geometry of a plane slice intersecting the volume mesh.
 
virtual const MeXScalardSetIextractScalarSet (const MiScalardSetI &inputSet)=0
 Computes a PER_NODE scalar set on the extracted plane slice.
 
virtual const MeXScalardSetIextractScalarSet (const MiScalardSetIjk &inputSet)=0
 Computes a PER_CELL scalar set on the extracted plane slice.
 
virtual const MeXVec3dSetIextractVec3Set (const MiVec3dSetI &inputSet)=0
 Computes a vector set on the extracted plane slice.
 
virtual const MeXVec3dSetIextractVec3Set (const MiVec3dSetIjk &inputSet)=0
 Computes a vector set on the extracted plane slice.
 
virtual const MeXSurfaceMeshUnstructuredgetExtract () const =0
 Returns the result of the extraction as a mesh.
 
- Public Member Functions inherited from MiPlaneSliceExtractIjk
virtual ~MiPlaneSliceExtractIjk ()
 
- Public Member Functions inherited from MiBaseExtractor
virtual ~MiBaseExtractor ()
 
virtual void setExtractorCallback (MiExtractorCallback *extractorCallback)=0
 Set the user defined extractor callback which will be called before each extraction, during each extraction and after each extraction.
 
virtual SoDEPRECATED void setExtractorCallback (MiExtractorCallback &extractorCallback)
 

Static Public Member Functions

static MiPlaneSliceExtractHexahedronIjkgetNewInstance (const MiVolumeMeshHexahedronIjk &mesh, bool parallel=true, MiTessellator *tessellator=NULL)
 Factory method returning a new instance of a class implementing this interface.
 
- Static Public Member Functions inherited from MiPlaneSliceExtractIjk
static MiPlaneSliceExtractIjkgetNewInstance (const MiVolumeMeshRegular &mesh, bool parallel=true, MiTessellator *tessellator=NULL)
 Factory method returning a new instance of a class implementing this interface.
 
static MiPlaneSliceExtractIjkgetNewInstance (const MiVolumeMeshCurvilinear &mesh, bool parallel=true, MiTessellator *tessellator=NULL)
 
static MiPlaneSliceExtractIjkgetNewInstance (const MiVolumeMeshRectilinear &mesh, bool parallel=true, MiTessellator *tessellator=NULL)
 
static MiPlaneSliceExtractIjkgetNewInstance (const MiVolumeMeshVertexHexahedronIjk &mesh, bool parallel=true, MiTessellator *tessellator=NULL)
 

Detailed Description

MeshViz Plane slice extractor for hexahedron IJK volume meshes

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

Definition at line 44 of file MiPlaneSliceExtractHexahedronIjk.h.

Constructor & Destructor Documentation

◆ ~MiPlaneSliceExtractHexahedronIjk()

virtual MiPlaneSliceExtractHexahedronIjk::~MiPlaneSliceExtractHexahedronIjk ( )
inlinevirtual

Definition at line 47 of file MiPlaneSliceExtractHexahedronIjk.h.

Member Function Documentation

◆ extractScalarSet() [1/2]

virtual const MeXScalardSetI & MiPlaneSliceExtractHexahedronIjk::extractScalarSet ( const MiScalardSetI inputSet)
pure virtual

Computes a PER_NODE scalar set on the extracted plane slice.

Note : The argument i of the method MiScalardSetI::get(i) refers to the i-th node of the mesh. Thus the binding of the inputSet must be PER_NODE. An exception is thrown otherwise.

Parameters
inputSetthe input scalar set defined on the volume mesh
Returns
the output scalar set defined on the resulting plane slice mesh

◆ extractScalarSet() [2/2]

virtual const MeXScalardSetI & MiPlaneSliceExtractHexahedronIjk::extractScalarSet ( const MiScalardSetIjk inputSet)
pure virtual

Computes a PER_CELL scalar set on the extracted plane slice.

Note : The argument i,j,k of the method MiScalardSetIjk::get(i,j,k) refers to the cell (i,j,k). Thus the binding of the inputSet must be PER_CELL. An exception is thrown otherwise.

Parameters
inputSetthe input scalar set defined on the volume mesh
Returns
the output scalar set defined on the resulting plane slice mesh

Implements MiPlaneSliceExtractIjk.

◆ extractSlice()

virtual const MeXSurfaceMeshUnstructured & MiPlaneSliceExtractHexahedronIjk::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
normalVector normal to the plane slice
distancePosition of the plane relatively to the origin along the normal
cellFilterThe cell filter object.
Returns
An unstructured surface mesh representing the plane slice

Implements MiPlaneSliceExtractIjk.

◆ extractVec3Set() [1/2]

virtual const MeXVec3dSetI & MiPlaneSliceExtractHexahedronIjk::extractVec3Set ( const MiVec3dSetI inputSet)
pure virtual

Computes a vector set on the extracted plane slice.

Note : The argument i of the method MiVec3dSetI::get(i) refers to the i-th node of the mesh. Thus the binding of the inputSet must be PER_NODE. An exception is thrown otherwise.

Parameters
inputSetthe input vector set defined on the volume mesh
Returns
the output scalar set defined on the resulting plane slice mesh

◆ extractVec3Set() [2/2]

virtual const MeXVec3dSetI & MiPlaneSliceExtractHexahedronIjk::extractVec3Set ( const MiVec3dSetIjk inputSet)
pure virtual

Computes a vector set on the extracted plane slice.

Note : The argument i,j,k of the method MiVec3dSetIjk::get(i,j,k) refers to the cell (i,j,k). Thus the binding of the inputSet must be PER_CELL. An exception is thrown otherwise.

Parameters
inputSetthe input vector set defined on the volume mesh
Returns
the output scalar set defined on the resulting plane slice mesh

Implements MiPlaneSliceExtractIjk.

◆ getExtract()

virtual const MeXSurfaceMeshUnstructured & MiPlaneSliceExtractHexahedronIjk::getExtract ( ) const
pure virtual

Returns the result of the extraction as a mesh.

Implements MiPlaneSliceExtractIjk.

◆ getNewInstance()

static MiPlaneSliceExtractHexahedronIjk * MiPlaneSliceExtractHexahedronIjk::getNewInstance ( const MiVolumeMeshHexahedronIjk mesh,
bool  parallel = true,
MiTessellator tessellator = NULL 
)
static

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

Parameters
meshThe input mesh
parallelWhen true, tries to create an extract module using a parallel algorithm to speed up the extraction.
tessellatorThe 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: