VTK  9.1.0
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 =========================================================================*/
91 #ifndef vtkPentagonalPrism_h
92 #define vtkPentagonalPrism_h
93 
94 #include "vtkCell3D.h"
95 #include "vtkCommonDataModelModule.h" // For export macro
96 
97 class vtkLine;
98 class vtkPolygon;
99 class vtkQuad;
100 class vtkTriangle;
101 
102 class VTKCOMMONDATAMODEL_EXPORT vtkPentagonalPrism : public vtkCell3D
103 {
104 public:
107  void PrintSelf(ostream& os, vtkIndent indent) override;
108 
110 
113  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
114  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
116  "Replaced by vtkPentagonalPrism::GetEdgePoints(vtkIdType, const vtkIdType*&)")
117  void GetEdgePoints(int edgeId, int*& pts) override;
118  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
119  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
121  "Replaced by vtkPentagonalPrism::GetFacePoints(vtkIdType, const vtkIdType*&)")
122  void GetFacePoints(int faceId, int*& pts) override;
123  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
124  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
125  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
126  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
127  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
128  bool GetCentroid(double centroid[3]) const override;
129  bool IsInsideOut() override;
131 
135  static constexpr vtkIdType NumberOfPoints = 10;
136 
140  static constexpr vtkIdType NumberOfEdges = 15;
141 
145  static constexpr vtkIdType NumberOfFaces = 7;
146 
151  static constexpr vtkIdType MaximumFaceSize = 5;
152 
158  static constexpr vtkIdType MaximumValence = 3;
159 
161 
164  int GetCellType() override { return VTK_PENTAGONAL_PRISM; }
165  int GetCellDimension() override { return 3; }
166  int GetNumberOfEdges() override { return 15; }
167  int GetNumberOfFaces() override { return 7; }
168  vtkCell* GetEdge(int edgeId) override;
169  vtkCell* GetFace(int faceId) override;
170  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
172 
173  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
174  double& dist2, double weights[]) override;
175  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
176  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
177  double pcoords[3], int& subId) override;
178  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
180  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
181  double* GetParametricCoords() override;
182 
186  int GetParametricCenter(double pcoords[3]) override;
187 
188  static void InterpolationFunctions(const double pcoords[3], double weights[10]);
189  static void InterpolationDerivs(const double pcoords[3], double derivs[30]);
191 
195  void InterpolateFunctions(const double pcoords[3], double weights[10]) override
196  {
198  }
199  void InterpolateDerivs(const double pcoords[3], double derivs[30]) override
200  {
202  }
204 
206 
214  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
215  static const vtkIdType* GetFaceArray(vtkIdType faceId);
217 
222 
227 
232 
237 
242 
246  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
247 
253  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[30]);
254 
255 protected:
258 
263 
264 private:
265  vtkPentagonalPrism(const vtkPentagonalPrism&) = delete;
266  void operator=(const vtkPentagonalPrism&) = delete;
267 };
268 
269 //----------------------------------------------------------------------------
270 inline int vtkPentagonalPrism::GetParametricCenter(double pcoords[3])
271 {
272  pcoords[0] = pcoords[1] = 0.5;
273  pcoords[2] = 0.5;
274 
275  return 0;
276 }
277 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:40
abstract class to specify cell behavior
Definition: vtkCell.h:147
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
list of point or cell ids
Definition: vtkIdList.h:140
a simple class to control print indentation
Definition: vtkIndent.h:113
cell represents a 1D line
Definition: vtkLine.h:140
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)
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.
int GetNumberOfEdges() 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’).
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.
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.
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
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:143
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:149
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:95
a cell that represents a triangle
Definition: vtkTriangle.h:145
int GetCellType(const Ioss::ElementTopology *topology)
Returns VTK celltype for a Ioss topology element.
@ points
Definition: vtkX3D.h:452
@ index
Definition: vtkX3D.h:252
@ VTK_PENTAGONAL_PRISM
Definition: vtkCellType.h:100
#define VTK_DEPRECATED_IN_9_0_0(reason)
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)