VTK  9.2.6
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 =========================================================================*/
34 #ifndef vtkWedge_h
35 #define vtkWedge_h
36 
37 #include "vtkCell3D.h"
38 #include "vtkCommonDataModelModule.h" // For export macro
39 
40 class vtkLine;
41 class vtkTriangle;
42 class vtkQuad;
45 
46 class VTKCOMMONDATAMODEL_EXPORT vtkWedge : public vtkCell3D
47 {
48 public:
49  static vtkWedge* New();
50  vtkTypeMacro(vtkWedge, vtkCell3D);
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
54 
57  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
58  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
59  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
60  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
61  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
62  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
63  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
64  bool GetCentroid(double centroid[3]) const override;
65  bool IsInsideOut() override;
67 
71  static constexpr vtkIdType NumberOfPoints = 6;
72 
76  static constexpr vtkIdType NumberOfEdges = 9;
77 
81  static constexpr vtkIdType NumberOfFaces = 5;
82 
87  static constexpr vtkIdType MaximumFaceSize = 4;
88 
94  static constexpr vtkIdType MaximumValence = 3;
95 
97 
100  int GetCellType() override { return VTK_WEDGE; }
101  int GetCellDimension() override { return 3; }
102  int GetNumberOfEdges() override { return static_cast<int>(NumberOfEdges); }
103  int GetNumberOfFaces() override { return static_cast<int>(NumberOfFaces); }
104  vtkCell* GetEdge(int edgeId) override;
105  vtkCell* GetFace(int faceId) override;
106  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
107  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
108  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
109  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) 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 
133  int GetParametricCenter(double pcoords[3]) override;
134 
135  static void InterpolationFunctions(const double pcoords[3], double weights[6]);
136  static void InterpolationDerivs(const double pcoords[3], double derivs[18]);
138 
142  void InterpolateFunctions(const double pcoords[3], double weights[6]) override
143  {
144  vtkWedge::InterpolationFunctions(pcoords, weights);
145  }
146  void InterpolateDerivs(const double pcoords[3], double derivs[18]) override
147  {
148  vtkWedge::InterpolationDerivs(pcoords, derivs);
149  }
150  int JacobianInverse(const double pcoords[3], double** inverse, double derivs[18]);
152 
154 
162  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
163  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(MaximumFaceSize + 1);
165 
169  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
170 
174  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(4);
175 
179  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
180 
184  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
185 
189  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
190 
194  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
195 
196 protected:
197  vtkWedge();
198  ~vtkWedge() override;
199 
203 
204 private:
205  vtkWedge(const vtkWedge&) = delete;
206  void operator=(const vtkWedge&) = delete;
207 };
208 
209 inline int vtkWedge::GetParametricCenter(double pcoords[3])
210 {
211  pcoords[0] = pcoords[1] = 0.333333;
212  pcoords[2] = 0.5;
213  return 0;
214 }
215 
216 #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:41
represent and manipulate cell attribute data
Definition: vtkCellData.h:41
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:38
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
int vtkIdType
Definition: vtkType.h:332
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:38
void InterpolateFunctions(const double pcoords[3], double weights[6]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkWedge.h:142
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:33
abstract class to specify cell behavior
Definition: vtkCell.h:60
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:100
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:101
a simple class to control print indentation
Definition: vtkIndent.h:39
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:33
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:102
dataset represents arbitrary combinations of all possible cell types
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
vtkLine * Line
Definition: vtkWedge.h:200
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:202
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkWedge.h:103
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:186
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:146
a cell that represents a triangle
Definition: vtkTriangle.h:38
int GetParametricCenter(double pcoords[3]) override
Return the center of the wedge in parametric coordinates.
Definition: vtkWedge.h:209
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:201
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:46
represent and manipulate 3D points
Definition: vtkPoints.h:39
virtual vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds)=0
Get the ids of the incident edges to point of id pointId.