VTK  9.2.6
vtkPentagonalPrism.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPentagonalPrism.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
45 #ifndef vtkPentagonalPrism_h
46 #define vtkPentagonalPrism_h
47 
48 #include "vtkCell3D.h"
49 #include "vtkCommonDataModelModule.h" // For export macro
50 
51 class vtkLine;
52 class vtkPolygon;
53 class vtkQuad;
54 class vtkTriangle;
55 
56 class VTKCOMMONDATAMODEL_EXPORT vtkPentagonalPrism : public vtkCell3D
57 {
58 public:
59  static vtkPentagonalPrism* New();
60  vtkTypeMacro(vtkPentagonalPrism, vtkCell3D);
61  void PrintSelf(ostream& os, vtkIndent indent) override;
62 
64 
67  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
68  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
69  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
70  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
71  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
72  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
73  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
74  bool GetCentroid(double centroid[3]) const override;
75  bool IsInsideOut() override;
77 
81  static constexpr vtkIdType NumberOfPoints = 10;
82 
86  static constexpr vtkIdType NumberOfEdges = 15;
87 
91  static constexpr vtkIdType NumberOfFaces = 7;
92 
97  static constexpr vtkIdType MaximumFaceSize = 5;
98 
104  static constexpr vtkIdType MaximumValence = 3;
105 
107 
110  int GetCellType() override { return VTK_PENTAGONAL_PRISM; }
111  int GetCellDimension() override { return 3; }
112  int GetNumberOfEdges() override { return 15; }
113  int GetNumberOfFaces() override { return 7; }
114  vtkCell* GetEdge(int edgeId) override;
115  vtkCell* GetFace(int faceId) override;
116  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
118 
119  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
120  double& dist2, double weights[]) override;
121  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
122  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
123  double pcoords[3], int& subId) override;
124  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
125  void Derivatives(
126  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
127  double* GetParametricCoords() override;
128 
132  int GetParametricCenter(double pcoords[3]) override;
133 
134  static void InterpolationFunctions(const double pcoords[3], double weights[10]);
135  static void InterpolationDerivs(const double pcoords[3], double derivs[30]);
137 
141  void InterpolateFunctions(const double pcoords[3], double weights[10]) override
142  {
144  }
145  void InterpolateDerivs(const double pcoords[3], double derivs[30]) override
146  {
148  }
150 
152 
160  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
161  static const vtkIdType* GetFaceArray(vtkIdType faceId);
163 
167  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
168 
172  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(5);
173 
177  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
178 
182  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
183 
187  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
188 
192  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
193 
199  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[30]);
200 
201 protected:
203  ~vtkPentagonalPrism() override;
204 
209 
210 private:
211  vtkPentagonalPrism(const vtkPentagonalPrism&) = delete;
212  void operator=(const vtkPentagonalPrism&) = delete;
213 };
214 
215 //----------------------------------------------------------------------------
216 inline int vtkPentagonalPrism::GetParametricCenter(double pcoords[3])
217 {
218  pcoords[0] = pcoords[1] = 0.5;
219  pcoords[2] = 0.5;
220 
221  return 0;
222 }
223 #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:38
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
int vtkIdType
Definition: vtkType.h:332
static void InterpolationDerivs(const double pcoords[3], double derivs[30])
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:38
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:33
abstract class to specify cell behavior
Definition: vtkCell.h:60
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:39
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:33
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:42
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:38
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:39
virtual vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds)=0
Get the ids of the incident edges to point of id pointId.