VTK  9.3.1
vtkHigherOrderQuadrilateral.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
3 // .NAME vtkHigherOrderQuadrilateral
4 // .SECTION Description
5 // .SECTION See Also
6 
7 #ifndef vtkHigherOrderQuadrilateral_h
8 #define vtkHigherOrderQuadrilateral_h
9 
10 #include <functional> //For std::function
11 
12 #include "vtkCellType.h" // For GetCellType.
13 #include "vtkCommonDataModelModule.h" // For export macro
14 #include "vtkNew.h" // For member variable.
15 #include "vtkNonLinearCell.h"
16 #include "vtkSmartPointer.h" // For member variable.
17 
18 VTK_ABI_NAMESPACE_BEGIN
19 class vtkCellData;
20 class vtkDoubleArray;
21 class vtkIdList;
23 class vtkPointData;
24 class vtkPoints;
25 class vtkQuad;
26 class vtkVector3d;
27 class vtkVector3i;
28 
29 class VTKCOMMONDATAMODEL_EXPORT vtkHigherOrderQuadrilateral : public vtkNonLinearCell
30 {
31 public:
33  void PrintSelf(ostream& os, vtkIndent indent) override;
34 
35  int GetCellType() override = 0;
36  int GetCellDimension() override { return 2; }
37  int RequiresInitialization() override { return 0; }
38  int GetNumberOfEdges() override { return 4; }
39  int GetNumberOfFaces() override { return 0; }
40  vtkCell* GetEdge(int edgeId) override = 0;
41  vtkCell* GetFace(int vtkNotUsed(faceId)) override { return nullptr; }
42  void SetEdgeIdsAndPoints(int edgeId,
43  const std::function<void(const vtkIdType&)>& set_number_of_ids_and_points,
44  const std::function<void(const vtkIdType&, const vtkIdType&)>& set_ids_and_points);
45 
46  void Initialize() override;
47 
48  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
49  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
50  double& dist2, double weights[]) override;
51  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
52  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
53  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
54  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
55  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
56  vtkCellArray* polys, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
57  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
58  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
59  double pcoords[3], int& subId) override;
60  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
61  void Derivatives(
62  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
63  void SetParametricCoords();
64  double* GetParametricCoords() override;
65  int GetParametricCenter(double center[3]) override;
66 
67  double GetParametricDistance(const double pcoords[3]) override;
68 
69  virtual void SetOrderFromCellData(vtkCellData* cell_data, vtkIdType numPts, vtkIdType cell_id);
70  virtual void SetUniformOrderFromNumPoints(vtkIdType numPts);
71  virtual void SetOrder(int s, int t);
72  virtual const int* GetOrder();
73  virtual int GetOrder(int i) { return this->GetOrder()[i]; }
78  static bool PointCountSupportsUniformOrder(vtkIdType pointsPerCell);
79 
80  void InterpolateFunctions(const double pcoords[3], double* weights) override = 0;
81  void InterpolateDerivs(const double pcoords[3], double* derivs) override = 0;
82 
83  bool SubCellCoordinatesFromId(vtkVector3i& ijk, int subId);
84  bool SubCellCoordinatesFromId(int& i, int& j, int& k, int subId);
85  int PointIndexFromIJK(int i, int j, int k);
86  static int PointIndexFromIJK(int i, int j, const int* order);
87  bool TransformApproxToCellParams(int subCell, double* pcoords);
88 
89  virtual vtkHigherOrderCurve* GetEdgeCell() = 0;
90 
91 protected:
93  ~vtkHigherOrderQuadrilateral() override;
94 
95  vtkQuad* GetApprox();
96  // The version of GetApproximateQuad between Lagrange and Bezier is different because Bezier is
97  // non-interpolatory
98  void PrepareApproxData(
99  vtkPointData* pd, vtkCellData* cd, vtkIdType cellId, vtkDataArray* cellScalars);
100  virtual vtkQuad* GetApproximateQuad(
101  int subId, vtkDataArray* scalarsIn = nullptr, vtkDataArray* scalarsOut = nullptr) = 0;
102 
103  int Order[3];
112 
113 private:
115  void operator=(const vtkHigherOrderQuadrilateral&) = delete;
116 };
117 
119 {
120  center[0] = center[1] = 0.5;
121  center[2] = 0.0;
122  return 0;
123 }
124 
125 VTK_ABI_NAMESPACE_END
126 #endif // vtkHigherOrderQuadrilateral_h
represent and manipulate point attribute data
Definition: vtkPointData.h:29
vtkSmartPointer< vtkPointData > ApproxPD
virtual int GetCellType()=0
Return the type of cell.
vtkCell * GetFace(int vtkNotUsed(faceId)) override
represent and manipulate cell attribute data
Definition: vtkCellData.h:30
Abstract class in support of both point location and point insertion.
int GetNumberOfFaces() override
Return the number of faces in the cell.
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
vtkSmartPointer< vtkPoints > PointParametricCoordinates
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:380
abstract superclass for non-linear cells
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:27
int vtkIdType
Definition: vtkType.h:315
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int RequiresInitialization() override
Some cells require initialization prior to access.
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
int GetParametricCenter(double center[3]) override
Return center of the cell in parametric coordinates.
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:383
dynamic, self-adjusting array of double
virtual double GetParametricDistance(const double pcoords[3])
Return the distance of the parametric coordinate provided to the cell.
abstract class to specify cell behavior
Definition: vtkCell.h:49
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:28
list of point or cell ids
Definition: vtkIdList.h:22
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:44
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 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:175
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
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.
virtual void Initialize()
Definition: vtkCell.h:104
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:28
vtkSmartPointer< vtkCellData > ApproxCD
int GetNumberOfEdges() override
Return the number of edges in the cell.