VTK  9.0.1
vtkTetra.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkTetra.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
30 #ifndef vtkTetra_h
31 #define vtkTetra_h
32 
33 #include "vtkCell3D.h"
34 #include "vtkCommonDataModelModule.h" // For export macro
35 
36 class vtkLine;
37 class vtkTriangle;
40 
41 class VTKCOMMONDATAMODEL_EXPORT vtkTetra : public vtkCell3D
42 {
43 public:
44  static vtkTetra* New();
45  vtkTypeMacro(vtkTetra, vtkCell3D);
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47 
49 
52  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
53  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
54  VTK_LEGACY(virtual void GetEdgePoints(int edgeId, int*& pts) override);
55  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
56  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
57  VTK_LEGACY(virtual void GetFacePoints(int faceId, int*& pts) override);
58  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
59  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
60  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
61  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
62  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
63  bool GetCentroid(double centroid[3]) const override;
64  bool IsInsideOut() override;
66 
70  static constexpr vtkIdType NumberOfPoints = 4;
71 
75  static constexpr vtkIdType NumberOfEdges = 6;
76 
80  static constexpr vtkIdType NumberOfFaces = 4;
81 
86  static constexpr vtkIdType MaximumFaceSize = 3;
87 
93  static constexpr vtkIdType MaximumValence = 3;
94 
96 
99  int GetCellType() override { return VTK_TETRA; }
100  int GetNumberOfEdges() override { return 6; }
101  int GetNumberOfFaces() override { return 4; }
102  vtkCell* GetEdge(int edgeId) override;
103  vtkCell* GetFace(int faceId) override;
104  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
105  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
106  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
107  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
108  vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
109  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
110  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
111  double& dist2, double weights[]) override;
112  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
113  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
114  double pcoords[3], int& subId) override;
115  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
116  void Derivatives(
117  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
118  double* GetParametricCoords() override;
120 
128  static int* GetTriangleCases(int caseId);
129 
135  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
136 
140  int GetParametricCenter(double pcoords[3]) override;
141 
146  double GetParametricDistance(const double pcoords[3]) override;
147 
151  static void TetraCenter(double p1[3], double p2[3], double p3[3], double p4[3], double center[3]);
152 
158  static double Circumsphere(
159  double p1[3], double p2[3], double p3[3], double p4[3], double center[3]);
160 
166  static double Insphere(double p1[3], double p2[3], double p3[3], double p4[3], double center[3]);
167 
180  static int BarycentricCoords(
181  double x[3], double x1[3], double x2[3], double x3[3], double x4[3], double bcoords[4]);
182 
187  static double ComputeVolume(double p1[3], double p2[3], double p3[3], double p4[3]);
188 
194  int JacobianInverse(double** inverse, double derivs[12]);
195 
196  static void InterpolationFunctions(const double pcoords[3], double weights[4]);
197  static void InterpolationDerivs(const double pcoords[3], double derivs[12]);
199 
203  void InterpolateFunctions(const double pcoords[3], double weights[4]) override
204  {
205  vtkTetra::InterpolationFunctions(pcoords, weights);
206  }
207  void InterpolateDerivs(const double pcoords[3], double derivs[12]) override
208  {
209  vtkTetra::InterpolationDerivs(pcoords, derivs);
210  }
212 
214 
222  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
223  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(3);
225 
229  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
230 
234  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(3);
235 
239  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
240 
244  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
245 
249  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
250 
254  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
255 
256 protected:
257  vtkTetra();
258  ~vtkTetra() override;
259 
262 
263 private:
264  vtkTetra(const vtkTetra&) = delete;
265  void operator=(const vtkTetra&) = delete;
266 };
267 
268 inline int vtkTetra::GetParametricCenter(double pcoords[3])
269 {
270  pcoords[0] = pcoords[1] = pcoords[2] = 0.25;
271  return 0;
272 }
273 
274 #endif
virtual vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds)=0
Get the ids of the adjacent faces to face of id 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) override
Generate contouring primitives.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkTetra.h:99
represent and manipulate point attribute data
Definition: vtkPointData.h:31
void InterpolateFunctions(const double pcoords[3], double weights[4]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkTetra.h:203
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
Abstract class in support of both point location and point insertion.
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
static void InterpolationDerivs(const double pcoords[3], double derivs[12])
int vtkIdType
Definition: vtkType.h:338
void InterpolateDerivs(const double pcoords[3], double derivs[12]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkTetra.h:207
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:38
virtual int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts)=0
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
virtual vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts)=0
Get the list of vertices that define a face.
a 3D cell that represents a tetrahedron
Definition: vtkTetra.h:41
virtual void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts)=0
Get the pair of vertices that define an edge.
virtual double GetParametricDistance(const double pcoords[3])
Return the distance of the parametric coordinate provided to the cell.
cell represents a 1D line
Definition: vtkLine.h:29
abstract class to specify cell behavior
Definition: vtkCell.h:56
virtual void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights)=0
Determine global coordinate (x[3]) from subId and parametric coordinates.
int GetParametricCenter(double pcoords[3]) override
Return the center of the tetrahedron in parametric coordinates.
Definition: vtkTetra.h:268
a simple class to control print indentation
Definition: vtkIndent.h:33
virtual void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&faceIds)=0
Get the ids of the two adjacent faces to edge of id edgeId.
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkTetra.h:101
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkTetra.h:100
list of point or cell ids
Definition: vtkIdList.h:30
dataset represents arbitrary combinations of all possible cell types
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
virtual vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts)=0
Get the ids of a one-ring surrounding point of id pointId.
#define VTK_SIZEHINT(...)
vtkLine * Line
Definition: vtkTetra.h:260
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
virtual int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[])=0
Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; ev...
object to represent cell connectivity
Definition: vtkCellArray.h:179
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
a cell that represents a triangle
Definition: vtkTriangle.h:35
virtual void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs)=0
Compute derivatives given cell subId and parametric coordinates.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void InterpolationFunctions(const double pcoords[3], double weights[4])
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this cell.
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)=0
Intersect with a ray.
virtual vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds)=0
Get the ids of the incident faces point of id pointId.
virtual bool IsInsideOut()
Returns true if the normals of the vtkCell3D point inside the cell.
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
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.
vtkTriangle * Triangle
Definition: vtkTetra.h:261
represent and manipulate 3D points
Definition: vtkPoints.h:33
virtual vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds)=0
Get the ids of the incident edges to point of id pointId.