Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkTetra Class Reference

#include <vtkTetra.h>

Inheritance diagram for vtkTetra:

Inheritance graph
[legend]
Collaboration diagram for vtkTetra:

Collaboration graph
[legend]
List of all members.

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.

Examples:
vtkTetra (Examples)
Tests:
vtkTetra (Tests)

Definition at line 41 of file vtkTetra.h.

Public Types

typedef vtkCell3D Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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, vtkPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)
void Clip (double value, vtkDataArray *cellScalars, vtkPointLocator *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 double * GetParametricCoords ()
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])

Static Public Member Functions

static vtkTetraNew ()
static int IsTypeOf (const char *type)
static vtkTetraSafeDownCast (vtkObject *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 derivs[12])
static int * GetEdgeArray (int edgeId)
static int * GetFaceArray (int faceId)

Protected Member Functions

 vtkTetra ()
 ~vtkTetra ()

Protected Attributes

vtkLineLine
vtkTriangleTriangle


Member Typedef Documentation

typedef vtkCell3D vtkTetra::Superclass
 

Reimplemented from vtkCell3D.

Definition at line 45 of file vtkTetra.h.


Constructor & Destructor Documentation

vtkTetra::vtkTetra  )  [protected]
 

vtkTetra::~vtkTetra  )  [protected]
 


Member Function Documentation

static vtkTetra* vtkTetra::New  )  [static]
 

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkTetra::GetClassName  )  [virtual]
 

Reimplemented from vtkCell3D.

static int vtkTetra::IsTypeOf const char *  type  )  [static]
 

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

Reimplemented from vtkCell3D.

virtual int vtkTetra::IsA const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkCell3D.

static vtkTetra* vtkTetra::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkCell3D.

virtual void vtkTetra::GetEdgePoints int  edgeId,
int *&  pts
[virtual]
 

See vtkCell3D API for description of these methods.

Implements vtkCell3D.

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.

int vtkTetra::GetCellType  )  [inline, virtual]
 

See the vtkCell API for descriptions of these methods.

Implements vtkCell.

Definition at line 55 of file vtkTetra.h.

References VTK_TETRA.

int vtkTetra::GetNumberOfEdges  )  [inline, virtual]
 

Return the number of edges in the cell.

Implements vtkCell.

Definition at line 56 of file vtkTetra.h.

int vtkTetra::GetNumberOfFaces  )  [inline, virtual]
 

Return the number of faces in the cell.

Implements vtkCell.

Definition at line 57 of file vtkTetra.h.

vtkCell* vtkTetra::GetEdge int  edgeId  )  [virtual]
 

Return the edge cell from the edgeId of the cell.

Implements vtkCell.

vtkCell* vtkTetra::GetFace int  faceId  )  [virtual]
 

Return the face cell from the faceId of the cell.

Implements vtkCell.

void vtkTetra::Contour double  value,
vtkDataArray cellScalars,
vtkPointLocator 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.)

Implements vtkCell.

void vtkTetra::Clip double  value,
vtkDataArray cellScalars,
vtkPointLocator 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.

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) or outside(=0) cell; 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 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.

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 and tolerance. The method returns non-zero value if intersection occurs.

Implements vtkCell.

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.

Implements vtkCell.

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.

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.

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.

int vtkTetra::GetParametricCenter double  pcoords[3]  )  [inline, virtual]
 

Return the center of the tetrahedron in parametric coordinates.

Reimplemented from vtkCell.

Definition at line 165 of file vtkTetra.h.

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.

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,

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.

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.

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.

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.

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.

static void vtkTetra::InterpolationFunctions double  pcoords[3],
double  weights[4]
[static]
 

Tetra specific methods.

static void vtkTetra::InterpolationDerivs double  derivs[12]  )  [static]
 

static int* vtkTetra::GetEdgeArray int  edgeId  )  [static]
 

static int* vtkTetra::GetFaceArray int  faceId  )  [static]
 


Member Data Documentation

vtkLine* vtkTetra::Line [protected]
 

Definition at line 157 of file vtkTetra.h.

vtkTriangle* vtkTetra::Triangle [protected]
 

Definition at line 158 of file vtkTetra.h.


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