VTK  9.5.20251211
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
74
75#ifndef vtkHexagonalPrism_h
76#define vtkHexagonalPrism_h
77
78#include "vtkCell3D.h"
79#include "vtkCommonDataModelModule.h" // For export macro
80
81VTK_ABI_NAMESPACE_BEGIN
82class vtkLine;
83class vtkPolygon;
84class vtkQuad;
85
86class VTKCOMMONDATAMODEL_EXPORT vtkHexagonalPrism : public vtkCell3D
87{
88public:
91 void PrintSelf(ostream& os, vtkIndent indent) override;
92
94
97 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
98 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
99 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
100 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
101 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
102 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
103 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
104 bool GetCentroid(double centroid[3]) const override;
105 bool IsInsideOut() override;
107
111 static constexpr vtkIdType NumberOfPoints = 12;
112
116 static constexpr vtkIdType NumberOfEdges = 18;
117
121 static constexpr vtkIdType NumberOfFaces = 8;
122
127 static constexpr vtkIdType MaximumFaceSize = 6;
128
134 static constexpr vtkIdType MaximumValence = 3;
135
137
140 int GetCellType() override { return VTK_HEXAGONAL_PRISM; }
141 int GetCellDimension() override { return 3; }
142 int GetNumberOfEdges() override { return 18; }
143 int GetNumberOfFaces() override { return 8; }
144 vtkCell* GetEdge(int edgeId) override;
145 vtkCell* GetFace(int faceId) override;
146 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
148
149 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
150 double& dist2, double weights[]) override;
151 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
152 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
153 double pcoords[3], int& subId) override;
154 int TriangulateLocalIds(int index, vtkIdList* ptIds) override;
156 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
157 double* GetParametricCoords() override;
158
162 int GetParametricCenter(double pcoords[3]) override;
163
164 static void InterpolationFunctions(const double pcoords[3], double weights[12]);
165 static void InterpolationDerivs(const double pcoords[3], double derivs[36]);
167
171 void InterpolateFunctions(const double pcoords[3], double weights[12]) override
172 {
174 }
175 void InterpolateDerivs(const double pcoords[3], double derivs[36]) override
176 {
178 }
179
180
182
190 static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
191 static const vtkIdType* GetFaceArray(vtkIdType faceId);
193
198
203
208
213
218
222 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
223
229 void JacobianInverse(const double pcoords[3], double** inverse, double derivs[36]);
230
231protected:
234
238
239private:
240 vtkHexagonalPrism(const vtkHexagonalPrism&) = delete;
241 void operator=(const vtkHexagonalPrism&) = delete;
242};
243
244//----------------------------------------------------------------------------
245inline int vtkHexagonalPrism::GetParametricCenter(double pcoords[3])
246{
247 pcoords[0] = pcoords[1] = 0.5;
248 pcoords[2] = 0.5;
249 return 0;
250}
251VTK_ABI_NAMESPACE_END
252#endif
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
static void InterpolationFunctions(const double pcoords[3], double weights[12])
static vtkHexagonalPrism * New()
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.
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 InterpolateDerivs(const double pcoords[3], double derivs[36]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
static constexpr vtkIdType NumberOfFaces
static contexpr handle on the number of edges.
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.
static constexpr vtkIdType NumberOfEdges
static contexpr handle on the number of faces.
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
Determine global coordinate (x[3]) from subId and parametric coordinates.
static const vtkIdType * GetFaceArray(vtkIdType faceId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.
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.
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
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 * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
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...
vtkCell * GetFace(int faceId) override
See the vtkCell API for descriptions of these methods.
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 * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
static constexpr vtkIdType NumberOfPoints
static constexpr handle on the number of points.
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
static constexpr vtkIdType MaximumFaceSize
static contexpr handle on the maximum face size.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
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.
void JacobianInverse(const double pcoords[3], double **inverse, double derivs[36])
Given parametric coordinates compute inverse Jacobian transformation matrix.
int TriangulateLocalIds(int index, vtkIdList *ptIds) override
Generate simplices of proper dimension.
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 constexpr vtkIdType MaximumValence
static constexpr handle on the maximum valence of this cell.
list of point or cell ids
Definition vtkIdList.h:133
a simple class to control print indentation
Definition vtkIndent.h:108
cell represents a 1D line
Definition vtkLine.h:132
represent and manipulate 3D points
Definition vtkPoints.h:139
a cell that represents an n-sided polygon
Definition vtkPolygon.h:132
a cell that represents a 2D quadrilateral
Definition vtkQuad.h:87
@ VTK_HEXAGONAL_PRISM
Definition vtkCellType.h:52
int vtkIdType
Definition vtkType.h:367
#define VTK_SIZEHINT(...)