VTK  9.3.0
vtkHexahedron.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
22#ifndef vtkHexahedron_h
23#define vtkHexahedron_h
24
25#include "vtkCell3D.h"
26#include "vtkCommonDataModelModule.h" // For export macro
27
28VTK_ABI_NAMESPACE_BEGIN
29class vtkLine;
30class vtkQuad;
32
33class VTKCOMMONDATAMODEL_EXPORT vtkHexahedron : public vtkCell3D
34{
35public:
36 static vtkHexahedron* New();
37 vtkTypeMacro(vtkHexahedron, vtkCell3D);
38 void PrintSelf(ostream& os, vtkIndent indent) override;
39
41
44 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
45 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
46 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
47 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
48 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
49 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
50 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
51 bool GetCentroid(double centroid[3]) const override;
53
57 static constexpr vtkIdType NumberOfPoints = 8;
58
62 static constexpr vtkIdType NumberOfEdges = 12;
63
67 static constexpr vtkIdType NumberOfFaces = 6;
68
73 static constexpr vtkIdType MaximumFaceSize = 4;
74
80 static constexpr vtkIdType MaximumValence = 3;
81
83
86 int GetCellType() override { return VTK_HEXAHEDRON; }
87 int GetNumberOfEdges() override { return 12; }
88 int GetNumberOfFaces() override { return 6; }
89 vtkCell* GetEdge(int edgeId) override;
90 vtkCell* GetFace(int faceId) override;
91 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
92 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
93 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
94 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
96
97 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
98 double& dist2, double weights[]) override;
99 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
100 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
101 double pcoords[3], int& subId) override;
102 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
104 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
105 double* GetParametricCoords() override;
106
114 static int* GetTriangleCases(int caseId);
115
116 static void InterpolationFunctions(const double pcoords[3], double weights[8]);
117 static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
119
123 void InterpolateFunctions(const double pcoords[3], double weights[8]) override
124 {
126 }
127 void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
128 {
129 vtkHexahedron::InterpolationDerivs(pcoords, derivs);
130 }
132
134
145
150
155
160
165
170
174 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
175
181 void JacobianInverse(const double pcoords[3], double** inverse, double derivs[24]);
182
183protected:
185 ~vtkHexahedron() override;
186
189
190private:
191 vtkHexahedron(const vtkHexahedron&) = delete;
192 void operator=(const vtkHexahedron&) = delete;
193};
194
195VTK_ABI_NAMESPACE_END
196#endif
abstract class to specify 3D cell interface
Definition vtkCell3D.h:28
object to represent cell connectivity
represent and manipulate cell attribute data
Definition vtkCellData.h:31
abstract class to specify cell behavior
Definition vtkCell.h:50
abstract superclass for arrays of numeric data
a cell that represents a linear 3D hexahedron
static const vtkIdType * GetPointToIncidentFacesArray(vtkIdType pointId)
Static method version of GetPointToIncidentFacesArray.
void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives)
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.
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.
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
See vtkCell3D API for description of these methods.
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
bool GetCentroid(double centroid[3]) const override
See vtkCell3D API for description of these methods.
static int * GetTriangleCases(int caseId)
Return the case table for table-based isocontouring (aka marching cubes style implementations).
static const vtkIdType * GetPointToIncidentEdgesArray(vtkIdType pointId)
Static method version of GetPointToIncidentEdgesArray.
static const vtkIdType * GetPointToOneRingPointsArray(vtkIdType pointId)
Static method version of GetPointToOneRingPoints.
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 void InterpolationFunctions(const double pcoords[3], double weights[8])
vtkCell * GetFace(int faceId) override
See the vtkCell API for descriptions of these methods.
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
static const vtkIdType * GetFaceArray(vtkIdType faceId)
Return the ids of the vertices defining edge/face (edgeId/‘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
See the vtkCell API for descriptions of these methods.
static const vtkIdType * GetEdgeArray(vtkIdType edgeId)
Return the ids of the vertices defining edge/face (edgeId/‘faceId’).
static bool ComputeCentroid(vtkPoints *points, const vtkIdType *pointIds, double centroid[3])
Static method version of GetCentroid.
vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType *&edgeIds) override
See vtkCell3D API for description of these methods.
~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.
vtkCell * GetEdge(int edgeId) override
See the vtkCell API for descriptions of these methods.
vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType *&faceIds) override
See vtkCell3D API for description of these methods.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
static vtkHexahedron * New()
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
See the vtkCell API for descriptions of these methods.
int GetCellType() override
See the vtkCell API for descriptions of these methods.
vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType *&pts) override
See vtkCell3D API for description of these methods.
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
See vtkCell3D API for description of these methods.
list of point or cell ids
Definition vtkIdList.h:23
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition vtkIndent.h:29
cell represents a 1D line
Definition vtkLine.h:23
represent and manipulate point attribute data
represent and manipulate 3D points
Definition vtkPoints.h:29
a cell that represents a 2D quadrilateral
Definition vtkQuad.h:28
@ VTK_HEXAHEDRON
Definition vtkCellType.h:49
int vtkIdType
Definition vtkType.h:315
#define VTK_SIZEHINT(...)