VTK  9.0.1
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 =========================================================================*/
31 #ifndef vtkHexahedron_h
32 #define vtkHexahedron_h
33 
34 #include "vtkCell3D.h"
35 #include "vtkCommonDataModelModule.h" // For export macro
36 
37 class vtkLine;
38 class vtkQuad;
40 
41 class VTKCOMMONDATAMODEL_EXPORT vtkHexahedron : public vtkCell3D
42 {
43 public:
44  static vtkHexahedron* New();
45  vtkTypeMacro(vtkHexahedron, vtkCell3D);
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47 
49 
52  void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
53  // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
54  VTK_LEGACY(virtual void GetEdgePoints(int edgeId, int*& pts) override);
55  vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
56  // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
57  VTK_LEGACY(virtual void GetFacePoints(int faceId, int*& pts) override);
58  void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
59  vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
60  vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
61  vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
62  vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
63  bool GetCentroid(double centroid[3]) const override;
64  bool IsInsideOut() override;
66 
70  static constexpr vtkIdType NumberOfPoints = 8;
71 
75  static constexpr vtkIdType NumberOfEdges = 12;
76 
80  static constexpr vtkIdType NumberOfFaces = 6;
81 
86  static constexpr vtkIdType MaximumFaceSize = 4;
87 
93  static constexpr vtkIdType MaximumValence = 3;
94 
96 
99  int GetCellType() override { return VTK_HEXAHEDRON; }
100  int GetNumberOfEdges() override { return 12; }
101  int GetNumberOfFaces() override { return 6; }
102  vtkCell* GetEdge(int edgeId) override;
103  vtkCell* GetFace(int faceId) override;
104  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
105  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
106  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
107  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
109 
110  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
111  double& dist2, double weights[]) override;
112  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
113  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
114  double pcoords[3], int& subId) override;
115  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
117  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
118  double* GetParametricCoords() override;
119 
127  static int* GetTriangleCases(int caseId);
128 
129  static void InterpolationFunctions(const double pcoords[3], double weights[8]);
130  static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
132 
136  void InterpolateFunctions(const double pcoords[3], double weights[8]) override
137  {
138  vtkHexahedron::InterpolationFunctions(pcoords, weights);
139  }
140  void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
141  {
142  vtkHexahedron::InterpolationDerivs(pcoords, derivs);
143  }
145 
147 
155  static const vtkIdType* GetEdgeArray(vtkIdType edgeId) VTK_SIZEHINT(2);
156  static const vtkIdType* GetFaceArray(vtkIdType faceId) VTK_SIZEHINT(4);
158 
163 
168 
173 
178 
183 
187  static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
188 
194  void JacobianInverse(const double pcoords[3], double** inverse, double derivs[24]);
195 
196 protected:
198  ~vtkHexahedron() override;
199 
202 
203 private:
204  vtkHexahedron(const vtkHexahedron&) = delete;
205  void operator=(const vtkHexahedron&) = delete;
206 };
207 
208 #endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:39
object to represent cell connectivity
Definition: vtkCellArray.h:180
represent and manipulate cell attribute data
Definition: vtkCellData.h:33
abstract class to specify cell behavior
Definition: vtkCell.h:57
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:50
a cell that represents a linear 3D hexahedron
Definition: vtkHexahedron.h:42
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
static const vtkIdType * GetFaceArray(vtkIdType faceId)
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
Determine global coordinate (x[3]) from subId and 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.
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
void InterpolateFunctions(const double pcoords[3], double weights[8]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType *&pts) override
Get the ids of a one-ring surrounding point of id pointId.
static int * GetTriangleCases(int caseId)
Return the case table for table-based isocontouring (aka marching cubes style implementations).
void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&pts) override
Get the ids of the two adjacent faces to edge of id edgeId.
static vtkHexahedron * New()
bool GetCentroid(double centroid[3]) const override
Computes the centroid of the cell.
virtual void GetFacePoints(int faceId, int *&pts) override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.
vtkCell * GetEdge(int edgeId) override
Return the edge cell from the edgeId of the cell.
void GetEdgePoints(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
vtkCell * GetFace(int faceId) override
Return the face cell from the faceId of the cell.
static void InterpolationFunctions(const double pcoords[3], double weights[8])
virtual void GetEdgePoints(int edgeId, int *&pts) override
int GetNumberOfEdges() override
Return the number of edges in the cell.
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.
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds) override
Get the ids of the incident edges to point of id pointId.
bool IsInsideOut() override
Returns true if the normals of the vtkCell3D point inside the cell.
~vtkHexahedron() override
static void InterpolationDerivs(const double pcoords[3], double derivs[24])
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
Compute derivatives given cell subId and parametric coordinates.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
Get the ids of the adjacent faces to face of id faceId.
vtkLine * Line
vtkQuad * Quad
int GetNumberOfFaces() override
Return the number of faces in the cell.
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...
int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkHexahedron.h:99
vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts) override
Get the list of vertices that define a face.
void JacobianInverse(const double pcoords[3], double **inverse, double derivs[24])
Given parametric coordinates compute inverse Jacobian transformation matrix.
vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType *&faceIds) override
Get the ids of the incident faces point of id pointId.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
list of point or cell ids
Definition: vtkIdList.h:31
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:34
cell represents a 1D line
Definition: vtkLine.h:30
represent and manipulate point attribute data
Definition: vtkPointData.h:32
represent and manipulate 3D points
Definition: vtkPoints.h:34
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:36
@ points
Definition: vtkX3D.h:452
@ value
Definition: vtkX3D.h:226
@ index
Definition: vtkX3D.h:252
@ VTK_HEXAHEDRON
Definition: vtkCellType.h:58
int vtkIdType
Definition: vtkType.h:338
#define VTK_SIZEHINT(...)