Defines a cartesian grid volume mesh. More...

#include <MeshViz/3Ddata/PbCartesianGrid3D.h>

Inheritance diagram for PbCartesianGrid3D:

Public Member Functions
	PbCartesianGrid3D (SbBool is_data_duplicated=TRUE)
	Constructor.

	PbCartesianGrid3D (const PbCartesianGrid3D &)
	Copy constructor.

	PbCartesianGrid3D (int num_x, int num_y, int num_z, const float xnod, const float ynod, const float *znod, SbBool is_data_duplicated=TRUE)
	Constructor of a volume mesh.

	~PbCartesianGrid3D ()
	Destructor.

PbCartesianGrid3D &	operator= (const PbCartesianGrid3D &mesh)
	Assignment operator.

void	setCoordinates (const float xnod, const float ynod, const float *znod)
	Set new node coordinates without modifying the mesh topology.

void	getCoordinates (const float &xnod, const float &ynod, const float *&znod, int &size_xnod, int &size_ynod, int &size_znod) const
	Get the current coordinates of the nodes of this mesh.

void	getGeometry (int &num_x, int &num_y, int &num_z, const float *&xa, const float &ya, const float **&za) const
	Gets the mesh geometry.

virtual const PbCell *	getCell (int cell_index) const
	Gets the cell which index is cell_index.

virtual SbVec3f	getNodeCoord (int nod_index) const
	Gets the coordinates of a node defined by its index.

SbVec3f	getNodeCoord (int i, int j, int k) const
	Gets the coordinates of a node defined by its i,j,k indices on the grid.

void	getGeometry (int &num_x, int &num_y, int &num_z, const float &x, const float &y, const float *&z) const
	Gets the mesh geometry.

Public Member Functions inherited from PbGrid3D
	PbGrid3D (SbBool is_data_duplicate=TRUE)
	Constructor.

	PbGrid3D (const PbGrid3D &mesh)
	Copy constructor.

	~PbGrid3D ()
	Destructor.

PbGrid3D &	operator= (const PbGrid3D &mesh)
	Assignment operator.

void	setGeometry (int num_x, int num_y, int num_z, const float x, const float y, const float *z)
	Defines a volume mesh geometry.

void	getGeometry (int &num_x, int &num_y, int &num_z, const float &x, const float &y, const float *&z) const
	Gets the mesh geometry.

void	getDim (int &num_x, int &num_y, int &num_z) const
	Gets the dimensions num_x, num_y, num_z of the grid.

virtual void	getNodeOwnerCellsInd (int nod_index, PbArrayOfInt &owner_cells) const
	Gets the list of index of cells that own the node "nod_index".

virtual void	getAdjacentCellsIndByNode (int cell_index, PbArrayOfInt &adjacent_cells) const
	Gets the list of index of cells that are adjacent (by a node) to cell_index.

virtual void	getAdjacentCellsIndByFacet (int cell_index, PbArrayOfInt &adjacent_cells) const
	Gets the list of index of cells that are adjacent (by a facet) to cell_index.

void	getNodeIndices (int nod_index, int &i, int &j, int &k) const
	Calculates indices i,j,k that verify (inum_y + j)num_z + k.

void	getCellIndices (int cell_index, int &i, int &j, int &k) const
	Calculates indices i,j,k that verify cell_index = (i(num_y-1) + j)(num_z-1) + k.

Public Member Functions inherited from PbMesh3D
virtual float	getVolume () const
	Gets the volume of the mesh.

virtual float	getArea () const
	Returns always 0.

Public Member Functions inherited from PbMesh
	PbMesh (SbBool is_data_duplicated=TRUE)
	Constructor.

	PbMesh (const PbMesh &mesh)
	Copy constructor.

	~PbMesh ()
	Destructor.

PbMesh &	operator= (const PbMesh &mesh)
	Assignment operator.

int	getNumNodes () const
	Gets the number of nodes in the mesh.

int	getNumCells () const
	Gets the number of cells in the mesh.

SbBox3f	getBoundingBox () const
	Gets the bounding box of the mesh.

SbBool	isDataDuplicated () const
	Returns TRUE if mesh's data are duplicated, FALSE otherwise.

virtual void	addValuesSet (int set_index, const float *val, const SbString &set_name="")
	Adds a set of scalar values.

void	addValuesSet (int set_index, const float *val, DataBinding binding, const SbString &set_name="")
	Adds a set of scalar values that can be located either at nodes or at cells.

DataBinding	getValuesBinding (int set_index) const
	Gets the binding of the scalar value set.

virtual void	addStringsSet (int set_index, const SbString *val, const SbString &set_name="")
	Adds a set of string values .

virtual void	addVecsSet (int set_index, const SbVec3f *val, const SbString &set_name="")
	Adds a set of vector values .

