VTK  9.2.6
vtkHexahedron.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkHexahedron.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 =========================================================================*/
34 #ifndef vtkHexahedron_h
35 #define vtkHexahedron_h
36 
37 #include "vtkCell3D.h"
38 #include "vtkCommonDataModelModule.h" // For export macro
39 
40 class vtkLine;
41 class vtkQuad;
43 
44 class VTKCOMMONDATAMODEL_EXPORT vtkHexahedron : public vtkCell3D
45 {
46 public:
47  static vtkHexahedron* New();
48  vtkTypeMacro(vtkHexahedron, vtkCell3D);
49  void PrintSelf(ostream& os, vtkIndent indent) override;
50 
52 
55  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
56  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
57  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
58  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
59  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
60  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
61  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
62  bool GetCentroid(double centroid[3]) const override;
64 
68  static constexpr vtkIdType NumberOfPoints = 8;
69 
73  static constexpr vtkIdType NumberOfEdges = 12;
74 
78  static constexpr vtkIdType NumberOfFaces = 6;
79 
84  static constexpr vtkIdType MaximumFaceSize = 4;
85 
91  static constexpr vtkIdType MaximumValence = 3;
92 
94 
97  int GetCellType() override { return VTK_HEXAHEDRON; }
98  int GetNumberOfEdges() override { return 12; }
99  int GetNumberOfFaces() override { return 6; }
100  vtkCell* GetEdge(int edgeId) override;
101  vtkCell* GetFace(int faceId) override;
102  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
103  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
104  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
105  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
107 
108  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
109  double& dist2, double weights[]) override;
110  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
111  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
112  double pcoords[3], int& subId) override;
113  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
114  void Derivatives(
115  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
116  double* GetParametricCoords() override;
117 
125  static int* GetTriangleCases(int caseId);
126 
127  static void InterpolationFunctions(const double pcoords[3], double weights[8]);
128  static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
130 
134  void InterpolateFunctions(const double pcoords[3], double weights[8]) override
135  {
136  vtkHexahedron::InterpolationFunctions(pcoords, weights);
137  }
138  void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
139  {
140  vtkHexahedron::InterpolationDerivs(pcoords, derivs);
141  }
143 
145 
153  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
154  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
156 
160  static const vtkIdType* GetEdgeToAdjacentFacesArray(vtkIdType edgeId) VTK_SIZEHINT(2);
161 
165  static const vtkIdType* GetFaceToAdjacentFacesArray(vtkIdType faceId) VTK_SIZEHINT(4);
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[24]);
193 
194 protected:
195  vtkHexahedron();
196  ~vtkHexahedron() override;
197 
200 
201 private:
202  vtkHexahedron(const vtkHexahedron&) = delete;
203  void operator=(const vtkHexahedron&) = delete;
204 };
205 
206 #endif
virtual vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds)=0
Get the ids of the adjacent faces to face of id faceId.
void Contour(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override
Generate contouring primitives.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkHexahedron.h:97
void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
represent and manipulate point attribute data
Definition: vtkPointData.h:41
vtkLine * Line
vtkQuad * Quad
represent and manipulate cell attribute data
Definition: vtkCellData.h:41
Abstract class in support of both point location and point insertion.
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:38
virtual bool GetCentroid(double centroid[3]) const =0
Computes the centroid of the cell.
int vtkIdType
Definition: vtkType.h:332
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkHexahedron.h:99
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...
virtual vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts)=0
Get the list of vertices that define a face.
void InterpolateFunctions(const double pcoords[3], double weights[8]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
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:33
abstract class to specify cell behavior
Definition: vtkCell.h:60
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:39
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:33
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
a cell that represents a linear 3D hexahedron
Definition: vtkHexahedron.h:44
virtual vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts)=0
Get the ids of a one-ring surrounding point of id pointId.
static void InterpolationFunctions(const double pcoords[3], double weights[8])
#define VTK_SIZEHINT(...)
static void InterpolationDerivs(const double pcoords[3], double derivs[24])
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...
object to represent cell connectivity
Definition: vtkCellArray.h:186
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkHexahedron.h:98
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 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.
represent and manipulate 3D points
Definition: vtkPoints.h:39
virtual vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds)=0
Get the ids of the incident edges to point of id pointId.