VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkTetra Class Reference

a 3D cell that represents a tetrahedron More...

#include <vtkTetra.h>

Inheritance diagram for vtkTetra:
[legend]
Collaboration diagram for vtkTetra:
[legend]

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)
 
vtkTetraNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void GetEdgePoints (int edgeId, int *&pts)
 
virtual void GetFacePoints (int faceId, int *&pts)
 
int GetCellType ()
 
int GetNumberOfEdges ()
 
int GetNumberOfFaces ()
 
vtkCellGetEdge (int edgeId)
 
vtkCellGetFace (int faceId)
 
void Contour (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)
 
void Clip (double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)
 
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)
 
virtual doubleGetParametricCoords ()
 
int CellBoundary (int subId, double pcoords[3], vtkIdList *pts)
 
int GetParametricCenter (double pcoords[3])
 
double GetParametricDistance (double pcoords[3])
 
int JacobianInverse (double **inverse, double derivs[12])
 
virtual void InterpolateFunctions (double pcoords[3], double weights[4])
 
virtual void InterpolateDerivs (double pcoords[3], double derivs[12])
 
- Public Member Functions inherited from vtkCell3D
vtkCell3DNewInstance () const
 
virtual int GetCellDimension ()
 
virtual void SetMergeTolerance (double)
 
virtual double GetMergeTolerance ()
 
- Public Member Functions inherited from vtkCell
vtkCellNewInstance () const
 
void Initialize (int npts, vtkIdType *pts, vtkPoints *p)
 
virtual void ShallowCopy (vtkCell *c)
 
virtual void DeepCopy (vtkCell *c)
 
virtual int IsLinear ()
 
virtual int RequiresInitialization ()
 
virtual void Initialize ()
 
virtual int IsExplicitCell ()
 
virtual int RequiresExplicitFaceRepresentation ()
 
virtual void SetFaces (vtkIdType *vtkNotUsed(faces))
 
virtual vtkIdTypeGetFaces ()
 
vtkPointsGetPoints ()
 
vtkIdType GetNumberOfPoints ()
 
vtkIdListGetPointIds ()
 
vtkIdType GetPointId (int ptId)
 
void GetBounds (double bounds[6])
 
doubleGetBounds ()
 
double GetLength2 ()
 
virtual int IsPrimaryCell ()
 
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
vtkObjectNewInstance () 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)
 
