VTK  9.0.1
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:
48  static vtkHexagonalPrism* New();
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
58  VTK_LEGACY(virtual void GetEdgePoints(int edgeId, int*& pts) override);
59  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
60  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
61  VTK_LEGACY(virtual void GetFacePoints(int faceId, int*& pts) override);
62  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
63  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
64  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
65  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
66  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
67  bool GetCentroid(double centroid[3]) const override;
68  bool IsInsideOut() override;
70 
74  static constexpr vtkIdType NumberOfPoints = 12;
75 
79  static constexpr vtkIdType NumberOfEdges = 18;
80 
84  static constexpr vtkIdType NumberOfFaces = 8;
85 
90  static constexpr vtkIdType MaximumFaceSize = 6;
91 
97  static constexpr vtkIdType MaximumValence = 3;
98 
100 
103  int GetCellType() override { return VTK_HEXAGONAL_PRISM; }
104  int GetCellDimension() override { return 3; }
105  int GetNumberOfEdges() override { return 18; }
106  int GetNumberOfFaces() override { return 8; }
107  vtkCell* GetEdge(int edgeId) override;
108  vtkCell* GetFace(int faceId) override;
109  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
111 
112  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
113  double& dist2, double weights[]) override;
114  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
115  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
116  double pcoords[3], int& subId) override;
117  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
118  void Derivatives(
119  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
120  double* GetParametricCoords() override;
121 
125  int GetParametricCenter(double pcoords[3]) override;
126 
127  static void InterpolationFunctions(const double pcoords[3], double weights[12]);
128  static void InterpolationDerivs(const double pcoords[3], double derivs[36]);
130 
134  void InterpolateFunctions(const double pcoords[3], double weights[12]) override
135  {
137  }
138  void InterpolateDerivs(const double pcoords[3], double derivs[36]) override
139  {
141  }
143 
145 
153  static const vtkIdType* GetEdgeArray(vtkIdType edgeId);
154  static const vtkIdType* GetFaceArray(vtkIdType faceId);
156 
160  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
161 
165  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(6);
166 
170  static const vtkIdType* GetPointToIncidentEdgesArray(vtkIdType pointId) VTK_SIZEHINT(3);
171 
175  static const vtkIdType* GetPointToIncidentFacesArray(vtkIdType pointId) VTK_SIZEHINT(3);
176 
180  static const vtkIdType* GetPointToOneRingPointsArray(vtkIdType pointId) VTK_SIZEHINT(3);
181 
185  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
186 
192  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[36]);
193 
194 protected:
196  ~vtkHexagonalPrism() override;
197 
201 
202 private:
203  vtkHexagonalPrism(const vtkHexagonalPrism&) = delete;
204  void operator=(const vtkHexagonalPrism&) = delete;
205 };
206 
207 //----------------------------------------------------------------------------
208 inline int vtkHexagonalPrism::GetParametricCenter(double pcoords[3])
209 {
210  pcoords[0] = pcoords[1] = 0.5;
211  pcoords[2] = 0.5;
212  return 0;
213 }
214 #endif
virtual vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds)=0
Get the ids of the adjacent faces to face of id faceId.
void InterpolateDerivs(const double pcoords[3], double derivs[36]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
static void InterpolationFunctions(const double pcoords[3], double weights[12])
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
int GetParametricCenter(double pcoords[3]) override
Return the center of the wedge in parametric coordinates.
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:35
int vtkIdType
Definition: vtkType.h:338
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:38
virtual int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts)=0
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
a 3D cell that represents a prism with hexagonal base
virtual vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts)=0
Get the list of vertices that define a face.
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
virtual void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts)=0
Get the pair of vertices that define an edge.
cell represents a 1D line
Definition: vtkLine.h:29
abstract class to specify cell behavior
Definition: vtkCell.h:56
virtual void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights)=0
Determine global coordinate (x[3]) from subId and parametric coordinates.
a simple class to control print indentation
Definition: vtkIndent.h:33
virtual void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&faceIds)=0
Get the ids of the two adjacent faces to edge of id edgeId.
list of point or cell ids
Definition: vtkIdList.h:30
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
a cell that represents an n-sided polygon
Definition: vtkPolygon.h:39
virtual vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts)=0
Get the ids of a one-ring surrounding point of id pointId.
#define VTK_SIZEHINT(...)
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
virtual int EvaluatePosition(const double x[3], double closestPoint[3], int &subId, double pcoords[3], double &dist2, double weights[])=0
Given a point x[3] return inside(=1), outside(=0) cell, or (-1) computational problem encountered; ev...
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
virtual void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs)=0
Compute derivatives given cell subId and parametric coordinates.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this cell.
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
virtual int IntersectWithLine(const double p1[3], const double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)=0
Intersect with a ray.
virtual vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds)=0
Get the ids of the incident faces point of id pointId.
void InterpolateFunctions(const double pcoords[3], double weights[12]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
virtual bool IsInsideOut()
Returns true if the normals of the vtkCell3D point inside the cell.
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
static void InterpolationDerivs(const double pcoords[3], double derivs[36])
represent and manipulate 3D points
Definition: vtkPoints.h:33
int GetCellType() override
See the vtkCell API for descriptions of these methods.
virtual vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds)=0
Get the ids of the incident edges to point of id pointId.