VTK  9.7.0
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
21
22#ifndef vtkWedge_h
23#define vtkWedge_h
24
25#include "vtkCell3D.h"
26#include "vtkCommonDataModelModule.h" // For export macro
27
28VTK_ABI_NAMESPACE_BEGIN
29class vtkLine;
30class vtkTriangle;
31class vtkQuad;
34
35class VTKCOMMONDATAMODEL_EXPORT vtkWedge : public vtkCell3D
36{
37public:
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;
60 static constexpr vtkIdType NumberOfPoints = 6;
61
65 static constexpr vtkIdType NumberOfEdges = 9;
66
70 static constexpr vtkIdType NumberOfFaces = 5;
76 static constexpr vtkIdType MaximumFaceSize = 4;
77
83 static constexpr vtkIdType MaximumValence = 3;
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 void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
100 vtkCellArray* connectivity, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
101 vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
102 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
103 double& dist2, double weights[]) override;
104 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
105 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
106 double pcoords[3], int& subId) override;
107 int TriangulateLocalIds(int index, vtkIdList* ptIds) override;
109 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
110 double* GetParametricCoords() override;
112
120 VTK_DEPRECATED_IN_9_7_0("Use vtkMarchingCellsContourCases::GetWedgeCase instead.")
121 static int* GetTriangleCases(int caseId);
122
126 int GetParametricCenter(double pcoords[3]) override;
127
128 static void InterpolationFunctions(const double pcoords[3], double weights[6]);
129 static void InterpolationDerivs(const double pcoords[3], double derivs[18]);
131
135 void InterpolateFunctions(const double pcoords[3], double weights[6]) override
136 {
137 vtkWedge::InterpolationFunctions(pcoords, weights);
138 }
139 void InterpolateDerivs(const double pcoords[3], double derivs[18]) override
140 {
141 vtkWedge::InterpolationDerivs(pcoords, derivs);
142 }
143 int JacobianInverse(const double pcoords[3], double** inverse, double derivs[18]);
145
147
155 static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
156 static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(MaximumFaceSize + 1);
158
163
168
173
178
183
187 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
188
189protected:
191 ~vtkWedge() override = default;
192
196
197private:
198 vtkWedge(const vtkWedge&) = delete;
199 void operator=(const vtkWedge&) = delete;
200};
201
202inline int vtkWedge::GetParametricCenter(double pcoords[3])
203{
204 pcoords[0] = pcoords[1] = 0.333333;
205 pcoords[2] = 0.5;
206 return 0;
207}
208
209VTK_ABI_NAMESPACE_END
210#endif
object to represent cell connectivity
represent and manipulate cell attribute data
Definition vtkCellData.h:32
list of point or cell ids
Definition vtkIdList.h:26
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition vtkIndent.h:29
cell represents a 1D line
Definition vtkLine.h:23
represent and manipulate point attribute data
represent and manipulate 3D points
Definition vtkPoints.h:31
a cell that represents a 2D quadrilateral
Definition vtkQuad.h:28
Hold a reference to a vtkObjectBase instance.
a cell that represents a triangle
Definition vtkTriangle.h:28
dataset represents arbitrary combinations of all possible cell types
a 3D cell that represents a linear wedge
Definition vtkWedge.h:36
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
See the vtkCell API for descriptions of these methods.
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
See the vtkCell API for descriptions of these methods.
static vtkWedge * New()
void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition vtkWedge.h:91
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition vtkWedge.h:92
vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
static constexpr vtkIdType MaximumFaceSize
static contexpr handle on the maximum face size.
Definition vtkWedge.h:76
static void InterpolationDerivs(const double pcoords[3], double derivs[18])
double * GetParametricCoords() override
See the vtkCell API for descriptions of these methods.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
static constexpr vtkIdType MaximumValence
static constexpr handle on the maximum valence of this cell.
Definition vtkWedge.h:83
static int * GetTriangleCases(int caseId)
Return the case table for table-based isocontouring (aka marching cubes style implementations).
static void InterpolationFunctions(const double pcoords[3], double weights[6])
void InterpolateFunctions(const double pcoords[3], double weights[6]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives).
Definition vtkWedge.h:135
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions of these methods.
vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition vtkWedge.h:90
vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds) override
See vtkCell3D API for description of these methods.
void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
See the vtkCell API for descriptions of these methods.
int TriangulateLocalIds(int index, vtkIdList *ptIds) override
See the vtkCell API for descriptions of these methods.
static constexpr vtkIdType NumberOfEdges
static contexpr handle on the number of faces.
Definition vtkWedge.h:65
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
See the vtkCell API for descriptions of these methods.
bool GetCentroid(double centroid[3]) const override
See vtkCell3D API for description of these methods.
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
int GetParametricCenter(double pcoords[3]) override
Return the center of the wedge in parametric coordinates.
Definition vtkWedge.h:202
static constexpr vtkIdType NumberOfPoints
static constexpr handle on the number of points.
Definition vtkWedge.h:60
static constexpr vtkIdType NumberOfFaces
static contexpr handle on the number of edges.
Definition vtkWedge.h:70
int JacobianInverse(const double pcoords[3], double **inverse, double derivs[18])
Compute the interpolation functions/derivatives (aka shape functions/derivatives).
vtkCell * GetFace(int faceId) override
See the vtkCell API for descriptions of these methods.
int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
See the vtkCell API for descriptions of these methods.
bool IsInsideOut() override
See vtkCell3D API for description of these methods.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition vtkWedge.h:89
void InterpolateDerivs(const double pcoords[3], double derivs[18]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives).
Definition vtkWedge.h:139
@ VTK_WEDGE
Definition vtkCellType.h:50
#define vtkDataArray
#define VTK_DEPRECATED_IN_9_7_0(reason)
vtkQuad * Quad
vtkLine * Line
vtkTriangle * Triangle
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
int vtkIdType
Definition vtkType.h:363
vtkWedge vtkCell3D GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
#define VTK_SIZEHINT(...)