VTK  9.4.20251007
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
32
33#ifndef vtkPentagonalPrism_h
34#define vtkPentagonalPrism_h
35
36#include "vtkCell3D.h"
37#include "vtkCommonDataModelModule.h" // For export macro
38
39VTK_ABI_NAMESPACE_BEGIN
40class vtkLine;
41class vtkPolygon;
42class vtkQuad;
43class vtkTriangle;
44
45class VTKCOMMONDATAMODEL_EXPORT vtkPentagonalPrism : public vtkCell3D
46{
47public:
50 void PrintSelf(ostream& os, vtkIndent indent) override;
51
53
56 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
57 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
58 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
59 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
60 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
61 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
62 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
63 bool GetCentroid(double centroid[3]) const override;
64 bool IsInsideOut() override;
66
70 static constexpr vtkIdType NumberOfPoints = 10;
71
75 static constexpr vtkIdType NumberOfEdges = 15;
76
80 static constexpr vtkIdType NumberOfFaces = 7;
81
86 static constexpr vtkIdType MaximumFaceSize = 5;
87
93 static constexpr vtkIdType MaximumValence = 3;
94
96
99 int GetCellType() override { return VTK_PENTAGONAL_PRISM; }
100 int GetCellDimension() override { return 3; }
101 int GetNumberOfEdges() override { return 15; }
102 int GetNumberOfFaces() override { return 7; }
103 vtkCell* GetEdge(int edgeId) override;
104 vtkCell* GetFace(int faceId) override;
105 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
107
108 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
109 double& dist2, double weights[]) override;
110 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
111 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
112 double pcoords[3], int& subId) override;
113 int TriangulateLocalIds(int index, vtkIdList* ptIds) override;
115 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
116 double* GetParametricCoords() override;
117
121 int GetParametricCenter(double pcoords[3]) override;
122
123 static void InterpolationFunctions(const double pcoords[3], double weights[10]);
124 static void InterpolationDerivs(const double pcoords[3], double derivs[30]);
126
130 void InterpolateFunctions(const double pcoords[3], double weights[10]) override
131 {
133 }
134 void InterpolateDerivs(const double pcoords[3], double derivs[30]) override
135 {
137 }
138
139
141
149 static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
150 static const vtkIdType* GetFaceArray(vtkIdType faceId);
152
157
162
167
172
177
181 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
182
188 void JacobianInverse(const double pcoords[3], double** inverse, double derivs[30]);
189
190protected:
193
198
199private:
200 vtkPentagonalPrism(const vtkPentagonalPrism&) = delete;
201 void operator=(const vtkPentagonalPrism&) = delete;
202};
203
204//----------------------------------------------------------------------------
205inline int vtkPentagonalPrism::GetParametricCenter(double pcoords[3])
206{
207 pcoords[0] = pcoords[1] = 0.5;
208 pcoords[2] = 0.5;
209
210 return 0;
211}
212VTK_ABI_NAMESPACE_END
213#endif
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
list of point or cell ids
Definition vtkIdList.h:24
a simple class to control print indentation
Definition vtkIndent.h:29
cell represents a 1D line
Definition vtkLine.h:23
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...
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
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.
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.
int GetNumberOfFaces() override
See the vtkCell3D API for descriptions of these methods.
static constexpr vtkIdType NumberOfPoints
static constexpr handle on the number of points.
vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
static constexpr vtkIdType NumberOfFaces
static contexpr handle on the number of edges.
static constexpr vtkIdType NumberOfEdges
static contexpr handle on the number of faces.
int GetNumberOfEdges() 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.
int GetCellType() override
See the vtkCell3D API for descriptions of these methods.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
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 * GetEdge(int edgeId) override
See the vtkCell3D API for descriptions 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.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
static vtkPentagonalPrism * New()
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
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.
static constexpr vtkIdType MaximumValence
static constexpr handle on the maximum valence of this cell.
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
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.
static void InterpolationFunctions(const double pcoords[3], double weights[10])
static constexpr vtkIdType MaximumFaceSize
static contexpr handle on the maximum face size.
represent and manipulate 3D points
Definition vtkPoints.h:30
a cell that represents an n-sided polygon
Definition vtkPolygon.h:33
a cell that represents a 2D quadrilateral
Definition vtkQuad.h:28
a cell that represents a triangle
Definition vtkTriangle.h:28
@ VTK_PENTAGONAL_PRISM
Definition vtkCellType.h:52
int vtkIdType
Definition vtkType.h:315
#define VTK_SIZEHINT(...)