VTK  9.1.0
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=========================================================================*/
100#ifndef vtkHexahedron_h
101#define vtkHexahedron_h
102
103#include "vtkCell3D.h"
104#include "vtkCommonDataModelModule.h" // For export macro
105
106class vtkLine;
107class vtkQuad;
109
110class VTKCOMMONDATAMODEL_EXPORT vtkHexahedron : public vtkCell3D
111{
112public:
114 vtkTypeMacro(vtkHexahedron, vtkCell3D);
115 void PrintSelf(ostream& os, vtkIndent indent) override;
116
118
121 void GetEdgePoints(vtkIdType edgeId, const vtkIdType*& pts) override;
122 // @deprecated Replaced by GetEdgePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
123 VTK_DEPRECATED_IN_9_0_0("Replaced by vtkHexahedron::GetEdgePoints(vtkIdType, const vtkIdType*&)")
124 void GetEdgePoints(int edgeId, int*& pts) override;
125 vtkIdType GetFacePoints(vtkIdType faceId, const vtkIdType*& pts) override;
126 // @deprecated Replaced by GetFacePoints(vtkIdType, const vtkIdType*&) as of VTK 9.0
127 VTK_DEPRECATED_IN_9_0_0("Replaced by vtkHexahedron::GetFacePoints(vtkIdType, const vtkIdType*&)")
128 void GetFacePoints(int faceId, int*& pts) override;
129 void GetEdgeToAdjacentFaces(vtkIdType edgeId, const vtkIdType*& pts) override;
130 vtkIdType GetFaceToAdjacentFaces(vtkIdType faceId, const vtkIdType*& faceIds) override;
131 vtkIdType GetPointToIncidentEdges(vtkIdType pointId, const vtkIdType*& edgeIds) override;
132 vtkIdType GetPointToIncidentFaces(vtkIdType pointId, const vtkIdType*& faceIds) override;
133 vtkIdType GetPointToOneRingPoints(vtkIdType pointId, const vtkIdType*& pts) override;
134 bool GetCentroid(double centroid[3]) const override;
136
140 static constexpr vtkIdType NumberOfPoints = 8;
141
145 static constexpr vtkIdType NumberOfEdges = 12;
146
150 static constexpr vtkIdType NumberOfFaces = 6;
151
156 static constexpr vtkIdType MaximumFaceSize = 4;
157
163 static constexpr vtkIdType MaximumValence = 3;
164
166
169 int GetCellType() override { return VTK_HEXAHEDRON; }
170 int GetNumberOfEdges() override { return 12; }
171 int GetNumberOfFaces() override { return 6; }
172 vtkCell* GetEdge(int edgeId) override;
173 vtkCell* GetFace(int faceId) override;
174 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
175 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
176 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
177 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
179
180 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
181 double& dist2, double weights[]) override;
182 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
183 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
184 double pcoords[3], int& subId) override;
185 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
187 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
188 double* GetParametricCoords() override;
189
197 static int* GetTriangleCases(int caseId);
198
199 static void InterpolationFunctions(const double pcoords[3], double weights[8]);
200 static void InterpolationDerivs(const double pcoords[3], double derivs[24]);
202
206 void InterpolateFunctions(const double pcoords[3], double weights[8]) override
207 {
209 }
210 void InterpolateDerivs(const double pcoords[3], double derivs[24]) override
211 {
212 vtkHexahedron::InterpolationDerivs(pcoords, derivs);
213 }
215
217
228
233
238
243
248
253
257 static bool ComputeCentroid(vtkPoints* points, const vtkIdType* pointIds, double centroid[3]);
258
264 void JacobianInverse(const double pcoords[3], double** inverse, double derivs[24]);
265
266protected:
268 ~vtkHexahedron() override;
269
272
273private:
274 vtkHexahedron(const vtkHexahedron&) = delete;
275 void operator=(const vtkHexahedron&) = delete;
276};
277
278#endif
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:40
object to represent cell connectivity
Definition: vtkCellArray.h:290
represent and manipulate cell attribute data
Definition: vtkCellData.h:142
abstract class to specify cell behavior
Definition: vtkCell.h:147
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
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)
static const vtkIdType * GetEdgeToAdjacentFacesArray(vtkIdType edgeId)
Static method version of GetEdgeToAdjacentFaces.
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.
~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.
static const vtkIdType * GetFaceToAdjacentFacesArray(vtkIdType faceId)
Static method version of GetFaceToAdjacentFaces.
vtkLine * Line
vtkQuad * Quad
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.
void JacobianInverse(const double pcoords[3], double **inverse, double derivs[24])
Given parametric coordinates compute inverse Jacobian transformation matrix.
list of point or cell ids
Definition: vtkIdList.h:140
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:113
cell represents a 1D line
Definition: vtkLine.h:140
represent and manipulate point attribute data
Definition: vtkPointData.h:142
represent and manipulate 3D points
Definition: vtkPoints.h:143
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:95
@ VTK_HEXAHEDRON
Definition: vtkCellType.h:97
#define VTK_DEPRECATED_IN_9_0_0(reason)
int vtkIdType
Definition: vtkType.h:332
#define VTK_SIZEHINT(...)