VTK  9.1.0
vtkHigherOrderHexahedron.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkHigherOrderHexahedron.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=========================================================================*/
26#ifndef vtkHigherOrderHexahedron_h
27#define vtkHigherOrderHexahedron_h
28
29#include "vtkCellType.h" // For GetCellType.
30#include "vtkCommonDataModelModule.h" // For export macro
31#include "vtkDeprecation.h" // For deprecation macros
32#include "vtkNew.h" // For member variable.
33#include "vtkNonLinearCell.h"
34#include "vtkSmartPointer.h" // For member variable.
35#include <functional> //For std::function
36
37class vtkCellData;
38class vtkDoubleArray;
39class vtkHexahedron;
40class vtkIdList;
44class vtkPointData;
45class vtkPoints;
46class vtkVector3d;
47class vtkVector3i;
48
49class VTKCOMMONDATAMODEL_EXPORT vtkHigherOrderHexahedron : public vtkNonLinearCell
50{
51public:
53 void PrintSelf(ostream& os, vtkIndent indent) override;
54
55 int GetCellType() override = 0;
56 int GetCellDimension() override { return 3; }
57 int RequiresInitialization() override { return 1; }
58 int GetNumberOfEdges() override { return 12; }
59 int GetNumberOfFaces() override { return 6; }
60 vtkCell* GetEdge(int edgeId) override = 0;
61 vtkCell* GetFace(int faceId) override = 0;
62 void SetEdgeIdsAndPoints(int edgeId,
63 const std::function<void(const vtkIdType&)>& set_number_of_ids_and_points,
64 const std::function<void(const vtkIdType&, const vtkIdType&)>& set_ids_and_points);
66 const std::function<void(const vtkIdType&)>& set_number_of_ids_and_points,
67 const std::function<void(const vtkIdType&, const vtkIdType&)>& set_ids_and_points);
68
69 void Initialize() override;
70
71 int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
72 int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
73 double& dist2, double weights[]) override;
74 void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
75 void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
76 vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
77 vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
78 void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
79 vtkCellArray* polys, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
80 vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
81 int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
82 double pcoords[3], int& subId) override;
83 int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
85 int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
87 double* GetParametricCoords() override;
88 int GetParametricCenter(double center[3]) override;
89
90 double GetParametricDistance(const double pcoords[3]) override;
91
93 vtkCellData* cell_data, const vtkIdType numPts, const vtkIdType cell_id);
94 virtual void SetUniformOrderFromNumPoints(const vtkIdType numPts);
95 virtual void SetOrder(const int s, const int t, const int u);
96 virtual const int* GetOrder();
97 virtual int GetOrder(int i) { return this->GetOrder()[i]; }
98
99 void InterpolateFunctions(const double pcoords[3], double* weights) override = 0;
100 void InterpolateDerivs(const double pcoords[3], double* derivs) override = 0;
101
103 bool SubCellCoordinatesFromId(int& i, int& j, int& k, int subId);
104 static int PointIndexFromIJK(int i, int j, int k, const int* order);
105 int PointIndexFromIJK(int i, int j, int k);
106 bool TransformApproxToCellParams(int subCell, double* pcoords);
107 bool TransformFaceToCellParams(int bdyFace, double* pcoords);
109 VTK_DEPRECATED_IN_9_1_0("renamed to GetEdgeCell")
110 virtual vtkHigherOrderCurve* getEdgeCell();
111 virtual vtkHigherOrderQuadrilateral* GetFaceCell() = 0;
112 VTK_DEPRECATED_IN_9_1_0("renamed to GetFaceCell")
113 virtual vtkHigherOrderQuadrilateral* getFaceCell();
114 virtual vtkHigherOrderInterpolation* GetInterpolation() = 0;
115 VTK_DEPRECATED_IN_9_1_0("renamed to GetInterpolation")
116 virtual vtkHigherOrderInterpolation* getInterp();
117
118 static vtkIdType NodeNumberingMappingFromVTK8To9(
119 const int order[3], const vtkIdType node_id_vtk8);
120
121protected:
124
125 vtkHexahedron* GetApprox();
126 void PrepareApproxData(
127 vtkPointData* pd, vtkCellData* cd, vtkIdType cellId, vtkDataArray* cellScalars);
128 virtual vtkHexahedron* GetApproximateHex(
129 int subId, vtkDataArray* scalarsIn = nullptr, vtkDataArray* scalarsOut = nullptr) = 0;
130
131 int Order[4];
132 vtkSmartPointer<vtkPoints> PointParametricCoordinates;
136 vtkNew<vtkDoubleArray> CellScalars;
140
141private:
143 void operator=(const vtkHigherOrderHexahedron&) = delete;
144};
145
146inline int vtkHigherOrderHexahedron::GetParametricCenter(double center[3])
147{
148 center[0] = center[1] = center[2] = 0.5;
149 return 0;
150}
151
152#endif // vtkHigherOrderHexahedron_h
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
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:159
dynamic, self-adjusting array of double
a cell that represents a linear 3D hexahedron
A 3D cell that represents an arbitrary order HigherOrder hex.
void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut) override
Cut (or clip) the cell based on the input cellScalars and the specified value.
virtual void SetOrderFromCellData(vtkCellData *cell_data, const vtkIdType numPts, const vtkIdType cell_id)
bool TransformFaceToCellParams(int bdyFace, double *pcoords)
void SetFaceIdsAndPoints(vtkHigherOrderQuadrilateral *result, int faceId, const std::function< void(const vtkIdType &)> &set_number_of_ids_and_points, const std::function< void(const vtkIdType &, const vtkIdType &)> &set_ids_and_points)
bool SubCellCoordinatesFromId(vtkVector3i &ijk, int subId)
void InterpolateFunctions(const double pcoords[3], double *weights) override=0
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.
static int PointIndexFromIJK(int i, int j, int k, const int *order)
void EvaluateLocation(int &subId, const double pcoords[3], double x[3], double *weights) override
Determine global coordinate (x[3]) from subId and parametric coordinates.
void InterpolateDerivs(const double pcoords[3], double *derivs) override=0
vtkCell * GetFace(int faceId) override=0
Return the face cell from the faceId of the cell.
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.
int PointIndexFromIJK(int i, int j, int k)
virtual void SetOrder(const int s, const int t, const int u)
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
Compute derivatives given cell subId and parametric coordinates.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
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...
virtual vtkHigherOrderCurve * GetEdgeCell()=0
int GetNumberOfEdges() override
Return the number of edges in the cell.
virtual const int * GetOrder()
void Initialize() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetNumberOfFaces() override
Return the number of faces in the cell.
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 RequiresInitialization() override
Some cells require initialization prior to access.
int GetCellType() override=0
Return the type of 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.
void SetEdgeIdsAndPoints(int edgeId, const std::function< void(const vtkIdType &)> &set_number_of_ids_and_points, const std::function< void(const vtkIdType &, const vtkIdType &)> &set_ids_and_points)
vtkCell * GetEdge(int edgeId) override=0
Return the edge cell from the edgeId of the cell.
bool SubCellCoordinatesFromId(int &i, int &j, int &k, int subId)
bool TransformApproxToCellParams(int subCell, double *pcoords)
virtual void SetUniformOrderFromNumPoints(const vtkIdType numPts)
double GetParametricDistance(const double pcoords[3]) override
Return the distance of the parametric coordinate provided to the cell.
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
Allocate and hold a VTK object.
Definition: vtkNew.h:165
abstract superclass for non-linear cells
represent and manipulate point attribute data
Definition: vtkPointData.h:142
represent and manipulate 3D points
Definition: vtkPoints.h:143
Hold a reference to a vtkObjectBase instance.
#define VTK_DEPRECATED_IN_9_1_0(reason)
int vtkIdType
Definition: vtkType.h:332