vtkHexagonalPrism Class Reference

a 3D cell that represents a prism with hexagonal base More...

#include <vtkHexagonalPrism.h>

Inheritance diagram for vtkHexagonalPrism:

Collaboration diagram for vtkHexagonalPrism:

Public Types
typedef vtkCell3D	Superclass
Public Types inherited from vtkCell3D
typedef vtkCell	Superclass
Public Types inherited from vtkCell
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkHexagonalPrism *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
int	EvaluatePosition (double x[3], double *closestPoint, int &subId, double pcoords[3], double &dist2, double *weights)
void	EvaluateLocation (int &subId, double pcoords[3], double x[3], double *weights)
int	IntersectWithLine (double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)
int	Triangulate (int index, vtkIdList *ptIds, vtkPoints *pts)
void	Derivatives (int subId, double pcoords[3], double *values, int dim, double *derivs)
double *	GetParametricCoords ()
int	GetParametricCenter (double pcoords[3])
void	JacobianInverse (double pcoords[3], double **inverse, double derivs[36])
virtual void	GetEdgePoints (int edgeId, int *&pts)
virtual void	GetFacePoints (int faceId, int *&pts)
int	GetCellType ()
int	GetCellDimension ()
int	GetNumberOfEdges ()
int	GetNumberOfFaces ()
vtkCell *	GetEdge (int edgeId)
vtkCell *	GetFace (int faceId)
int	CellBoundary (int subId, double pcoords[3], vtkIdList *pts)
virtual void	InterpolateFunctions (double pcoords[3], double weights[12])
virtual void	InterpolateDerivs (double pcoords[3], double derivs[36])
Public Member Functions inherited from vtkCell3D
vtkCell3D *	NewInstance () const
virtual void	Contour (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)
virtual void	Clip (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)
virtual void	SetMergeTolerance (double)
virtual double	GetMergeTolerance ()
Public Member Functions inherited from vtkCell
vtkCell *	NewInstance () const
void	Initialize (int npts, vtkIdType *pts, vtkPoints *p)
virtual void	ShallowCopy (vtkCell *c)
virtual void	DeepCopy (vtkCell *c)
virtual int	IsLinear ()
virtual int	IsExplicitCell ()
vtkPoints *	GetPoints ()
vtkIdType	GetNumberOfPoints ()
vtkIdList *	GetPointIds ()
vtkIdType	GetPointId (int ptId)
void	GetBounds (double bounds[6])
double *	GetBounds ()
double	GetLength2 ()
virtual double	GetParametricDistance (double pcoords[3])
virtual int	IsPrimaryCell ()
virtual int	RequiresInitialization ()
virtual void	Initialize ()
virtual int	RequiresExplicitFaceRepresentation ()
virtual void	SetFaces (vtkIdType *vtkNotUsed(faces))
virtual vtkIdType *	GetFaces ()
virtual void	InterpolateFunctions (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
virtual void	InterpolateDerivs (double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static vtkHexagonalPrism *	New ()
static int	IsTypeOf (const char *type)
static vtkHexagonalPrism *	SafeDownCast (vtkObjectBase *o)
static void	InterpolationFunctions (double pcoords[3], double weights[12])
static void	InterpolationDerivs (double pcoords[3], double derivs[36])
static int *	GetEdgeArray (int edgeId)
static int *	GetFaceArray (int faceId)
Static Public Member Functions inherited from vtkCell3D
static int	IsTypeOf (const char *type)
static vtkCell3D *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkCell
static int	IsTypeOf (const char *type)
static vtkCell *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkHexagonalPrism ()
	~vtkHexagonalPrism ()
Protected Member Functions inherited from vtkCell3D
	vtkCell3D ()
	~vtkCell3D ()
Protected Member Functions inherited from vtkCell
	vtkCell ()
	~vtkCell ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkLine *	Line
vtkQuad *	Quad
vtkPolygon *	Polygon
Protected Attributes inherited from vtkCell3D
vtkOrderedTriangulator *	Triangulator
double	MergeTolerance
vtkTetra *	ClipTetra
vtkDoubleArray *	ClipScalars
Protected Attributes inherited from vtkCell
double	Bounds [6]
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkCell
vtkPoints *	Points
vtkIdList *	PointIds

Detailed Description

a 3D cell that represents a prism with hexagonal base

vtkHexagonalPrism is a concrete implementation of vtkCell to represent a linear 3D prism with hexagonal base. Such prism is defined by the twelve points (0-12) where (0,1,2,3,4,5) is the base of the prism which, using the right hand rule, forms a hexagon whose normal points is in the direction of the opposite face (6,7,8,9,10,11).

Thanks:

Thanks to Philippe Guerville who developed this class. Thanks to Charles Pignerol (CEA-DAM, France) who ported this class under VTK 4. Thanks to Jean Favre (CSCS, Switzerland) who contributed to integrate this class in VTK. Please address all comments to Jean Favre (jfavre at cscs.ch).

Tests:

vtkHexagonalPrism (Tests)

Definition at line 47 of file vtkHexagonalPrism.h.

Member Typedef Documentation

typedef vtkCell3D vtkHexagonalPrism::Superclass

Definition at line 51 of file vtkHexagonalPrism.h.

Constructor & Destructor Documentation

vtkHexagonalPrism::vtkHexagonalPrism ( )

protected

vtkHexagonalPrism::~vtkHexagonalPrism ( )

protected

Member Function Documentation

static vtkHexagonalPrism* vtkHexagonalPrism::New ( )

static

static int vtkHexagonalPrism::IsTypeOf ( const char *  type )

static

virtual int vtkHexagonalPrism::IsA ( const char *  name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCell3D.

static vtkHexagonalPrism* vtkHexagonalPrism::SafeDownCast ( vtkObjectBase *  o )

static

virtual vtkObjectBase* vtkHexagonalPrism::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCell3D.

vtkHexagonalPrism* vtkHexagonalPrism::NewInstance

(

)

const

void vtkHexagonalPrism::PrintSelf ( ostream &  os, vtkIndent  indent  )

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkCell3D.

virtual void vtkHexagonalPrism::GetEdgePoints ( int  edgeId, int *&  pts  )

virtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

virtual void vtkHexagonalPrism::GetFacePoints ( int  faceId, int *&  pts  )

virtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

int vtkHexagonalPrism::GetCellType ( )

inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 62 of file vtkHexagonalPrism.h.

int vtkHexagonalPrism::GetCellDimension ( )

inlinevirtual

See the vtkCell API for descriptions of these methods.

Reimplemented from vtkCell3D.

Definition at line 63 of file vtkHexagonalPrism.h.

int vtkHexagonalPrism::GetNumberOfEdges ( )

inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 64 of file vtkHexagonalPrism.h.

int vtkHexagonalPrism::GetNumberOfFaces ( )

inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 65 of file vtkHexagonalPrism.h.

vtkCell* vtkHexagonalPrism::GetEdge ( int  edgeId )

virtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

vtkCell* vtkHexagonalPrism::GetFace ( int  faceId )

virtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkHexagonalPrism::CellBoundary ( int  subId, double  pcoords[3], vtkIdList *  pts  )

virtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

int vtkHexagonalPrism::EvaluatePosition ( double  x[3], double *  closestPoint, int &  subId, double  pcoords[3], double &  dist2, double *  weights  )

virtual

Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; evaluate parametric coordinates, sub-cell id (!=0 only if cell is composite), distance squared of point x[3] to cell (in particular, the sub-cell indicated), closest point on cell to x[3] (unless closestPoint is null, in which case, the closest point and dist2 are not found), and interpolation weights in cell. (The number of weights is equal to the number of points defining the cell). Note: on rare occasions a -1 is returned from the method. This means that numerical error has occurred and all data returned from this method should be ignored. Also, inside/outside is determine parametrically. That is, a point is inside if it satisfies parametric limits. This can cause problems for cells of topological dimension 2 or less, since a point in 3D can project onto the cell within parametric limits but be "far" from the cell. Thus the value dist2 may be checked to determine true in/out.

Implements vtkCell.

void vtkHexagonalPrism::EvaluateLocation ( int &  subId, double  pcoords[3], double  x[3], double *  weights  )

virtual

Determine global coordinate (x[3]) from subId and parametric coordinates. Also returns interpolation weights. (The number of weights is equal to the number of points in the cell.)

Implements vtkCell.

int vtkHexagonalPrism::IntersectWithLine ( double  p1[3], double  p2[3], double  tol, double &  t, double  x[3], double  pcoords[3], int &  subId  )

virtual

Intersect with a ray. Return parametric coordinates (both line and cell) and global intersection coordinates, given ray definition p1[3], p2[3] and tolerance tol. The method returns non-zero value if intersection occurs. A parametric distance t between 0 and 1 along the ray representing the intersection point, the point coordinates x[3] in data coordinates and also pcoords[3] in parametric coordinates. subId is the index within the cell if a composed cell like a triangle strip.

Implements vtkCell.

int vtkHexagonalPrism::Triangulate ( int  index, vtkIdList *  ptIds, vtkPoints *  pts  )

virtual

Generate simplices of proper dimension. If cell is 3D, tetrahedron are generated; if 2D triangles; if 1D lines; if 0D points. The form of the output is a sequence of points, each n+1 points (where n is topological cell dimension) defining a simplex. The index is a parameter that controls which triangulation to use (if more than one is possible). If numerical degeneracy encountered, 0 is returned, otherwise 1 is returned. This method does not insert new points: all the points that define the simplices are the points that define the cell.

Implements vtkCell.

void vtkHexagonalPrism::Derivatives ( int  subId, double  pcoords[3], double *  values, int  dim, double *  derivs  )

virtual

Compute derivatives given cell subId and parametric coordinates. The values array is a series of data value(s) at the cell points. There is a one-to-one correspondence between cell point and data value(s). Dim is the number of data values per cell point. Derivs are derivatives in the x-y-z coordinate directions for each data value. Thus, if computing derivatives for a scalar function in a hexahedron, dim=1, 8 values are supplied, and 3 deriv values are returned (i.e., derivatives in x-y-z directions). On the other hand, if computing derivatives of velocity (vx,vy,vz) dim=3, 24 values are supplied ((vx,vy,vz)1, (vx,vy,vz)2, ....()8), and 9 deriv values are returned ((d(vx)/dx),(d(vx)/dy),(d(vx)/dz), (d(vy)/dx),(d(vy)/dy), (d(vy)/dz), (d(vz)/dx),(d(vz)/dy),(d(vz)/dz)).

Implements vtkCell.

double* vtkHexagonalPrism::GetParametricCoords ( )

virtual

Return a contiguous array of parametric coordinates of the points defining this cell. In other words, (px,py,pz, px,py,pz, etc..) The coordinates are ordered consistent with the definition of the point ordering for the cell. This method returns a non-NULL pointer when the cell is a primary type (i.e., IsPrimaryCell() is true). Note that 3D parametric coordinates are returned no matter what the topological dimension of the cell.

Reimplemented from vtkCell.

int vtkHexagonalPrism::GetParametricCenter ( double  pcoords[3] )

inlinevirtual

Return the center of the wedge in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 131 of file vtkHexagonalPrism.h.

static void vtkHexagonalPrism::InterpolationFunctions ( double  pcoords[3], double  weights[12]  )

static

Deprecated:

Replaced by vtkHexagonalPrism::InterpolateFunctions as of VTK 5.2

static void vtkHexagonalPrism::InterpolationDerivs ( double  pcoords[3], double  derivs[36]  )

static

Deprecated:

Replaced by vtkHexagonalPrism::InterpolateDerivs as of VTK 5.2

virtual void vtkHexagonalPrism::InterpolateFunctions ( double  pcoords[3], double  weights[12]  )

inlinevirtual

Compute the interpolation functions/derivatives (aka shape functions/derivatives)

Definition at line 95 of file vtkHexagonalPrism.h.

virtual void vtkHexagonalPrism::InterpolateDerivs ( double  pcoords[3], double  derivs[36]  )

inlinevirtual

Compute the interpolation functions/derivatives (aka shape functions/derivatives)

Definition at line 99 of file vtkHexagonalPrism.h.

static int* vtkHexagonalPrism::GetEdgeArray ( int  edgeId )

static

Return the ids of the vertices defining edge/face (edgeId/`faceId'). Ids are related to the cell, not to the dataset.

static int* vtkHexagonalPrism::GetFaceArray ( int  faceId )

static

Return the ids of the vertices defining edge/face (edgeId/`faceId'). Ids are related to the cell, not to the dataset.

void vtkHexagonalPrism::JacobianInverse	(	double	pcoords[3],
		double **	inverse,
		double	derivs[36]
	)

Given parametric coordinates compute inverse Jacobian transformation matrix. Returns 9 elements of 3x3 inverse Jacobian plus interpolation function derivatives.

Member Data Documentation

vtkLine* vtkHexagonalPrism::Line

protected

Definition at line 121 of file vtkHexagonalPrism.h.

vtkQuad* vtkHexagonalPrism::Quad

protected

Definition at line 122 of file vtkHexagonalPrism.h.

vtkPolygon* vtkHexagonalPrism::Polygon

protected

Definition at line 123 of file vtkHexagonalPrism.h.

---

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

• /home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkHexagonalPrism.h