vtkCommandGetCommand (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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
int GetReferenceCount ()
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkTetraNew ()
 
static int IsTypeOf (const char *type)
 
static vtkTetraSafeDownCast (vtkObjectBase *o)
 
static void TetraCenter (double p1[3], double p2[3], double p3[3], double p4[3], double center[3])
 
static double Circumsphere (double p1[3], double p2[3], double p3[3], double p4[3], double center[3])
 
static double Insphere (double p1[3], double p2[3], double p3[3], double p4[3], double center[3])
 
static int BarycentricCoords (double x[3], double x1[3], double x2[3], double x3[3], double x4[3], double bcoords[4])
 
static double ComputeVolume (double p1[3], double p2[3], double p3[3], double p4[3])
 
static void InterpolationFunctions (double pcoords[3], double weights[4])
 
static void InterpolationDerivs (double pcoords[3], double derivs[12])
 
static intGetEdgeArray (int edgeId)
 
static intGetFaceArray (int faceId)
 
- Static Public Member Functions inherited from vtkCell3D
static int IsTypeOf (const char *type)
 
static vtkCell3DSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCell
static int IsTypeOf (const char *type)
 
static vtkCellSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkTetra ()
 
 ~vtkTetra ()
 
- 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

vtkLineLine
 
vtkTriangleTriangle
 
- Protected Attributes inherited from vtkCell3D
vtkOrderedTriangulatorTriangulator
 
double MergeTolerance
 
vtkTetraClipTetra
 
vtkDoubleArrayClipScalars
 
- 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
vtkPointsPoints
 
vtkIdListPointIds
 

Detailed Description

a 3D cell that represents a tetrahedron

vtkTetra is a concrete implementation of vtkCell to represent a 3D tetrahedron. vtkTetra uses the standard isoparametric shape functions for a linear tetrahedron. The tetrahedron is defined by the four points (0-3); where (0,1,2) is the base of the tetrahedron which, using the right hand rule, forms a triangle whose normal points in the direction of the fourth point.

See also
vtkConvexPointSet vtkHexahedron vtkPyramid vtkVoxel vtkWedge
Examples:
vtkTetra (Examples)
Tests:
vtkTetra (Tests)

Definition at line 46 of file vtkTetra.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkTetra.h.

Constructor & Destructor Documentation

◆ vtkTetra()

vtkTetra::vtkTetra ( )
protected

◆ ~vtkTetra()

vtkTetra::~vtkTetra ( )
protected

Member Function Documentation

◆ New()

static vtkTetra* vtkTetra::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkTetra::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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTetra::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCell3D.

◆ NewInstance()

vtkTetra* vtkTetra::NewInstance ( ) const

◆ PrintSelf()

void vtkTetra::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.

◆ GetEdgePoints()

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

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

◆ GetFacePoints()

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

Get the list of vertices that define a face. The list is terminated with a negative number. Note that the vertices are 0-offset; that is, they refer to the ids of the cell, not the point ids of the mesh that the cell belongs to. The faceId must range between 0<=faceId<this->GetNumberOfFaces().

Implements vtkCell3D.

◆ GetCellType()

int vtkTetra::GetCellType ( )
inlinevirtual

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 61 of file vtkTetra.h.

◆ GetNumberOfEdges()

int vtkTetra::GetNumberOfEdges ( )
inlinevirtual

Return the number of edges in the cell.

Implements vtkCell.

Definition at line 62 of file vtkTetra.h.

◆ GetNumberOfFaces()

int vtkTetra::GetNumberOfFaces ( )
inlinevirtual

Return the number of faces in the cell.

Implements vtkCell.

Definition at line 63 of file vtkTetra.h.

◆ GetEdge()

vtkCell* vtkTetra::GetEdge ( int  edgeId)
virtual

Return the edge cell from the edgeId of the cell.

Implements vtkCell.

◆ GetFace()

vtkCell* vtkTetra::GetFace ( int  faceId)
virtual

Return the face cell from the faceId of the cell.

Implements vtkCell.

◆ Contour()

void vtkTetra::Contour ( double  value,
vtkDataArray cellScalars,
vtkIncrementalPointLocator locator,
vtkCellArray verts,
vtkCellArray lines,
vtkCellArray polys,
vtkPointData inPd,
vtkPointData outPd,
vtkCellData inCd,
vtkIdType  cellId,
vtkCellData outCd 
)
virtual

Generate contouring primitives. The scalar list cellScalars are scalar values at each cell point. The point locator is essentially a points list that merges points as they are inserted (i.e., prevents duplicates). Contouring primitives can be vertices, lines, or polygons. It is possible to interpolate point data along the edge by providing input and output point data - if outPd is NULL, then no interpolation is performed. Also, if the output cell data is non-NULL, the cell data from the contoured cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell from which the cell data is copied.)

Reimplemented from vtkCell3D.

◆ Clip()

void vtkTetra::Clip ( double  value,
vtkDataArray cellScalars,
vtkIncrementalPointLocator locator,
vtkCellArray connectivity,
vtkPointData inPd,
vtkPointData outPd,
vtkCellData inCd,
vtkIdType  cellId,
vtkCellData outCd,
int  insideOut 
)
virtual

Cut (or clip) the cell based on the input cellScalars and the specified value. The output of the clip operation will be one or more cells of the same topological dimension as the original cell. The flag insideOut controls what part of the cell is considered inside - normally cell points whose scalar value is greater than "value" are considered inside. If insideOut is on, this is reversed. Also, if the output cell data is non-NULL, the cell data from the clipped cell is passed to the generated contouring primitives. (Note: the CopyAllocate() method must be invoked on both the output cell and point data. The cellId refers to the cell from which the cell data is copied.) (Satisfies vtkCell API.)

Reimplemented from vtkCell3D.

◆ EvaluatePosition()

int vtkTetra::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.

◆ EvaluateLocation()

void vtkTetra::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.

◆ IntersectWithLine()

int vtkTetra::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.

◆ Triangulate()

int vtkTetra::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.

◆ Derivatives()

