VTK  9.3.0
vtkPentagonalPrism.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
42 #ifndef vtkPentagonalPrism_h
43 #define vtkPentagonalPrism_h
44 
45 #include "vtkCell3D.h"
46 #include "vtkCommonDataModelModule.h" // For export macro
47 
48 VTK_ABI_NAMESPACE_BEGIN
49 class vtkLine;
50 class vtkPolygon;
51 class vtkQuad;
52 class vtkTriangle;
53 
54 class VTKCOMMONDATAMODEL_EXPORT vtkPentagonalPrism : public vtkCell3D
55 {
56 public:
58  vtkTypeMacro(vtkPentagonalPrism, vtkCell3D);
59  void PrintSelf(ostream& os, vtkIndent indent) override;
60 
62 
65  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
66  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
67  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
68  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
69  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
70  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
71  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
72  bool GetCentroid(double centroid[3]) const override;
73  bool IsInsideOut() override;
75 
79  static constexpr vtkIdType NumberOfPoints = 10;
80 
84  static constexpr vtkIdType NumberOfEdges = 15;
85 
89  static constexpr vtkIdType NumberOfFaces = 7;
90 
95  static constexpr vtkIdType MaximumFaceSize = 5;
96 
102  static constexpr vtkIdType MaximumValence = 3;
103 
105 
108  int GetCellType() override { return VTK_PENTAGONAL_PRISM; }
109  int GetCellDimension() override { return 3; }
110  int GetNumberOfEdges() override { return 15; }
111  int GetNumberOfFaces() override { return 7; }
112  vtkCell* GetEdge(int edgeId) override;
113  vtkCell* GetFace(int faceId) override;
114  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
116 
117  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
118  double& dist2, double weights[]) override;
119  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
120  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
121  double pcoords[3], int& subId) override;
122  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
124  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
125  double* GetParametricCoords() override;
126 
130  int GetParametricCenter(double pcoords[3]) override;
131 
132  static void InterpolationFunctions(const double pcoords[3], double weights[10]);
133  static void InterpolationDerivs(const double pcoords[3], double derivs[30]);
135 
139  void InterpolateFunctions(const double pcoords[3], double weights[10]) override
140  {
142  }
143  void InterpolateDerivs(const double pcoords[3], double derivs[30]) override
144  {
146  }
148 
150 
158  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
159  static const vtkIdType* GetFaceArray(vtkIdType faceId);
161 
166 
171 
176 
181 
186 
190  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
191 
197  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[30]);
198 
199 protected:
202 
207 
208 private:
209  vtkPentagonalPrism(const vtkPentagonalPrism&) = delete;
210  void operator=(const vtkPentagonalPrism&) = delete;
211 };
212 
213 //----------------------------------------------------------------------------
214 inline int vtkPentagonalPrism::GetParametricCenter(double pcoords[3])
215 {
216  pcoords[0] = pcoords[1] = 0.5;
217  pcoords[2] = 0.5;
218 
219  return 0;
220 }
221 VTK_ABI_NAMESPACE_END
222 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:28
abstract class to specify cell behavior
Definition: vtkCell.h:59
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
list of point or cell ids
Definition: vtkIdList.h:32
a simple class to control print indentation
Definition: vtkIndent.h:38
cell represents a 1D line
Definition: vtkLine.h:32
a 3D cell that represents a convex prism with pentagonal base
int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[]) override
Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; ev...
void InterpolateDerivs(const double pcoords[3], double derivs[30]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds) override
See vtkCell3D API for description of these methods.
static void InterpolationDerivs(const double pcoords[3], double derivs[30])
void JacobianInverse(const double pcoords[3], double **inverse, double derivs[30])
Given parametric coordinates compute inverse Jacobian transformation matrix.
int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId) override
Intersect with a ray.
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void InterpolateFunctions(const double pcoords[3], double weights[10]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
int GetNumberOfFaces() override
See the vtkCell3D API for descriptions of these methods.
vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
int GetNumberOfEdges() override
See the vtkCell3D API for descriptions of these methods.
int GetCellType() override
See the vtkCell3D API for descriptions of these methods.
static vtkPentagonalPrism * New()
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts) 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.
vtkCell * GetFace(int faceId) override
See the vtkCell3D API for descriptions of these methods.
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
int GetParametricCenter(double pcoords[3]) override
Return the center of the wedge in parametric coordinates.
bool IsInsideOut() override
See vtkCell3D API for description of these methods.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
int GetCellDimension() override
See the vtkCell3D API for descriptions of these methods.
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
Compute derivatives given cell subId and parametric coordinates.
static const vtkIdType * GetFaceArray(vtkIdType faceId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
Determine global coordinate (x[3]) from subId and parametric coordinates.
~vtkPentagonalPrism() override
bool GetCentroid(double centroid[3]) const override
See vtkCell3D API for description of these methods.
vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell3D API for descriptions of these methods.
vtkCell * GetEdge(int edgeId) override
See the vtkCell3D API for descriptions of these methods.
static void InterpolationFunctions(const double pcoords[3], double weights[10])
represent and manipulate 3D points
Definition: vtkPoints.h:38
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:41
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:37
a cell that represents a triangle
Definition: vtkTriangle.h:37
@ points
Definition: vtkX3D.h:446
@ index
Definition: vtkX3D.h:246
@ VTK_PENTAGONAL_PRISM
Definition: vtkCellType.h:61
int vtkIdType
Definition: vtkType.h:315
#define VTK_SIZEHINT(...)