VTK  9.1.0
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=========================================================================*/
84#ifndef vtkHexagonalPrism_h
85#define vtkHexagonalPrism_h
86
87#include "vtkCell3D.h"
88#include "vtkCommonDataModelModule.h" // For export macro
89
90class vtkLine;
91class vtkPolygon;
92class vtkQuad;
93
94class VTKCOMMONDATAMODEL_EXPORT vtkHexagonalPrism : public vtkCell3D
95{
96public:
99 void PrintSelf(ostream& os, vtkIndent indent) override;
100
102
105 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
106 // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
108 "Replaced by vtkHexagonalPrism::GetEdgePoints(vtkIdType, const vtkIdType*&)")
109 void GetEdgePoints(int edgeId, int*& pts) override;
110 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
111 // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
113 "Replaced by vtkHexagonalPrism::GetFacePoints(vtkIdType, const vtkIdType*&)")
114 void GetFacePoints(int faceId, int*& pts) override;
115 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
116 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
117 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
118 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
119 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
120 bool GetCentroid(double centroid[3]) const override;
121 bool IsInsideOut() override;
123
127 static constexpr vtkIdType NumberOfPoints = 12;
128
132 static constexpr vtkIdType NumberOfEdges = 18;
133
137 static constexpr vtkIdType NumberOfFaces = 8;
138
143 static constexpr vtkIdType MaximumFaceSize = 6;
144
150 static constexpr vtkIdType MaximumValence = 3;
151
153
156 int GetCellType() override { return VTK_HEXAGONAL_PRISM; }
157 int GetCellDimension() override { return 3; }
158 int GetNumberOfEdges() override { return 18; }
159 int GetNumberOfFaces() override { return 8; }
160 vtkCell* GetEdge(int edgeId) override;
161 vtkCell* GetFace(int faceId) override;
162 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
164
165 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
166 double& dist2, double weights[]) override;
167 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
168 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
169 double pcoords[3], int& subId) override;
170 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
172 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
173 double* GetParametricCoords() override;
174
178 int GetParametricCenter(double pcoords[3]) override;
179
180 static void InterpolationFunctions(const double pcoords[3], double weights[12]);
181 static void InterpolationDerivs(const double pcoords[3], double derivs[36]);
183
187 void InterpolateFunctions(const double pcoords[3], double weights[12]) override
188 {
190 }
191 void InterpolateDerivs(const double pcoords[3], double derivs[36]) override
192 {
194 }
196
198
206 static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
207 static const vtkIdType* GetFaceArray(vtkIdType faceId);
209
214
219
224
229
234
238 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
239
245 void JacobianInverse(const double pcoords[3], double** inverse, double derivs[36]);
246
247protected:
250
254
255private:
256 vtkHexagonalPrism(const vtkHexagonalPrism&) = delete;
257 void operator=(const vtkHexagonalPrism&) = delete;
258};
259
260//----------------------------------------------------------------------------
261inline int vtkHexagonalPrism::GetParametricCenter(double pcoords[3])
262{
263 pcoords[0] = pcoords[1] = 0.5;
264 pcoords[2] = 0.5;
265 return 0;
266}
267#endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:40
abstract class to specify cell behavior
Definition: vtkCell.h:147
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.
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)
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’).
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.
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.
void JacobianInverse(const double pcoords[3], double **inverse, double derivs[36])
Given parametric coordinates compute inverse Jacobian transformation matrix.
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:140
a simple class to control print indentation
Definition: vtkIndent.h:113
cell represents a 1D line
Definition: vtkLine.h:140
represent and manipulate 3D points
Definition: vtkPoints.h:143
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:149
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:95
@ VTK_HEXAGONAL_PRISM
Definition: vtkCellType.h:101
#define VTK_DEPRECATED_IN_9_0_0(reason)
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)