virtual const SbString *	getValuesSetName (int set_index) const
	Gets the name associated to a scalar values set.

virtual const SbString *	getStringsSetName (int set_index) const
	Gets the name associated to a string values set.

virtual const SbString *	getVecsSetName (int set_index) const
	Gets the name associated to a vec values set.

virtual const float *	getValuesSet (int set_index) const
	Gets a set of scalar values.

virtual const SbString *	getStringsSet (int set_index) const
	Gets a set of string values.

virtual const SbVec3f *	getVecsSet (int set_index) const
	Gets a set of vector values.

virtual SbBool	removeValuesSet (int set_index)
	Remove a set of scalar values.

virtual SbBool	removeStringsSet (int set_index)
	Remove a set of string values.

virtual SbBool	removeVecsSet (int set_index)
	Remove a set of vector values.

virtual void	removeAllValuesSet ()
	Remove all sets of scalar values.

virtual void	removeAllStringsSet ()
	Remove all sets of strings values.

virtual void	removeAllVecsSet ()
	Remove all sets of vector values.

virtual int	getNumValuesSet () const
	Gets the number of set of scalar values.

virtual int	getNumStringsSet () const
	Gets the number of set of string values.

virtual int	getNumVecsSet () const
	Gets the number of set of vector values.

virtual SbBool	getMinValuesSet (int set_index, float &min) const
	Gets the min of a set of scalars.

virtual SbBool	getMinVecsSet (int set_index, float &min) const
	Gets the min module of a set of vectors.

virtual SbBool	getMaxValuesSet (int set_index, float &max) const
	Gets the max of a set of scalars.

virtual SbBool	getMaxVecsSet (int set_index, float &max) const
	Gets the max module of a set of vectors.

virtual void	getNodesOwnerCellsInd (const PbArrayOfInt &nod_indices, PbArrayOfInt &owner_cells) const
	Gets the list of indices of cells that own the list of nodes "nod_indices".

virtual SbBox3f	getSmallestCellBox (int &cell_index) const
	Gets the smallest cell's bounding box, returns also the index of this cell.

virtual SbBox3f	getBiggestCellBox (int &cell_index) const
	Gets the biggest cell's bounding box, returns also the index of this cell.

virtual const PbCell *	findContainingCell (const SbVec3f &point, float tolerance, SbVec3f &pcoord, const PbCell *adjacent_cell) const

virtual const PbCell *	findContainingCell (const SbVec3f &point, float tolerance, SbVec3f &pcoord) const
	Find the cell that contains the point.

Public Member Functions inherited from PbBase
void	enableConnection (SbBool flag)
	Activates/deactivates the mechanism of connection.

SbBool	isConnectionEnabled () const
	Returns TRUE if the connection mechanism is active, otherwise FALSE.

void	touch ()
	Simulates the changing of an instance of this object, so all connected objects are informed of this change.

PbBase &	operator= (const PbBase &base)
	Assignment operator.

Friends
int	operator== (const PbCartesianGrid3D &m1, const PbCartesianGrid3D &m2)
	Equality comparison operator.

int	operator!= (const PbCartesianGrid3D &m1, const PbCartesianGrid3D &m2)
	Inequality comparison operator.

Additional Inherited Members
Public Types inherited from PbMesh
enum	DataBinding { PER_CELL = PoMeshProperty::PER_CELL , PER_NODE = PoMeshProperty::PER_NODE }
	Data binding. More...

Detailed Description

Defines a cartesian grid volume mesh.

Class to define a mesh represented by a 3D grid with cartesian coordinates. This mesh is defined by a matrix num_x * num_y * num_z points forming (num_x - 1) * (num_y - 1) * (num_z - 1) hexahedrons. Each point with index (i, j,k) in the mesh (except for points along the mesh border) is connected to six points with indices (i+1,j,k), (i,j+1,k), (i-1,j,k), (i,j-1,k), (i,j,k+1), (i,j,k-1). The values on the mesh nodes are defined by the addValuesSet() method, where val argument is an array of num_x * num_y * num_z floats.

Definition at line 46 of file PbCartesianGrid3D.h.

Constructor & Destructor Documentation

◆ PbCartesianGrid3D() [1/3]

PbCartesianGrid3D::PbCartesianGrid3D ( SbBool is_data_duplicated = TRUE )

Constructor.

See also PbMesh for more explanations about data duplication.

◆ PbCartesianGrid3D() [2/3]

PbCartesianGrid3D::PbCartesianGrid3D ( const PbCartesianGrid3D & )

Copy constructor.

◆ PbCartesianGrid3D() [3/3]

