VTK  9.3.1
vtkTetra.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
21 #ifndef vtkTetra_h
22 #define vtkTetra_h
23 
24 #include "vtkCell3D.h"
25 #include "vtkCommonDataModelModule.h" // For export macro
26 
27 VTK_ABI_NAMESPACE_BEGIN
28 class vtkLine;
29 class vtkTriangle;
32 
33 class VTKCOMMONDATAMODEL_EXPORT vtkTetra : public vtkCell3D
34 {
35 public:
36  static vtkTetra* New();
37  vtkTypeMacro(vtkTetra, vtkCell3D);
38  void PrintSelf(ostream& os, vtkIndent indent) override;
39 
41 
44  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
45  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
46  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
47  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
48  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
49  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
50  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
51  bool GetCentroid(double centroid[3]) const override;
52  bool IsInsideOut() override;
54 
58  static constexpr vtkIdType NumberOfPoints = 4;
59 
63  static constexpr vtkIdType NumberOfEdges = 6;
64 
68  static constexpr vtkIdType NumberOfFaces = 4;
69 
74  static constexpr vtkIdType MaximumFaceSize = 3;
75 
81  static constexpr vtkIdType MaximumValence = 3;
82 
84 
87  int GetCellType() override { return VTK_TETRA; }
88  int GetNumberOfEdges() override { return 6; }
89  int GetNumberOfFaces() override { return 4; }
90  vtkCell* GetEdge(int edgeId) override;
91  vtkCell* GetFace(int faceId) override;
92  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
93  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
94  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
95  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
96  vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
97  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
98  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
99  double& dist2, double weights[]) override;
100  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
101  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
102  double pcoords[3], int& subId) override;
103  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
104  void Derivatives(
105  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
106  double* GetParametricCoords() override;
108 
116  static int* GetTriangleCases(int caseId);
117 
123  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
124 
128  int GetParametricCenter(double pcoords[3]) override;
129 
134  double GetParametricDistance(const double pcoords[3]) override;
135 
139  static void TetraCenter(double p1[3], double p2[3], double p3[3], double p4[3], double center[3]);
140 
146  static double Circumsphere(
147  double x1[3], double x2[3], double x3[3], double x4[3], double center[3]);
148 
154  static double Insphere(double p1[3], double p2[3], double p3[3], double p4[3], double center[3]);
155 
168  static int BarycentricCoords(
169  double x[3], double x1[3], double x2[3], double x3[3], double x4[3], double bcoords[4]);
170 
175  static double ComputeVolume(double p1[3], double p2[3], double p3[3], double p4[3]);
176 
182  int JacobianInverse(double** inverse, double derivs[12]);
183 
184  static void InterpolationFunctions(const double pcoords[3], double weights[4]);
185  static void InterpolationDerivs(const double pcoords[3], double derivs[12]);
187 
191  void InterpolateFunctions(const double pcoords[3], double weights[4]) override
192  {
193  vtkTetra::InterpolationFunctions(pcoords, weights);
194  }
195  void InterpolateDerivs(const double pcoords[3], double derivs[12]) override
196  {
197  vtkTetra::InterpolationDerivs(pcoords, derivs);
198  }
200 
202 
210  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
211  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(3);
213 
217  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
218 
222  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(3);
223 
227  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
228 
232  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
233 
237  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
238 
242  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
243 
244 protected:
245  vtkTetra();
246  ~vtkTetra() override;
247 
250 
251 private:
252  vtkTetra(const vtkTetra&) = delete;
253  void operator=(const vtkTetra&) = delete;
254 };
255 
256 inline int vtkTetra::GetParametricCenter(double pcoords[3])
257 {
258  pcoords[0] = pcoords[1] = pcoords[2] = 0.25;
259  return 0;
260 }
261 
262 VTK_ABI_NAMESPACE_END
263 #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:87
represent and manipulate point attribute data
Definition: vtkPointData.h:29
void InterpolateFunctions(const double pcoords[3], double weights[4]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkTetra.h:191
represent and manipulate cell attribute data
Definition: vtkCellData.h:30
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])
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
int vtkIdType
Definition: vtkType.h:315
void InterpolateDerivs(const double pcoords[3], double derivs[12]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkTetra.h:195
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:27
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:33
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:22
abstract class to specify cell behavior
Definition: vtkCell.h:49
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:256
a simple class to control print indentation
Definition: vtkIndent.h:28
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:89
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkTetra.h:88
list of point or cell ids
Definition: vtkIdList.h:22
dataset represents arbitrary combinations of all possible cell types
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:44
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:248
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:175
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:27
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.
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:249
represent and manipulate 3D points
Definition: vtkPoints.h:28
virtual vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds)=0
Get the ids of the incident edges to point of id pointId.