VTK  9.3.1
vtkWedge.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
22 #ifndef vtkWedge_h
23 #define vtkWedge_h
24 
25 #include "vtkCell3D.h"
26 #include "vtkCommonDataModelModule.h" // For export macro
27 
28 VTK_ABI_NAMESPACE_BEGIN
29 class vtkLine;
30 class vtkTriangle;
31 class vtkQuad;
34 
35 class VTKCOMMONDATAMODEL_EXPORT vtkWedge : public vtkCell3D
36 {
37 public:
38  static vtkWedge* New();
39  vtkTypeMacro(vtkWedge, vtkCell3D);
40  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
43 
46  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
47  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
48  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
49  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
50  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
51  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
52  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
53  bool GetCentroid(double centroid[3]) const override;
54  bool IsInsideOut() override;
56 
60  static constexpr vtkIdType NumberOfPoints = 6;
61 
65  static constexpr vtkIdType NumberOfEdges = 9;
66 
70  static constexpr vtkIdType NumberOfFaces = 5;
71 
76  static constexpr vtkIdType MaximumFaceSize = 4;
77 
83  static constexpr vtkIdType MaximumValence = 3;
84 
86 
89  int GetCellType() override { return VTK_WEDGE; }
90  int GetCellDimension() override { return 3; }
91  int GetNumberOfEdges() override { return static_cast<int>(NumberOfEdges); }
92  int GetNumberOfFaces() override { return static_cast<int>(NumberOfFaces); }
93  vtkCell* GetEdge(int edgeId) override;
94  vtkCell* GetFace(int faceId) override;
95  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
96  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
97  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
98  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
99  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
100  double& dist2, double weights[]) override;
101  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
102  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
103  double pcoords[3], int& subId) override;
104  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
105  void Derivatives(
106  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
107  double* GetParametricCoords() override;
109 
117  static int* GetTriangleCases(int caseId);
118 
122  int GetParametricCenter(double pcoords[3]) override;
123 
124  static void InterpolationFunctions(const double pcoords[3], double weights[6]);
125  static void InterpolationDerivs(const double pcoords[3], double derivs[18]);
127 
131  void InterpolateFunctions(const double pcoords[3], double weights[6]) override
132  {
133  vtkWedge::InterpolationFunctions(pcoords, weights);
134  }
135  void InterpolateDerivs(const double pcoords[3], double derivs[18]) override
136  {
137  vtkWedge::InterpolationDerivs(pcoords, derivs);
138  }
139  int JacobianInverse(const double pcoords[3], double** inverse, double derivs[18]);
141 
143 
151  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
152  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(MaximumFaceSize + 1);
154 
158  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
159 
163  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(4);
164 
168  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
169 
173  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
174 
178  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
179 
183  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
184 
185 protected:
186  vtkWedge();
187  ~vtkWedge() override;
188 
192 
193 private:
194  vtkWedge(const vtkWedge&) = delete;
195  void operator=(const vtkWedge&) = delete;
196 };
197 
198 inline int vtkWedge::GetParametricCenter(double pcoords[3])
199 {
200  pcoords[0] = pcoords[1] = 0.333333;
201  pcoords[2] = 0.5;
202  return 0;
203 }
204 
205 VTK_ABI_NAMESPACE_END
206 #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.
represent and manipulate point attribute data
Definition: vtkPointData.h:29
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.
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:27
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
int vtkIdType
Definition: vtkType.h:315
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:27
void InterpolateFunctions(const double pcoords[3], double weights[6]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkWedge.h:131
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.
static void InterpolationFunctions(const double pcoords[3], double weights[6])
virtual void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts)=0
Get the pair of vertices that define an edge.
cell represents a 1D line
Definition: vtkLine.h:22
abstract class to specify cell behavior
Definition: vtkCell.h:49
static void InterpolationDerivs(const double pcoords[3], double derivs[18])
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 GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:89
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:90
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.
list of point or cell ids
Definition: vtkIdList.h:22
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:91
dataset represents arbitrary combinations of all possible cell types
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:44
vtkLine * Line
Definition: vtkWedge.h:189
virtual vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts)=0
Get the ids of a one-ring surrounding point of id pointId.
#define VTK_SIZEHINT(...)
vtkQuad * Quad
Definition: vtkWedge.h:191
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:92
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.
void InterpolateDerivs(const double pcoords[3], double derivs[18]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkWedge.h:135
a cell that represents a triangle
Definition: vtkTriangle.h:27
int GetParametricCenter(double pcoords[3]) override
Return the center of the wedge in parametric coordinates.
Definition: vtkWedge.h:198
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 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.
vtkTriangle * Triangle
Definition: vtkWedge.h:190
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.
a 3D cell that represents a linear wedge
Definition: vtkWedge.h:35
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.