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 =========================================================================*/
35 #ifndef vtkHexagonalPrism_h
36 #define vtkHexagonalPrism_h
37 
38 #include "vtkCell3D.h"
39 #include "vtkCommonDataModelModule.h" // For export macro
40 
41 class vtkLine;
42 class vtkPolygon;
43 class vtkQuad;
44 
45 class VTKCOMMONDATAMODEL_EXPORT vtkHexagonalPrism : public vtkCell3D
46 {
47 public:
49  vtkTypeMacro(vtkHexagonalPrism, vtkCell3D);
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
53 
56  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
57  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
59  "Replaced by vtkHexagonalPrism::GetEdgePoints(vtkIdType, const vtkIdType*&)")
60  void GetEdgePoints(int edgeId, int*& pts) override;
61  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
62  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
64  "Replaced by vtkHexagonalPrism::GetFacePoints(vtkIdType, const vtkIdType*&)")
65  void GetFacePoints(int faceId, int*& pts) override;
66  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
67  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
68  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
69  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
70  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
71  bool GetCentroid(double centroid[3]) const override;
72  bool IsInsideOut() override;
74 
78  static constexpr vtkIdType NumberOfPoints = 12;
79 
83  static constexpr vtkIdType NumberOfEdges = 18;
84 
88  static constexpr vtkIdType NumberOfFaces = 8;
89 
94  static constexpr vtkIdType MaximumFaceSize = 6;
95 
101  static constexpr vtkIdType MaximumValence = 3;
102 
104 
107  int GetCellType() override { return VTK_HEXAGONAL_PRISM; }
108  int GetCellDimension() override { return 3; }
109  int GetNumberOfEdges() override { return 18; }
110  int GetNumberOfFaces() override { return 8; }
111  vtkCell* GetEdge(int edgeId) override;
112  vtkCell* GetFace(int faceId) override;
113  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
115 
116  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
117  double& dist2, double weights[]) override;
118  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
119  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
120  double pcoords[3], int& subId) override;
121  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
123  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
124  double* GetParametricCoords() override;
125 
129  int GetParametricCenter(double pcoords[3]) override;
130 
131  static void InterpolationFunctions(const double pcoords[3], double weights[12]);
132  static void InterpolationDerivs(const double pcoords[3], double derivs[36]);
134 
138  void InterpolateFunctions(const double pcoords[3], double weights[12]) override
139  {
141  }
142  void InterpolateDerivs(const double pcoords[3], double derivs[36]) override
143  {
145  }
147 
149 
157  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
158  static const vtkIdType* GetFaceArray(vtkIdType faceId);
160 
165 
170 
175 
180 
185 
189  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
190 
196  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[36]);
197 
198 protected:
200  ~vtkHexagonalPrism() override;
201 
205 
206 private:
207  vtkHexagonalPrism(const vtkHexagonalPrism&) = delete;
208  void operator=(const vtkHexagonalPrism&) = delete;
209 };
210 
211 //----------------------------------------------------------------------------
212 inline int vtkHexagonalPrism::GetParametricCenter(double pcoords[3])
213 {
214  pcoords[0] = pcoords[1] = 0.5;
215  pcoords[2] = 0.5;
216  return 0;
217 }
218 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:40
abstract class to specify cell behavior
Definition: vtkCell.h:58
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.
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.
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 * 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.
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.
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
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.
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:31
a simple class to control print indentation
Definition: vtkIndent.h:34
cell represents a 1D line
Definition: vtkLine.h:31
represent and manipulate 3D points
Definition: vtkPoints.h:34
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:40
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:36
int GetCellType(const Ioss::ElementTopology *topology)
Returns VTK celltype for a Ioss topology element.
@ points
Definition: vtkX3D.h:452
@ index
Definition: vtkX3D.h:252
@ VTK_HEXAGONAL_PRISM
Definition: vtkCellType.h:62
#define VTK_DEPRECATED_IN_9_0_0(reason)
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)