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
26#ifndef vtkHexagonalPrism_h
27#define vtkHexagonalPrism_h
28
29#include "vtkCell3D.h"
30#include "vtkCommonDataModelModule.h" // For export macro
31
32VTK_ABI_NAMESPACE_BEGIN
33class vtkLine;
34class vtkPolygon;
35class vtkQuad;
36
37class VTKCOMMONDATAMODEL_EXPORT vtkHexagonalPrism : public vtkCell3D
38{
39public:
42 void PrintSelf(ostream& os, vtkIndent indent) override;
43
45
48 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
49 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
50 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
51 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
52 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
53 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
54 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
55 bool GetCentroid(double centroid[3]) const override;
56 bool IsInsideOut() override;
58
62 static constexpr vtkIdType NumberOfPoints = 12;
63
67 static constexpr vtkIdType NumberOfEdges = 18;
68
72 static constexpr vtkIdType NumberOfFaces = 8;
73
78 static constexpr vtkIdType MaximumFaceSize = 6;
79
85 static constexpr vtkIdType MaximumValence = 3;
86
88
91 int GetCellType() override { return VTK_HEXAGONAL_PRISM; }
92 int GetCellDimension() override { return 3; }
93 int GetNumberOfEdges() override { return 18; }
94 int GetNumberOfFaces() override { return 8; }
95 vtkCell* GetEdge(int edgeId) override;
96 vtkCell* GetFace(int faceId) override;
97 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
99
100 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
101 double& dist2, double weights[]) override;
102 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
103 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
104 double pcoords[3], int& subId) override;
105 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
107 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
108 double* GetParametricCoords() override;
109
113 int GetParametricCenter(double pcoords[3]) override;
114
115 static void InterpolationFunctions(const double pcoords[3], double weights[12]);
116 static void InterpolationDerivs(const double pcoords[3], double derivs[36]);
118
122 void InterpolateFunctions(const double pcoords[3], double weights[12]) override
123 {
125 }
126 void InterpolateDerivs(const double pcoords[3], double derivs[36]) override
127 {
129 }
131
133
141 static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
142 static const vtkIdType* GetFaceArray(vtkIdType faceId);
144
149
154
159
164
169
173 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
174
180 void JacobianInverse(const double pcoords[3], double** inverse, double derivs[36]);
181
182protected:
185
189
190private:
191 vtkHexagonalPrism(const vtkHexagonalPrism&) = delete;
192 void operator=(const vtkHexagonalPrism&) = delete;
193};
194
195//----------------------------------------------------------------------------
196inline int vtkHexagonalPrism::GetParametricCenter(double pcoords[3])
197{
198 pcoords[0] = pcoords[1] = 0.5;
199 pcoords[2] = 0.5;
200 return 0;
201}
202VTK_ABI_NAMESPACE_END
203#endif
abstract class to specify 3D cell interface
Definition vtkCell3D.h:28
abstract class to specify cell behavior
Definition vtkCell.h:50
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 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)
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.
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.
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.
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.
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.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
list of point or cell ids
Definition vtkIdList.h:23
a simple class to control print indentation
Definition vtkIndent.h:29
cell represents a 1D line
Definition vtkLine.h:23
represent and manipulate 3D points
Definition vtkPoints.h:29
a cell that represents an n-sided polygon
Definition vtkPolygon.h:32
a cell that represents a 2D quadrilateral
Definition vtkQuad.h:28
@ VTK_HEXAGONAL_PRISM
Definition vtkCellType.h:53
int vtkIdType
Definition vtkType.h:315
#define VTK_SIZEHINT(...)