VTK  9.2.6
vtkPyramid.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPyramid.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 vtkPyramid_h
35 #define vtkPyramid_h
36 
37 #include "vtkCell3D.h"
38 #include "vtkCommonDataModelModule.h" // For export macro
39 
40 class vtkLine;
41 class vtkQuad;
42 class vtkTriangle;
45 
46 class VTKCOMMONDATAMODEL_EXPORT vtkPyramid : public vtkCell3D
47 {
48 public:
49  static vtkPyramid* New();
50  vtkTypeMacro(vtkPyramid, 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 = 5;
72 
76  static constexpr vtkIdType NumberOfEdges = 8;
77 
81  static constexpr vtkIdType NumberOfFaces = 5;
82 
87  static constexpr vtkIdType MaximumFaceSize = 4;
88 
94  static constexpr vtkIdType MaximumValence = 4;
96 
99  int GetCellType() override { return VTK_PYRAMID; }
100  int GetCellDimension() override { return 3; }
101  int GetNumberOfEdges() override { return 8; }
102  int GetNumberOfFaces() override { return 5; }
103  vtkCell* GetEdge(int edgeId) override;
104  vtkCell* GetFace(int faceId) override;
105  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
106  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
107  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
108  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
109  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
110  double& dist2, double weights[]) override;
111  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
112  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
113  double pcoords[3], int& subId) override;
114  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
115  void Derivatives(
116  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
117  double* GetParametricCoords() override;
119 
127  static int* GetTriangleCases(int caseId);
128 
132  int GetParametricCenter(double pcoords[3]) override;
133 
134  static void InterpolationFunctions(const double pcoords[3], double weights[5]);
135  static void InterpolationDerivs(const double pcoords[3], double derivs[15]);
137 
141  void InterpolateFunctions(const double pcoords[3], double weights[5]) override
142  {
143  vtkPyramid::InterpolationFunctions(pcoords, weights);
144  }
145  void InterpolateDerivs(const double pcoords[3], double derivs[15]) override
146  {
147  vtkPyramid::InterpolationDerivs(pcoords, derivs);
148  }
150 
151  int JacobianInverse(const double pcoords[3], double** inverse, double derivs[15]);
152 
154 
162  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
163  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
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(4);
180 
184  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(4);
185 
189  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(4);
190 
194  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
195 
196 protected:
197  vtkPyramid();
198  ~vtkPyramid() override;
199 
203 
204 private:
205  vtkPyramid(const vtkPyramid&) = delete;
206  void operator=(const vtkPyramid&) = delete;
207 };
208 
209 //----------------------------------------------------------------------------
210 inline int vtkPyramid::GetParametricCenter(double pcoords[3])
211 {
212  pcoords[0] = pcoords[1] = 0.4;
213  pcoords[2] = 0.2;
214  return 0;
215 }
216 
217 #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.
vtkQuad * Quad
Definition: vtkPyramid.h:202
represent and manipulate point attribute data
Definition: vtkPointData.h:41
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:99
a 3D cell that represents a linear pyramid
Definition: vtkPyramid.h:46
void InterpolateDerivs(const double pcoords[3], double derivs[15]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkPyramid.h:145
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
vtkTriangle * Triangle
Definition: vtkPyramid.h:201
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:100
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:38
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...
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:102
virtual vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts)=0
Get the list of vertices that define a face.
static void InterpolationDerivs(const double pcoords[3], double derivs[15])
static void InterpolationFunctions(const double pcoords[3], double weights[5])
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
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.
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
dataset represents arbitrary combinations of all possible cell types
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
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: vtkPyramid.h:200
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:101
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.
int GetParametricCenter(double pcoords[3]) override
Return the center of the pyramid in parametric coordinates.
Definition: vtkPyramid.h:210
a cell that represents a triangle
Definition: vtkTriangle.h:38
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.
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.
void InterpolateFunctions(const double pcoords[3], double weights[5]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkPyramid.h:141
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.
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.