VTK  9.2.5
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 =========================================================================*/
94 #ifndef vtkPentagonalPrism_h
95 #define vtkPentagonalPrism_h
96 
97 #include "vtkCell3D.h"
98 #include "vtkCommonDataModelModule.h" // For export macro
99 
100 class vtkLine;
101 class vtkPolygon;
102 class vtkQuad;
103 class vtkTriangle;
104 
105 class VTKCOMMONDATAMODEL_EXPORT vtkPentagonalPrism : public vtkCell3D
106 {
107 public:
110  void PrintSelf(ostream& os, vtkIndent indent) override;
111 
113 
116  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
117  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
118  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
119  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
120  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
121  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
122  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
123  bool GetCentroid(double centroid[3]) const override;
124  bool IsInsideOut() override;
126 
130  static constexpr vtkIdType NumberOfPoints = 10;
131 
135  static constexpr vtkIdType NumberOfEdges = 15;
136 
140  static constexpr vtkIdType NumberOfFaces = 7;
141 
146  static constexpr vtkIdType MaximumFaceSize = 5;
147 
153  static constexpr vtkIdType MaximumValence = 3;
154 
156 
159  int GetCellType() override { return VTK_PENTAGONAL_PRISM; }
160  int GetCellDimension() override { return 3; }
161  int GetNumberOfEdges() override { return 15; }
162  int GetNumberOfFaces() override { return 7; }
163  vtkCell* GetEdge(int edgeId) override;
164  vtkCell* GetFace(int faceId) override;
165  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
167 
168  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
169  double& dist2, double weights[]) override;
170  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
171  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
172  double pcoords[3], int& subId) override;
173  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
175  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
176  double* GetParametricCoords() override;
177 
181  int GetParametricCenter(double pcoords[3]) override;
182 
183  static void InterpolationFunctions(const double pcoords[3], double weights[10]);
184  static void InterpolationDerivs(const double pcoords[3], double derivs[30]);
186 
190  void InterpolateFunctions(const double pcoords[3], double weights[10]) override
191  {
193  }
194  void InterpolateDerivs(const double pcoords[3], double derivs[30]) override
195  {
197  }
199 
201 
209  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
210  static const vtkIdType* GetFaceArray(vtkIdType faceId);
212 
217 
222 
227 
232 
237 
241  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
242 
248  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[30]);
249 
250 protected:
253 
258 
259 private:
260  vtkPentagonalPrism(const vtkPentagonalPrism&) = delete;
261  void operator=(const vtkPentagonalPrism&) = delete;
262 };
263 
264 //----------------------------------------------------------------------------
265 inline int vtkPentagonalPrism::GetParametricCenter(double pcoords[3])
266 {
267  pcoords[0] = pcoords[1] = 0.5;
268  pcoords[2] = 0.5;
269 
270  return 0;
271 }
272 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:39
abstract class to specify cell behavior
Definition: vtkCell.h:150
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
list of point or cell ids
Definition: vtkIdList.h:143
a simple class to control print indentation
Definition: vtkIndent.h:119
cell represents a 1D line
Definition: vtkLine.h:143
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:149
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:152
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:98
a cell that represents a triangle
Definition: vtkTriangle.h:148
@ points
Definition: vtkX3D.h:452
@ index
Definition: vtkX3D.h:252
@ VTK_PENTAGONAL_PRISM
Definition: vtkCellType.h:100
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)