VTK  9.1.0
vtkWedge.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkWedge.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=========================================================================*/
40#ifndef vtkWedge_h
41#define vtkWedge_h
42
43#include "vtkCell3D.h"
44#include "vtkCommonDataModelModule.h" // For export macro
45
46class vtkLine;
47class vtkTriangle;
48class vtkQuad;
51
52class VTKCOMMONDATAMODEL_EXPORT vtkWedge : public vtkCell3D
53{
54public:
55 static vtkWedge* New();
56 vtkTypeMacro(vtkWedge, vtkCell3D);
57 void PrintSelf(ostream& os, vtkIndent indent) override;
58
60
63 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
64 // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
65 VTK_DEPRECATED_IN_9_0_0("Replaced by vtkWedge::GetEdgePoints(vtkIdType, const vtkIdType*&)")
66 void GetEdgePoints(int edgeId, int*& pts) override;
67 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
68 // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
69 VTK_DEPRECATED_IN_9_0_0("Replaced by vtkWedge::GetFacePoints(vtkIdType, const vtkIdType*&)")
70 void GetFacePoints(int faceId, int*& pts) override;
71 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
72 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
73 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
74 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
75 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
76 bool GetCentroid(double centroid[3]) const override;
77 bool IsInsideOut() override;
79
83 static constexpr vtkIdType NumberOfPoints = 6;
84
88 static constexpr vtkIdType NumberOfEdges = 9;
89
93 static constexpr vtkIdType NumberOfFaces = 5;
94
99 static constexpr vtkIdType MaximumFaceSize = 4;
100
106 static constexpr vtkIdType MaximumValence = 3;
107
109
112 int GetCellType() override { return VTK_WEDGE; }
113 int GetCellDimension() override { return 3; }
114 int GetNumberOfEdges() override { return static_cast<int>(NumberOfEdges); }
115 int GetNumberOfFaces() override { return static_cast<int>(NumberOfFaces); }
116 vtkCell* GetEdge(int edgeId) override;
117 vtkCell* GetFace(int faceId) override;
118 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
119 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
120 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
121 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
122 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
123 double& dist2, double weights[]) override;
124 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
125 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
126 double pcoords[3], int& subId) override;
127 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
129 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
130 double* GetParametricCoords() override;
132
140 static int* GetTriangleCases(int caseId);
141
145 int GetParametricCenter(double pcoords[3]) override;
146
147 static void InterpolationFunctions(const double pcoords[3], double weights[6]);
148 static void InterpolationDerivs(const double pcoords[3], double derivs[18]);
150
154 void InterpolateFunctions(const double pcoords[3], double weights[6]) override
155 {
156 vtkWedge::InterpolationFunctions(pcoords, weights);
157 }
158 void InterpolateDerivs(const double pcoords[3], double derivs[18]) override
159 {
160 vtkWedge::InterpolationDerivs(pcoords, derivs);
161 }
162 int JacobianInverse(const double pcoords[3], double** inverse, double derivs[18]);
164
166
175 static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(MaximumFaceSize + 1);
177
182
187
192
197
202
206 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
207
208protected:
210 ~vtkWedge() override;
211
215
216private:
217 vtkWedge(const vtkWedge&) = delete;
218 void operator=(const vtkWedge&) = delete;
219};
220
221inline int vtkWedge::GetParametricCenter(double pcoords[3])
222{
223 pcoords[0] = pcoords[1] = 0.333333;
224 pcoords[2] = 0.5;
225 return 0;
226}
227
228#endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:40
object to represent cell connectivity
Definition: vtkCellArray.h:190
represent and manipulate cell attribute data
Definition: vtkCellData.h:42
abstract class to specify cell behavior
Definition: vtkCell.h:67
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:59
list of point or cell ids
Definition: vtkIdList.h:40
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:43
cell represents a 1D line
Definition: vtkLine.h:40
represent and manipulate point attribute data
Definition: vtkPointData.h:42
represent and manipulate 3D points
Definition: vtkPoints.h:43
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:45
a cell that represents a triangle
Definition: vtkTriangle.h:45
dataset represents arbitrary combinations of all possible cell types
a 3D cell that represents a linear wedge
Definition: vtkWedge.h:53
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()
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:114
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:115
~vtkWedge() override
static void InterpolationDerivs(const double pcoords[3], double derivs[18])
double * GetParametricCoords() override
See the vtkCell API for descriptions of these methods.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
vtkLine * Line
Definition: vtkWedge.h:212
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
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:154
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions of these methods.
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:113
vtkTriangle * Triangle
Definition: vtkWedge.h:213
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.
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
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:221
vtkQuad * Quad
Definition: vtkWedge.h:214
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.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
See the vtkCell API for descriptions of these methods.
void InterpolateDerivs(const double pcoords[3], double derivs[18]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkWedge.h:158
static const vtkIdType * GetFaceArray(vtkIdType faceId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
int GetCellType(const Ioss::ElementTopology *topology)
Returns VTK celltype for a Ioss topology element.
@ points
Definition: vtkX3D.h:452
@ value
Definition: vtkX3D.h:226
@ index
Definition: vtkX3D.h:252
@ VTK_WEDGE
Definition: vtkCellType.h:59
#define VTK_DEPRECATED_IN_9_0_0(reason)
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)