VTK  9.3.0
vtkHexagonalPrism.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
35 #ifndef vtkHexagonalPrism_h
36 #define vtkHexagonalPrism_h
37 
38 #include "vtkCell3D.h"
39 #include "vtkCommonDataModelModule.h" // For export macro
40 
41 VTK_ABI_NAMESPACE_BEGIN
42 class vtkLine;
43 class vtkPolygon;
44 class vtkQuad;
45 
46 class VTKCOMMONDATAMODEL_EXPORT vtkHexagonalPrism : public vtkCell3D
47 {
48 public:
50  vtkTypeMacro(vtkHexagonalPrism, vtkCell3D);
51  void PrintSelf(ostream& os, vtkIndent indent) override;
52 
54 
57  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
58  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
59  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
60  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
61  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
62  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
63  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
64  bool GetCentroid(double centroid[3]) const override;
65  bool IsInsideOut() override;
67 
71  static constexpr vtkIdType NumberOfPoints = 12;
72 
76  static constexpr vtkIdType NumberOfEdges = 18;
77 
81  static constexpr vtkIdType NumberOfFaces = 8;
82 
87  static constexpr vtkIdType MaximumFaceSize = 6;
88 
94  static constexpr vtkIdType MaximumValence = 3;
95 
97 
100  int GetCellType() override { return VTK_HEXAGONAL_PRISM; }
101  int GetCellDimension() override { return 3; }
102  int GetNumberOfEdges() override { return 18; }
103  int GetNumberOfFaces() override { return 8; }
104  vtkCell* GetEdge(int edgeId) override;
105  vtkCell* GetFace(int faceId) override;
106  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
108 
109  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
110  double& dist2, double weights[]) override;
111  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
112  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
113  double pcoords[3], int& subId) override;
114  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
116  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
117  double* GetParametricCoords() override;
118 
122  int GetParametricCenter(double pcoords[3]) override;
123 
124  static void InterpolationFunctions(const double pcoords[3], double weights[12]);
125  static void InterpolationDerivs(const double pcoords[3], double derivs[36]);
127 
131  void InterpolateFunctions(const double pcoords[3], double weights[12]) override
132  {
134  }
135  void InterpolateDerivs(const double pcoords[3], double derivs[36]) override
136  {
138  }
140 
142 
150  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
151  static const vtkIdType* GetFaceArray(vtkIdType faceId);
153 
158 
163 
168 
173 
178 
182  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
183 
189  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[36]);
190 
191 protected:
193  ~vtkHexagonalPrism() override;
194 
198 
199 private:
200  vtkHexagonalPrism(const vtkHexagonalPrism&) = delete;
201  void operator=(const vtkHexagonalPrism&) = delete;
202 };
203 
204 //----------------------------------------------------------------------------
205 inline int vtkHexagonalPrism::GetParametricCenter(double pcoords[3])
206 {
207  pcoords[0] = pcoords[1] = 0.5;
208  pcoords[2] = 0.5;
209  return 0;
210 }
211 VTK_ABI_NAMESPACE_END
212 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:28
abstract class to specify cell behavior
Definition: vtkCell.h:59
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:32
a simple class to control print indentation
Definition: vtkIndent.h:38
cell represents a 1D line
Definition: vtkLine.h:32
represent and manipulate 3D points
Definition: vtkPoints.h:38
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:41
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:37
@ points
Definition: vtkX3D.h:446
@ index
Definition: vtkX3D.h:246
@ VTK_HEXAGONAL_PRISM
Definition: vtkCellType.h:62
int vtkIdType
Definition: vtkType.h:315
#define VTK_SIZEHINT(...)