void vtkTetra::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.

◆ GetParametricCoords()

virtual double* vtkTetra::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.

◆ CellBoundary()

int vtkTetra::CellBoundary ( int  subId,
double  pcoords[3],
vtkIdList pts 
)
virtual

Returns the set of points that are on the boundary of the tetrahedron that are closest parametrically to the point specified. This may include faces, edges, or vertices.

Implements vtkCell.

◆ GetParametricCenter()

int vtkTetra::GetParametricCenter ( double  pcoords[3])
inlinevirtual

Return the center of the tetrahedron in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 187 of file vtkTetra.h.

◆ GetParametricDistance()

double vtkTetra::GetParametricDistance ( double  pcoords[3])
virtual

Return the distance of the parametric coordinate provided to the cell. If inside the cell, a distance of zero is returned.

Reimplemented from vtkCell.

◆ TetraCenter()

static void vtkTetra::TetraCenter ( double  p1[3],
double  p2[3],
double  p3[3],
double  p4[3],
double  center[3] 
)
static

Compute the center of the tetrahedron,

◆ Circumsphere()

static double vtkTetra::Circumsphere ( double  p1[3],
double  p2[3],
double  p3[3],
double  p4[3],
double  center[3] 
)
static

Compute the circumcenter (center[3]) and radius squared (method return value) of a tetrahedron defined by the four points x1, x2, x3, and x4.

◆ Insphere()

static double vtkTetra::Insphere ( double  p1[3],
double  p2[3],
double  p3[3],
double  p4[3],
double  center[3] 
)
static

Compute the center (center[3]) and radius (method return value) of a sphere that just fits inside the faces of a tetrahedron defined by the four points x1, x2, x3, and x4.

◆ BarycentricCoords()

static int vtkTetra::BarycentricCoords ( double  x[3],
double  x1[3],
double  x2[3],
double  x3[3],
double  x4[3],
double  bcoords[4] 
)
static

Given a 3D point x[3], determine the barycentric coordinates of the point. Barycentric coordinates are a natural coordinate system for simplices that express a position as a linear combination of the vertices. For a tetrahedron, there are four barycentric coordinates (because there are four vertices), and the sum of the coordinates must equal 1. If a point x is inside a simplex, then all four coordinates will be strictly positive. If three coordinates are zero (so the fourth =1), then the point x is on a vertex. If two coordinates are zero, the point x is on an edge (and so on). In this method, you must specify the vertex coordinates x1->x4. Returns 0 if tetrahedron is degenerate.

◆ ComputeVolume()

static double vtkTetra::ComputeVolume ( double  p1[3],
double  p2[3],
double  p3[3],
double  p4[3] 
)
static

Compute the volume of a tetrahedron defined by the four points p1, p2, p3, and p4.

◆ JacobianInverse()

int vtkTetra::JacobianInverse ( double **  inverse,
double  derivs[12] 
)

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

◆ InterpolationFunctions()

static void vtkTetra::InterpolationFunctions ( double  pcoords[3],
double  weights[4] 
)
static
Deprecated:
Replaced by vtkTetra::InterpolateFunctions as of VTK 5.2

◆ InterpolationDerivs()

static void vtkTetra::InterpolationDerivs ( double  pcoords[3],
double  derivs[12] 
)
static
Deprecated:
Replaced by vtkTetra::InterpolateDerivs as of VTK 5.2

◆ InterpolateFunctions()

virtual void vtkTetra::InterpolateFunctions ( double  pcoords[3],
double  weights[4] 
)
inlinevirtual

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

Definition at line 158 of file vtkTetra.h.

◆ InterpolateDerivs()

virtual void vtkTetra::InterpolateDerivs ( double  pcoords[3],
double  derivs[12] 
)
inlinevirtual

Definition at line 162 of file vtkTetra.h.

◆ GetEdgeArray()

static int* vtkTetra::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.

◆ GetFaceArray()

static int* vtkTetra::GetFaceArray ( int  faceId)
static

Member Data Documentation

◆ Line

vtkLine* vtkTetra::Line
protected

Definition at line 179 of file vtkTetra.h.

◆ Triangle

vtkTriangle* vtkTetra::Triangle
protected

Definition at line 180 of file vtkTetra.h.


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