VTK  9.0.1
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 =========================================================================*/
42 #ifndef vtkPentagonalPrism_h
43 #define vtkPentagonalPrism_h
44 
45 #include "vtkCell3D.h"
46 #include "vtkCommonDataModelModule.h" // For export macro
47 
48 class vtkLine;
49 class vtkPolygon;
50 class vtkQuad;
51 class vtkTriangle;
52 
53 class VTKCOMMONDATAMODEL_EXPORT vtkPentagonalPrism : public vtkCell3D
54 {
55 public:
57  vtkTypeMacro(vtkPentagonalPrism, vtkCell3D);
58  void PrintSelf(ostream& os, vtkIndent indent) override;
59 
61 
64  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
65  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
66  VTK_LEGACY(virtual void GetEdgePoints(int edgeId, int*& pts) override);
67  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
68  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
69  VTK_LEGACY(virtual void GetFacePoints(int faceId, int*& pts) override);
70  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
71  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
72  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
73  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
74  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
75  bool GetCentroid(double centroid[3]) const override;
76  bool IsInsideOut() override;
78 
82  static constexpr vtkIdType NumberOfPoints = 10;
83 
87  static constexpr vtkIdType NumberOfEdges = 15;
88 
92  static constexpr vtkIdType NumberOfFaces = 7;
93 
98  static constexpr vtkIdType MaximumFaceSize = 5;
99 
105  static constexpr vtkIdType MaximumValence = 3;
106 
108 
111  int GetCellType() override { return VTK_PENTAGONAL_PRISM; }
112  int GetCellDimension() override { return 3; }
113  int GetNumberOfEdges() override { return 15; }
114  int GetNumberOfFaces() override { return 7; }
115  vtkCell* GetEdge(int edgeId) override;
116  vtkCell* GetFace(int faceId) override;
117  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
119 
120  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
121  double& dist2, double weights[]) override;
122  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
123  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
124  double pcoords[3], int& subId) override;
125  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
127  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
128  double* GetParametricCoords() override;
129 
133  int GetParametricCenter(double pcoords[3]) override;
134 
135  static void InterpolationFunctions(const double pcoords[3], double weights[10]);
136  static void InterpolationDerivs(const double pcoords[3], double derivs[30]);
138 
142  void InterpolateFunctions(const double pcoords[3], double weights[10]) override
143  {
145  }
146  void InterpolateDerivs(const double pcoords[3], double derivs[30]) override
147  {
149  }
151 
153 
161  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
162  static const vtkIdType* GetFaceArray(vtkIdType faceId);
164 
169 
174 
179 
184 
189 
193  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
194 
200  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[30]);
201 
202 protected:
205 
210 
211 private:
212  vtkPentagonalPrism(const vtkPentagonalPrism&) = delete;
213  void operator=(const vtkPentagonalPrism&) = delete;
214 };
215 
216 //----------------------------------------------------------------------------
217 inline int vtkPentagonalPrism::GetParametricCenter(double pcoords[3])
218 {
219  pcoords[0] = pcoords[1] = 0.5;
220  pcoords[2] = 0.5;
221 
222  return 0;
223 }
224 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:39
abstract class to specify cell behavior
Definition: vtkCell.h:57
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
list of point or cell ids
Definition: vtkIdList.h:31
a simple class to control print indentation
Definition: vtkIndent.h:34
cell represents a 1D line
Definition: vtkLine.h:30
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
void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&pts) override
Get the ids of the two adjacent faces to edge of id edgeId.
vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds) override
Get the ids of the incident edges to point of id pointId.
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
Return the number of faces in the cell.
vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts) override
Get the ids of a one-ring surrounding point of id pointId.
virtual void GetFacePoints(int faceId, int *&pts) override
int GetNumberOfEdges() override
Return the number of edges in the cell.
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
Get the list of vertices that define a face.
void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
vtkCell * GetFace(int faceId) override
Return the face cell from the faceId of the cell.
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
Get the ids of the adjacent faces to face of id faceId.
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
Returns true if the normals of the vtkCell3D point inside the cell.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
int GetCellDimension() override
The topological dimension of the cell.
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
virtual void GetEdgePoints(int edgeId, int *&pts) override
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)
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
Computes the centroid of the cell.
vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds) override
Get the ids of the incident faces point of id pointId.
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
vtkCell * GetEdge(int edgeId) override
Return the edge cell from the edgeId of the cell.
static void InterpolationFunctions(const double pcoords[3], double weights[10])
represent and manipulate 3D points
Definition: vtkPoints.h:34
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:40
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:36
a cell that represents a triangle
Definition: vtkTriangle.h:36
@ points
Definition: vtkX3D.h:452
@ index
Definition: vtkX3D.h:252
@ VTK_PENTAGONAL_PRISM
Definition: vtkCellType.h:61
int vtkIdType
Definition: vtkType.h:338
#define VTK_SIZEHINT(...)