VTK  9.2.5
vtkHexagonalPrism.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkHexagonalPrism.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 =========================================================================*/
87 #ifndef vtkHexagonalPrism_h
88 #define vtkHexagonalPrism_h
89 
90 #include "vtkCell3D.h"
91 #include "vtkCommonDataModelModule.h" // For export macro
92 
93 class vtkLine;
94 class vtkPolygon;
95 class vtkQuad;
96 
97 class VTKCOMMONDATAMODEL_EXPORT vtkHexagonalPrism : public vtkCell3D
98 {
99 public:
101  vtkTypeMacro(vtkHexagonalPrism, vtkCell3D);
102  void PrintSelf(ostream& os, vtkIndent indent) override;
103 
105 
108  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
109  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
110  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
111  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
112  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
113  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
114  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
115  bool GetCentroid(double centroid[3]) const override;
116  bool IsInsideOut() override;
118 
122  static constexpr vtkIdType NumberOfPoints = 12;
123 
127  static constexpr vtkIdType NumberOfEdges = 18;
128 
132  static constexpr vtkIdType NumberOfFaces = 8;
133 
138  static constexpr vtkIdType MaximumFaceSize = 6;
139 
145  static constexpr vtkIdType MaximumValence = 3;
146 
148 
151  int GetCellType() override { return VTK_HEXAGONAL_PRISM; }
152  int GetCellDimension() override { return 3; }
153  int GetNumberOfEdges() override { return 18; }
154  int GetNumberOfFaces() override { return 8; }
155  vtkCell* GetEdge(int edgeId) override;
156  vtkCell* GetFace(int faceId) override;
157  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
159 
160  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
161  double& dist2, double weights[]) override;
162  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
163  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
164  double pcoords[3], int& subId) override;
165  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
167  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
168  double* GetParametricCoords() override;
169 
173  int GetParametricCenter(double pcoords[3]) override;
174 
175  static void InterpolationFunctions(const double pcoords[3], double weights[12]);
176  static void InterpolationDerivs(const double pcoords[3], double derivs[36]);
178 
182  void InterpolateFunctions(const double pcoords[3], double weights[12]) override
183  {
185  }
186  void InterpolateDerivs(const double pcoords[3], double derivs[36]) override
187  {
189  }
191 
193 
201  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
202  static const vtkIdType* GetFaceArray(vtkIdType faceId);
204 
209 
214 
219 
224 
229 
233  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
234 
240  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[36]);
241 
242 protected:
244  ~vtkHexagonalPrism() override;
245 
249 
250 private:
251  vtkHexagonalPrism(const vtkHexagonalPrism&) = delete;
252  void operator=(const vtkHexagonalPrism&) = delete;
253 };
254 
255 //----------------------------------------------------------------------------
256 inline int vtkHexagonalPrism::GetParametricCenter(double pcoords[3])
257 {
258  pcoords[0] = pcoords[1] = 0.5;
259  pcoords[2] = 0.5;
260  return 0;
261 }
262 #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.
a 3D cell that represents a prism with hexagonal base
static vtkHexagonalPrism * New()
static void InterpolationFunctions(const double pcoords[3], double weights[12])
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
void InterpolateDerivs(const double pcoords[3], double derivs[36]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.
bool GetCentroid(double centroid[3]) const override
See vtkCell3D API for description of these methods.
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
Compute derivatives given cell subId and parametric coordinates.
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
Determine global coordinate (x[3]) from subId and parametric coordinates.
vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
bool IsInsideOut() override
See vtkCell3D API for description of these methods.
vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
static void InterpolationDerivs(const double pcoords[3], double derivs[36])
void InterpolateFunctions(const double pcoords[3], double weights[12]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
static const vtkIdType * GetFaceArray(vtkIdType faceId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
vtkCell * GetFace(int faceId) override
See the vtkCell API for descriptions of these methods.
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...
int GetParametricCenter(double pcoords[3]) override
Return the center of the wedge in parametric coordinates.
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.
~vtkHexagonalPrism() override
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
void JacobianInverse(const double pcoords[3], double **inverse, double derivs[36])
Given parametric coordinates compute inverse Jacobian transformation matrix.
vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds) override
See vtkCell3D API for description of these methods.
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
See the vtkCell API for descriptions of these methods.
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
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
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
@ points
Definition: vtkX3D.h:452
@ index
Definition: vtkX3D.h:252
@ VTK_HEXAGONAL_PRISM
Definition: vtkCellType.h:101
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)