a 3D cell that represents a convex prism with pentagonal base More...

#include <vtkPentagonalPrism.h>

Inheritance diagram for vtkPentagonalPrism:

Collaboration diagram for vtkPentagonalPrism:

Public Types
typedef vtkCell3D	Superclass

Public Types inherited from vtkCell3D
typedef vtkCell	Superclass

Public Types inherited from vtkCell
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkPentagonalPrism *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

int	EvaluatePosition (const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
	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. More...

void	EvaluateLocation (int &subId, const double pcoords[3], double x[3], double *weights) override
	Determine global coordinate (x[3]) from subId and parametric coordinates. More...

int	IntersectWithLine (const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
	Intersect with a ray. More...

int	Triangulate (int index, vtkIdList ptIds, vtkPoints pts) override
	Generate simplices of proper dimension. More...

void	Derivatives (int subId, const double pcoords[3], const double values, int dim, double derivs) override
	Compute derivatives given cell subId and parametric coordinates. More...

double *	GetParametricCoords () override
	Return a contiguous array of parametric coordinates of the points defining this cell. More...

int	GetParametricCenter (double pcoords[3]) override
	Return the center of the wedge in parametric coordinates. More...

void	JacobianInverse (const double pcoords[3], double **inverse, double derivs[30])
	Given parametric coordinates compute inverse Jacobian transformation matrix. More...


void	GetEdgePoints (int edgeId, int *&pts) override
	See vtkCell3D API for description of these methods. More...

void	GetFacePoints (int faceId, int *&pts) override
	See vtkCell3D API for description of these methods. More...


int	GetCellType () override
	See the vtkCell3D API for descriptions of these methods. More...

int	GetCellDimension () override
	See the vtkCell3D API for descriptions of these methods. More...

int	GetNumberOfEdges () override
	See the vtkCell3D API for descriptions of these methods. More...

int	GetNumberOfFaces () override
	See the vtkCell3D API for descriptions of these methods. More...

vtkCell *	GetEdge (int edgeId) override
	See the vtkCell3D API for descriptions of these methods. More...

vtkCell *	GetFace (int faceId) override
	See the vtkCell3D API for descriptions of these methods. More...

int	CellBoundary (int subId, const double pcoords[3], vtkIdList *pts) override
	See the vtkCell3D API for descriptions of these methods. More...


void	InterpolateFunctions (const double pcoords[3], double weights[10]) override
	Compute the interpolation functions/derivatives (aka shape functions/derivatives) More...

void	InterpolateDerivs (const double pcoords[3], double derivs[30]) override
	Compute the interpolation functions/derivatives (aka shape functions/derivatives) More...

Public Member Functions inherited from vtkCell3D
vtkCell3D *	NewInstance () const

void	Contour (double value, vtkDataArray cellScalars, vtkIncrementalPointLocator locator, vtkCellArray verts, vtkCellArray lines, vtkCellArray polys, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData *outCd) override
	Generate contouring primitives. More...

void	Clip (double value, vtkDataArray cellScalars, vtkIncrementalPointLocator locator, vtkCellArray connectivity, vtkPointData inPd, vtkPointData outPd, vtkCellData inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
	Cut (or clip) the cell based on the input cellScalars and the specified value. More...

virtual void	SetMergeTolerance (double)
	Set the tolerance for merging clip intersection points that are near the vertices of cells. More...

virtual double	GetMergeTolerance ()
	Set the tolerance for merging clip intersection points that are near the vertices of cells. More...

Public Member Functions inherited from vtkCell
vtkCell *	NewInstance () const

void	Initialize (int npts, vtkIdType pts, vtkPoints p)
	Initialize cell from outside with point ids and point coordinates specified. More...

void	Initialize (int npts, vtkPoints *p)
	Initialize the cell with point coordinates specified. More...

virtual void	ShallowCopy (vtkCell *c)
	Copy this cell by reference counting the internal data structures. More...

virtual void	DeepCopy (vtkCell *c)
	Copy this cell by completely copying internal data structures. More...

virtual int	IsLinear ()
	Non-linear cells require special treatment beyond the usual cell type and connectivity list information. More...

virtual int	RequiresInitialization ()
	Some cells require initialization prior to access. More...

virtual void	Initialize ()

virtual int	IsExplicitCell ()
	Explicit cells require additional representational information beyond the usual cell type and connectivity list information. More...

virtual int	RequiresExplicitFaceRepresentation ()
	Determine whether the cell requires explicit face representation, and methods for setting and getting the faces (see vtkPolyhedron for example usage of these methods). More...

virtual void	SetFaces (vtkIdType *vtkNotUsed(faces))

virtual vtkIdType *	GetFaces ()

vtkPoints *	GetPoints ()
	Get the point coordinates for the cell. More...

vtkIdType	GetNumberOfPoints ()
	Return the number of points in the cell. More...

vtkIdList *	GetPointIds ()
	Return the list of point ids defining the cell. More...

vtkIdType	GetPointId (int ptId)
	For cell point i, return the actual point id. More...

void	GetBounds (double bounds[6])
	Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). More...

double *	GetBounds ()
	Compute cell bounding box (xmin,xmax,ymin,ymax,zmin,zmax). More...

double	GetLength2 ()
	Compute Length squared of cell (i.e., bounding box diagonal squared). More...

virtual double	GetParametricDistance (const double pcoords[3])
	Return the distance of the parametric coordinate provided to the cell. More...

virtual int	IsPrimaryCell ()
	Return whether this cell type has a fixed topology or whether the topology varies depending on the data (e.g., vtkConvexPointSet). More...

virtual void	InterpolateFunctions (const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
	Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this level. More...

virtual void	InterpolateDerivs (const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkPentagonalPrism *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPentagonalPrism *	SafeDownCast (vtkObjectBase *o)

static void	InterpolationFunctions (const double pcoords[3], double weights[10])

static void	InterpolationDerivs (const double pcoords[3], double derivs[30])


static int *	GetEdgeArray (int edgeId)
	Return the ids of the vertices defining edge/face (`edgeId`/`faceId'). More...

static int *	GetFaceArray (int faceId)
	Return the ids of the vertices defining edge/face (`edgeId`/`faceId'). More...

Static Public Member Functions inherited from vtkCell3D
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCell3D *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkCell
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCell *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPentagonalPrism ()

	~vtkPentagonalPrism () override

Protected Member Functions inherited from vtkCell3D
	vtkCell3D ()

	~vtkCell3D () override

Protected Member Functions inherited from vtkCell
	vtkCell ()

	~vtkCell () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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

vtkTriangle *	Triangle

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 convex prism with pentagonal base

vtkPentagonalPrism is a concrete implementation of vtkCell to represent a linear convex 3D prism with pentagonal base. Such prism is defined by the ten points (0-9), where (0,1,2,3,4) is the base of the prism which, using the right hand rule, forms a pentagon whose normal points is in the direction of the opposite face (5,6,7,8,9).

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).

Thanks:: The Interpolation functions and derivatives were changed in June 2015 by Bill Lorensen. These changes follow the formulation in: http://dilbert.engr.ucdavis.edu/~suku/nem/papers/polyelas.pdf NOTE: An additional copy of this paper is located at: http://www.vtk.org/Wiki/File:ApplicationOfPolygonalFiniteElementsInLinearElasticity.pdf

Tests:: vtkPentagonalPrism (Tests)

Definition at line 56 of file vtkPentagonalPrism.h.

Member Typedef Documentation

typedef vtkCell3D vtkPentagonalPrism::Superclass

Definition at line 60 of file vtkPentagonalPrism.h.

Constructor & Destructor Documentation

vtkPentagonalPrism::vtkPentagonalPrism ( )

protected

vtkPentagonalPrism::~vtkPentagonalPrism ( )

overrideprotected

Member Function Documentation

static vtkPentagonalPrism* vtkPentagonalPrism::New ( )

static

static vtkTypeBool vtkPentagonalPrism::IsTypeOf ( const char * type )

static

virtual vtkTypeBool vtkPentagonalPrism::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 vtkPentagonalPrism* vtkPentagonalPrism::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkPentagonalPrism::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCell3D.

vtkPentagonalPrism* vtkPentagonalPrism::NewInstance ( ) const

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

overridevirtual

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.

void vtkPentagonalPrism::GetEdgePoints	(	int	edgeId,
		int *&	pts
	)

overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

void vtkPentagonalPrism::GetFacePoints	(	int	faceId,
		int *&	pts
	)

overridevirtual

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

int vtkPentagonalPrism::GetCellType ( )

inlineoverridevirtual