VTK  9.0.1
vtkHigherOrderQuadrilateral.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkHigherOrderQuadrilateral.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 =========================================================================*/
15 // .NAME vtkHigherOrderQuadrilateral
16 // .SECTION Description
17 // .SECTION See Also
18 
19 #ifndef vtkHigherOrderQuadrilateral_h
20 #define vtkHigherOrderQuadrilateral_h
21 
22 #include <functional> //For std::function
23 
24 #include "vtkCellType.h" // For GetCellType.
25 #include "vtkCommonDataModelModule.h" // For export macro
26 #include "vtkNew.h" // For member variable.
27 #include "vtkNonLinearCell.h"
28 #include "vtkSmartPointer.h" // For member variable.
29 
30 class vtkCellData;
31 class vtkDoubleArray;
32 class vtkIdList;
34 class vtkPointData;
35 class vtkPoints;
36 class vtkQuad;
37 class vtkVector3d;
38 class vtkVector3i;
39 
40 class VTKCOMMONDATAMODEL_EXPORT vtkHigherOrderQuadrilateral : public vtkNonLinearCell
41 {
42 public:
44  void PrintSelf(ostream& os, vtkIndent indent) override;
45 
46  int GetCellType() override = 0;
47  int GetCellDimension() override { return 2; }
48  int RequiresInitialization() override { return 0; }
49  int GetNumberOfEdges() override { return 4; }
50  int GetNumberOfFaces() override { return 0; }
51  vtkCell* GetEdge(int edgeId) override = 0;
52  vtkCell* GetFace(int vtkNotUsed(faceId)) override { return nullptr; }
53  void SetEdgeIdsAndPoints(int edgeId,
54  const std::function<void(const vtkIdType&)>& set_number_of_ids_and_points,
55  const std::function<void(const vtkIdType&, const vtkIdType&)>& set_ids_and_points);
56 
57  void Initialize() override;
58 
59  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
60  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
61  double& dist2, double weights[]) override;
62  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
63  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
64  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
65  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
66  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
67  vtkCellArray* polys, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
68  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
69  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
70  double pcoords[3], int& subId) override;
71  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
72  void Derivatives(
73  int subId, const double pcoords[3], const double* values, int dim, double* derivs) override;
74  void SetParametricCoords();
75  double* GetParametricCoords() override;
76  int GetParametricCenter(double center[3]) override;
77 
78  double GetParametricDistance(const double pcoords[3]) override;
79 
80  virtual void SetOrderFromCellData(
81  vtkCellData* cell_data, const vtkIdType numPts, const vtkIdType cell_id);
82  virtual void SetUniformOrderFromNumPoints(const vtkIdType numPts);
83  virtual void SetOrder(const int s, const int t);
84  virtual const int* GetOrder();
85  virtual int GetOrder(int i) { return this->GetOrder()[i]; }
86 
87  void InterpolateFunctions(const double pcoords[3], double* weights) override = 0;
88  void InterpolateDerivs(const double pcoords[3], double* derivs) override = 0;
89 
90  bool SubCellCoordinatesFromId(vtkVector3i& ijk, int subId);
91  bool SubCellCoordinatesFromId(int& i, int& j, int& k, int subId);
92  int PointIndexFromIJK(int i, int j, int k);
93  static int PointIndexFromIJK(int i, int j, const int* order);
94  bool TransformApproxToCellParams(int subCell, double* pcoords);
95 
96  virtual vtkHigherOrderCurve* getEdgeCell() = 0;
97 
98 protected:
100  ~vtkHigherOrderQuadrilateral() override;
101 
102  vtkQuad* GetApprox();
103  // The verion of GetApproximateQuad between Lagrange and Bezier is different because Bezier is
104  // non-interpolatory
105  void PrepareApproxData(
106  vtkPointData* pd, vtkCellData* cd, vtkIdType cellId, vtkDataArray* cellScalars);
107  virtual vtkQuad* GetApproximateQuad(
108  int subId, vtkDataArray* scalarsIn = nullptr, vtkDataArray* scalarsOut = nullptr) = 0;
109 
110  int Order[3];
119 
120 private:
122  void operator=(const vtkHigherOrderQuadrilateral&) = delete;
123 };
124 
126 {
127  center[0] = center[1] = 0.5;
128  center[2] = 0.0;
129  return 0;
130 }
131 
132 #endif // vtkHigherOrderQuadrilateral_h
represent and manipulate point attribute data
Definition: vtkPointData.h:31
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:32
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:341
abstract superclass for non-linear cells
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:35
int vtkIdType
Definition: vtkType.h:338
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:344
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:56
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:33
list of point or cell ids
Definition: vtkIdList.h:30
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
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:179
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:111
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:33
vtkSmartPointer< vtkCellData > ApproxCD
int GetNumberOfEdges() override
Return the number of edges in the cell.