VTK  9.3.0
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;
62  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
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);
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 
90 
91 protected:
94 
96  // The version of GetApproximateQuad between Lagrange and Bezier is different because Bezier is
97  // non-interpolatory
99  vtkPointData* pd, vtkCellData* cd, vtkIdType cellId, vtkDataArray* cellScalars);
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
object to represent cell connectivity
Definition: vtkCellArray.h:185
represent and manipulate cell attribute data
Definition: vtkCellData.h:40
abstract class to specify cell behavior
Definition: vtkCell.h:59
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
dynamic, self-adjusting array of double
void PrepareApproxData(vtkPointData *pd, vtkCellData *cd, vtkIdType cellId, vtkDataArray *cellScalars)
vtkCell * GetFace(int vtkNotUsed(faceId)) override
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.
vtkSmartPointer< vtkPointData > ApproxPD
bool SubCellCoordinatesFromId(vtkVector3i &ijk, int subId)
int GetNumberOfEdges() override
Return the number of edges in the cell.
int GetNumberOfFaces() override
Return the number of faces in 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.
bool SubCellCoordinatesFromId(int &i, int &j, int &k, int subId)
int PointIndexFromIJK(int i, int j, int k)
int RequiresInitialization() override
Some cells require initialization prior to access.
vtkSmartPointer< vtkPoints > PointParametricCoordinates
virtual const int * GetOrder()
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
virtual vtkQuad * GetApproximateQuad(int subId, vtkDataArray *scalarsIn=nullptr, vtkDataArray *scalarsOut=nullptr)=0
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)
virtual vtkHigherOrderCurve * GetEdgeCell()=0
vtkSmartPointer< vtkCellData > ApproxCD
static int PointIndexFromIJK(int i, int j, const int *order)
vtkCell * GetEdge(int edgeId) override=0
Return the edge cell from the edgeId of the cell.
double * GetParametricCoords() override
Return a contiguous array of parametric coordinates of the points defining this cell.
double GetParametricDistance(const double pcoords[3]) override
Return the distance of the parametric coordinate provided to the cell.
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 Initialize() override
virtual void SetUniformOrderFromNumPoints(vtkIdType numPts)
void InterpolateDerivs(const double pcoords[3], double *derivs) override=0
void Derivatives(int subId, const double pcoords[3], const double *values, int dim, double *derivs) override
Compute derivatives given cell subId and parametric coordinates.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
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.
int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override
Generate simplices of proper dimension.
void InterpolateFunctions(const double pcoords[3], double *weights) override=0
virtual void SetOrder(int s, int t)
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
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
static bool PointCountSupportsUniformOrder(vtkIdType pointsPerCell)
Return true if the number of points supports a cell of uniform degree along each axis.
~vtkHigherOrderQuadrilateral() override
int GetCellType() override=0
Return the type of cell.
bool TransformApproxToCellParams(int subCell, double *pcoords)
virtual void SetOrderFromCellData(vtkCellData *cell_data, vtkIdType numPts, vtkIdType cell_id)
int GetParametricCenter(double center[3]) override
Return center of the cell in parametric coordinates.
list of point or cell ids
Definition: vtkIdList.h:32
Abstract class in support of both point location and point insertion.
a simple class to control print indentation
Definition: vtkIndent.h:38
abstract superclass for non-linear cells
represent and manipulate point attribute data
Definition: vtkPointData.h:39
represent and manipulate 3D points
Definition: vtkPoints.h:38
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:37
@ order
Definition: vtkX3D.h:440
@ function
Definition: vtkX3D.h:249
@ value
Definition: vtkX3D.h:220
@ center
Definition: vtkX3D.h:230
@ index
Definition: vtkX3D.h:246
int vtkIdType
Definition: vtkType.h:315