VTK  9.3.20240327
vtkPyramid.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
81 #ifndef vtkPyramid_h
82 #define vtkPyramid_h
83 
84 #include "vtkCell3D.h"
85 #include "vtkCommonDataModelModule.h" // For export macro
86 
87 VTK_ABI_NAMESPACE_BEGIN
88 class vtkLine;
89 class vtkQuad;
90 class vtkTriangle;
93 
94 class VTKCOMMONDATAMODEL_EXPORT vtkPyramid : public vtkCell3D
95 {
96 public:
97  static vtkPyramid* New();
98  vtkTypeMacro(vtkPyramid, vtkCell3D);
99  void PrintSelf(ostream& os, vtkIndent indent) override;
100 
102 
105  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
106  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
107  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
108  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
109  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
110  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
111  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
112  bool GetCentroid(double centroid[3]) const override;
113  bool IsInsideOut() override;
115 
119  static constexpr vtkIdType NumberOfPoints = 5;
120 
124  static constexpr vtkIdType NumberOfEdges = 8;
125 
129  static constexpr vtkIdType NumberOfFaces = 5;
130 
135  static constexpr vtkIdType MaximumFaceSize = 4;
136 
142  static constexpr vtkIdType MaximumValence = 4;
144 
147  int GetCellType() override { return VTK_PYRAMID; }
148  int GetCellDimension() override { return 3; }
149  int GetNumberOfEdges() override { return 8; }
150  int GetNumberOfFaces() override { return 5; }
151  vtkCell* GetEdge(int edgeId) override;
152  vtkCell* GetFace(int faceId) override;
153  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
154  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
155  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
156  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
157  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
158  double& dist2, double weights[]) override;
159  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
160  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
161  double pcoords[3], int& subId) override;
162  int TriangulateLocalIds(int index, vtkIdList* ptIds) override;
164  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
165  double* GetParametricCoords() override;
167 
175  static int* GetTriangleCases(int caseId);
176 
180  int GetParametricCenter(double pcoords[3]) override;
181 
182  static void InterpolationFunctions(const double pcoords[3], double weights[5]);
183  static void InterpolationDerivs(const double pcoords[3], double derivs[15]);
185 
189  void InterpolateFunctions(const double pcoords[3], double weights[5]) override
190  {
191  vtkPyramid::InterpolationFunctions(pcoords, weights);
192  }
193  void InterpolateDerivs(const double pcoords[3], double derivs[15]) override
194  {
195  vtkPyramid::InterpolationDerivs(pcoords, derivs);
196  }
198 
199  int JacobianInverse(const double pcoords[3], double** inverse, double derivs[15]);
200 
202 
210  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
211  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
213 
218 
223 
228 
233 
238 
242  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
243 
244 protected:
246  ~vtkPyramid() override;
247 
251 
252 private:
253  vtkPyramid(const vtkPyramid&) = delete;
254  void operator=(const vtkPyramid&) = delete;
255 };
256 
257 //----------------------------------------------------------------------------
258 inline int vtkPyramid::GetParametricCenter(double pcoords[3])
259 {
260  pcoords[0] = pcoords[1] = 0.4;
261  pcoords[2] = 0.2;
262  return 0;
263 }
264 
265 VTK_ABI_NAMESPACE_END
266 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:28
object to represent cell connectivity
Definition: vtkCellArray.h:285
represent and manipulate cell attribute data
Definition: vtkCellData.h:140
abstract class to specify cell behavior
Definition: vtkCell.h:130
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:154
list of point or cell ids
Definition: vtkIdList.h:132
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:108
cell represents a 1D line
Definition: vtkLine.h:132
represent and manipulate point attribute data
Definition: vtkPointData.h:139
represent and manipulate 3D points
Definition: vtkPoints.h:138
a 3D cell that represents a linear pyramid
Definition: vtkPyramid.h:95
int GetParametricCenter(double pcoords[3]) override
Return the center of the pyramid in parametric coordinates.
Definition: vtkPyramid.h:258
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
static vtkPyramid * New()
vtkQuad * Quad
Definition: vtkPyramid.h:250
vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts) override
See vtkCell3D API for description 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.
void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
vtkTriangle * Triangle
Definition: vtkPyramid.h:249
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
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.
double * GetParametricCoords() override
See the vtkCell API for descriptions of these methods.
bool IsInsideOut() override
See vtkCell3D API for description of these methods.
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
static int * GetTriangleCases(int caseId)
Return the case table for table-based isocontouring (aka marching cubes style implementations).
~vtkPyramid() override
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
void InterpolateDerivs(const double pcoords[3], double derivs[15]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkPyramid.h:193
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:149
vtkCell * GetFace(int faceId) 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.
vtkLine * Line
Definition: vtkPyramid.h:248
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
int JacobianInverse(const double pcoords[3], double **inverse, double derivs[15])
static const vtkIdType * GetFaceArray(vtkIdType faceId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:148
vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds) override
See vtkCell3D API for description of these methods.
int TriangulateLocalIds(int index, vtkIdList *ptIds) override
See the vtkCell API for descriptions of these methods.
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:150
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:147
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.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
bool GetCentroid(double centroid[3]) const override
See vtkCell3D API for description 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.
static void InterpolationFunctions(const double pcoords[3], double weights[5])
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
See the vtkCell API for descriptions of these methods.
static void InterpolationDerivs(const double pcoords[3], double derivs[15])
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
void InterpolateFunctions(const double pcoords[3], double weights[5]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
Definition: vtkPyramid.h:189
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:87
a cell that represents a triangle
Definition: vtkTriangle.h:137
dataset represents arbitrary combinations of all possible cell types
const std::string pointIds
@ points
Definition: vtkX3D.h:446
@ value
Definition: vtkX3D.h:220
@ index
Definition: vtkX3D.h:246
@ VTK_PYRAMID
Definition: vtkCellType.h:70
int vtkIdType
Definition: vtkType.h:315
#define VTK_SIZEHINT(...)