VTK  9.3.1
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
33 #ifndef vtkPentagonalPrism_h
34 #define vtkPentagonalPrism_h
35 
36 #include "vtkCell3D.h"
37 #include "vtkCommonDataModelModule.h" // For export macro
38 
39 VTK_ABI_NAMESPACE_BEGIN
40 class vtkLine;
41 class vtkPolygon;
42 class vtkQuad;
43 class vtkTriangle;
44 
45 class VTKCOMMONDATAMODEL_EXPORT vtkPentagonalPrism : public vtkCell3D
46 {
47 public:
48  static vtkPentagonalPrism* New();
49  vtkTypeMacro(vtkPentagonalPrism, vtkCell3D);
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 Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
114  void Derivatives(
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  }
139 
141 
149  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
150  static const vtkIdType* GetFaceArray(vtkIdType faceId);
152 
156  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
157 
161  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(5);
162 
166  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
167 
171  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
172 
176  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
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 
190 protected:
192  ~vtkPentagonalPrism() override;
193 
198 
199 private:
200  vtkPentagonalPrism(const vtkPentagonalPrism&) = delete;
201  void operator=(const vtkPentagonalPrism&) = delete;
202 };
203 
204 //----------------------------------------------------------------------------
205 inline int vtkPentagonalPrism::GetParametricCenter(double pcoords[3])
206 {
207  pcoords[0] = pcoords[1] = 0.5;
208  pcoords[2] = 0.5;
209 
210  return 0;
211 }
212 VTK_ABI_NAMESPACE_END
213 #endif
virtual vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds)=0
Get the ids of the adjacent faces to face of id faceId.
int GetCellDimension() override
See the vtkCell3D API for descriptions of these methods.
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:27
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
int vtkIdType
Definition: vtkType.h:315
static void InterpolationDerivs(const double pcoords[3], double derivs[30])
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:27
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 GetNumberOfEdges() override
See the vtkCell3D API for descriptions of these methods.
virtual vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts)=0
Get the list of vertices that define a face.
int GetNumberOfFaces() override
See the vtkCell3D API for descriptions of these methods.
virtual void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts)=0
Get the pair of vertices that define an edge.
a 3D cell that represents a convex prism with pentagonal base
cell represents a 1D line
Definition: vtkLine.h:22
abstract class to specify cell behavior
Definition: vtkCell.h:49
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.
void InterpolateFunctions(const double pcoords[3], double weights[10]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
a simple class to control print indentation
Definition: vtkIndent.h:28
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:22
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:31
virtual vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts)=0
Get the ids of a one-ring surrounding point of id pointId.
#define VTK_SIZEHINT(...)
static void InterpolationFunctions(const double pcoords[3], double weights[10])
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
int GetParametricCenter(double pcoords[3]) override
Return the center of the wedge in parametric coordinates.
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...
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
a cell that represents a triangle
Definition: vtkTriangle.h:27
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.
virtual vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds)=0
Get the ids of the incident faces point of id pointId.
int GetCellType() override
See the vtkCell3D API for descriptions of these methods.
virtual bool IsInsideOut()
Returns true if the normals of the vtkCell3D point inside the cell.
void InterpolateDerivs(const double pcoords[3], double derivs[30]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
represent and manipulate 3D points
Definition: vtkPoints.h:28
virtual vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds)=0
Get the ids of the incident edges to point of id pointId.