VTK  9.3.20240319
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
82 #ifndef vtkPentagonalPrism_h
83 #define vtkPentagonalPrism_h
84 
85 #include "vtkCell3D.h"
86 #include "vtkCommonDataModelModule.h" // For export macro
87 
88 VTK_ABI_NAMESPACE_BEGIN
89 class vtkLine;
90 class vtkPolygon;
91 class vtkQuad;
92 class vtkTriangle;
93 
94 class VTKCOMMONDATAMODEL_EXPORT vtkPentagonalPrism : public vtkCell3D
95 {
96 public:
98  vtkTypeMacro(vtkPentagonalPrism, 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 = 10;
120 
124  static constexpr vtkIdType NumberOfEdges = 15;
125 
129  static constexpr vtkIdType NumberOfFaces = 7;
130 
135  static constexpr vtkIdType MaximumFaceSize = 5;
136 
142  static constexpr vtkIdType MaximumValence = 3;
143 
145 
148  int GetCellType() override { return VTK_PENTAGONAL_PRISM; }
149  int GetCellDimension() override { return 3; }
150  int GetNumberOfEdges() override { return 15; }
151  int GetNumberOfFaces() override { return 7; }
152  vtkCell* GetEdge(int edgeId) override;
153  vtkCell* GetFace(int faceId) override;
154  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
156 
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;
166 
170  int GetParametricCenter(double pcoords[3]) override;
171 
172  static void InterpolationFunctions(const double pcoords[3], double weights[10]);
173  static void InterpolationDerivs(const double pcoords[3], double derivs[30]);
175 
179  void InterpolateFunctions(const double pcoords[3], double weights[10]) override
180  {
182  }
183  void InterpolateDerivs(const double pcoords[3], double derivs[30]) override
184  {
186  }
188 
190 
198  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
199  static const vtkIdType* GetFaceArray(vtkIdType faceId);
201 
206 
211 
216 
221 
226 
230  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
231 
237  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[30]);
238 
239 protected:
242 
247 
248 private:
249  vtkPentagonalPrism(const vtkPentagonalPrism&) = delete;
250  void operator=(const vtkPentagonalPrism&) = delete;
251 };
252 
253 //----------------------------------------------------------------------------
254 inline int vtkPentagonalPrism::GetParametricCenter(double pcoords[3])
255 {
256  pcoords[0] = pcoords[1] = 0.5;
257  pcoords[2] = 0.5;
258 
259  return 0;
260 }
261 VTK_ABI_NAMESPACE_END
262 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:28
abstract class to specify cell behavior
Definition: vtkCell.h:130
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
list of point or cell ids
Definition: vtkIdList.h:132
a simple class to control print indentation
Definition: vtkIndent.h:108
cell represents a 1D line
Definition: vtkLine.h:132
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.
int TriangulateLocalIds(int index, vtkIdList *ptIds) override
Generate simplices of proper dimension.
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 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:138
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:132
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:87
a cell that represents a triangle
Definition: vtkTriangle.h:137
const std::string pointIds
@ points
Definition: vtkX3D.h:446
@ index
Definition: vtkX3D.h:246
@ VTK_PENTAGONAL_PRISM
Definition: vtkCellType.h:71
int vtkIdType
Definition: vtkType.h:315
#define VTK_SIZEHINT(...)