PbCartesianGrid3D::PbCartesianGrid3D	(	int	num_x,
		int	num_y,
		int	num_z,
		const float *	xnod,
		const float *	ynod,
		const float *	znod,
		SbBool	is_data_duplicated = `TRUE`
	)

Constructor of a volume mesh.

See also PbMesh for more explanations about data duplication.

◆ ~PbCartesianGrid3D()

PbCartesianGrid3D::~PbCartesianGrid3D ( )

Destructor.

Member Function Documentation

◆ getCell()

virtual const PbCell * PbCartesianGrid3D::getCell ( int cell_index ) const

virtual

Gets the cell which index is cell_index.

Returns NULL if the cell does not exist, otherwise returns always a PbHexahedronCell object. Attention! this method returns always the same adress of an internal private cell. This private cell is updated each time getCell is called.

Implements PbMesh.

Reimplemented in PbParalCartesianGrid3D.

◆ getCoordinates()

void PbCartesianGrid3D::getCoordinates	(	const float *&	xnod,
		const float *&	ynod,
		const float *&	znod,
		int &	size_xnod,
		int &	size_ynod,
		int &	size_znod
	)		const

inlinevirtual

Get the current coordinates of the nodes of this mesh.

Idem as getXYZGeometry.

Parameters

xnod	: array of x coordinate of the mesh nodes.
ynod	: array of y coordinate of the mesh nodes.
znod	: array of z coordinate of the mesh nodes.
size_xnod	: size of the array xnod ( = num nodes of this mesh)
size_ynod	: size of the array ynod ( = num nodes of this mesh)
size_znod	: size of the array znod ( = num nodes of this mesh)

Reimplemented from PbMesh.

Reimplemented in PbParalCartesianGrid3D.

Definition at line 106 of file PbCartesianGrid3D.h.

◆ getGeometry() [1/2]

void PbGrid3D::getGeometry	(	int &	num_x,
		int &	num_y,
		int &	num_z,
		const float *&	x,
		const float *&	y,
		const float *&	z
	)		const

Gets the mesh geometry.

x-y-z must be used like a vector (i.e. x[n]).

◆ getGeometry() [2/2]

void PbCartesianGrid3D::getGeometry	(	int &	num_x,
		int &	num_y,
		int &	num_z,
		const float ***&	xa,
		const float ***&	ya,
		const float ***&	za
	)		const

Gets the mesh geometry.

xa-ya-za can be used like a matrix (i.e. xa[i][j][k])

◆ getNodeCoord() [1/2]

SbVec3f PbCartesianGrid3D::getNodeCoord	(	int	i,
		int	j,
		int	k
	)		const

inlinevirtual

Gets the coordinates of a node defined by its i,j,k indices on the grid.

Implements PbGrid3D.

Reimplemented in PbParalCartesianGrid3D.

Definition at line 138 of file PbCartesianGrid3D.h.

◆ getNodeCoord() [2/2]

virtual SbVec3f PbCartesianGrid3D::getNodeCoord ( int nod_index ) const

virtual

Gets the coordinates of a node defined by its index.

Implements PbGrid3D.

Reimplemented in PbParalCartesianGrid3D.

◆ operator=()

PbCartesianGrid3D & PbCartesianGrid3D::operator= ( const PbCartesianGrid3D & mesh )

Assignment operator.

◆ setCoordinates()

void PbCartesianGrid3D::setCoordinates	(	const float *	xnod,
		const float *	ynod,
		const float *	znod
	)

virtual

Set new node coordinates without modifying the mesh topology.

For performance reasons, this method should be called instead of setGeometry when doing a mesh deformation animation. It allows to update the coordinates of a existing level surface, skin, cross section etc, without rebuilding them totally.

Reimplemented from PbMesh.

Reimplemented in PbParalCartesianGrid3D.

Friends And Related Symbol Documentation

◆ operator!=

int operator!=	(	const PbCartesianGrid3D &	m1,
		const PbCartesianGrid3D &	m2
	)

friend

Inequality comparison operator.

Definition at line 85 of file PbCartesianGrid3D.h.

◆ operator==

int operator==	(	const PbCartesianGrid3D &	m1,
		const PbCartesianGrid3D &	m2
	)

friend

Equality comparison operator.

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

MeshViz/3Ddata/PbCartesianGrid3D.h

Open Inventor Release 2023.2.3

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PbCartesianGrid3D() [1/3]

◆ PbCartesianGrid3D() [2/3]

◆ PbCartesianGrid3D() [3/3]

◆ ~PbCartesianGrid3D()

Member Function Documentation

◆ getCell()

◆ getCoordinates()

◆ getGeometry() [1/2]

◆ getGeometry() [2/2]

◆ getNodeCoord() [1/2]

◆ getNodeCoord() [2/2]

◆ operator=()

◆ setCoordinates()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator==