VTK  9.2.6
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 
37 class vtkCellData;
38 class vtkDoubleArray;
39 class vtkHexahedron;
40 class vtkIdList;
44 class vtkPointData;
45 class vtkPoints;
46 class vtkVector3d;
47 class vtkVector3i;
48 
49 class VTKCOMMONDATAMODEL_EXPORT vtkHigherOrderHexahedron : public vtkNonLinearCell
50 {
51 public:
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);
65  void SetFaceIdsAndPoints(vtkHigherOrderQuadrilateral* result, int faceId,
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;
84  void Derivatives(
85  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
86  void SetParametricCoords();
87  double* GetParametricCoords() override;
88  int GetParametricCenter(double center[3]) override;
89 
90  double GetParametricDistance(const double pcoords[3]) override;
91 
92  virtual void SetOrderFromCellData(
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 
102  bool SubCellCoordinatesFromId(vtkVector3i& ijk, int subId);
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);
108  virtual vtkHigherOrderCurve* GetEdgeCell() = 0;
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 
121 protected:
123  ~vtkHigherOrderHexahedron() override;
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;
138  vtkNew<vtkPoints> TmpPts;
139  vtkNew<vtkIdList> TmpIds;
140 
141 private:
142  vtkHigherOrderHexahedron(const vtkHigherOrderHexahedron&) = delete;
143  void operator=(const vtkHigherOrderHexahedron&) = delete;
144 };
145 
146 inline 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
#define VTK_DEPRECATED_IN_9_1_0(reason)
represent and manipulate point attribute data
Definition: vtkPointData.h:41
int RequiresInitialization() override
Some cells require initialization prior to access.
virtual int GetCellType()=0
Return the type of cell.
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.
virtual void InterpolateFunctions(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(weight))
Compute the interpolation functions/derivatives (aka shape functions/derivatives) No-ops at this leve...
Definition: vtkCell.h:391
abstract superclass for non-linear cells
Hold a reference to a vtkObjectBase instance.
Definition: vtkMeta.h:32
int GetNumberOfEdges() override
Return the number of edges in the cell.
int vtkIdType
Definition: vtkType.h:332
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
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 void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Definition: vtkCell.h:394
dynamic, self-adjusting array of double
virtual double GetParametricDistance(const double pcoords[3])
Return the distance of the parametric coordinate provided to the cell.
int GetNumberOfFaces() override
Return the number of faces in the cell.
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
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
A 3D cell that represents an arbitrary order HigherOrder hex.
virtual void Clip(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *connectivity, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd, int insideOut)=0
Cut (or clip) the cell based on the input cellScalars and the specified value.
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.
Allocate and hold a VTK object.
Definition: vtkMeta.h:30
virtual void Contour(double value, vtkDataArray *cellScalars, vtkIncrementalPointLocator *locator, vtkCellArray *verts, vtkCellArray *lines, vtkCellArray *polys, vtkPointData *inPd, vtkPointData *outPd, vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd)=0
Generate contouring primitives.
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.
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
virtual void Initialize()
Definition: vtkCell.h:115
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this cell.
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
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.
represent and manipulate 3D points
Definition: vtkPoints.h:39