VTK  9.0.1
vtkHigherOrderTetra.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkHigherOrderTetra.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 =========================================================================*/
31 #ifndef vtkHigherOrderTetra_h
32 #define vtkHigherOrderTetra_h
33 
34 #include <functional> //For std::function
35 
36 #include "vtkCommonDataModelModule.h" // For export macro
37 #include "vtkNew.h" // For member variable.
38 #include "vtkNonLinearCell.h"
39 #include "vtkSmartPointer.h" // For member variable.
40 
41 #include <vector> //For caching
42 
43 class vtkTetra;
46 class vtkDoubleArray;
47 
48 class VTKCOMMONDATAMODEL_EXPORT vtkHigherOrderTetra : public vtkNonLinearCell
49 {
50 public:
52  void PrintSelf(ostream& os, vtkIndent indent) override;
53 
54  int GetCellType() override = 0;
55  int GetCellDimension() override { return 3; }
56  int RequiresInitialization() override { return 1; }
57  int GetNumberOfEdges() override { return 6; }
58  int GetNumberOfFaces() override { return 4; }
59  vtkCell* GetEdge(int edgeId) override = 0;
60  vtkCell* GetFace(int faceId) override = 0;
61  void SetEdgeIdsAndPoints(int edgeId,
62  const std::function<void(const vtkIdType&)>& set_number_of_ids_and_points,
63  const std::function<void(const vtkIdType&, const vtkIdType&)>& set_ids_and_points);
64  void SetFaceIdsAndPoints(vtkHigherOrderTriangle* result, int edgeId,
65  const std::function<void(const vtkIdType&)>& set_number_of_ids_and_points,
66  const std::function<void(const vtkIdType&, const vtkIdType&)>& set_ids_and_points);
67 
68  void Initialize() override;
69 
70  int CellBoundary(int subId, const double pcoords[3], vtkIdList* pts) override;
71  int EvaluatePosition(const double x[3], double closestPoint[3], int& subId, double pcoords[3],
72  double& dist2, double weights[]) override;
73  void EvaluateLocation(int& subId, const double pcoords[3], double x[3], double* weights) override;
74  void Contour(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
75  vtkCellArray* verts, vtkCellArray* lines, vtkCellArray* polys, vtkPointData* inPd,
76  vtkPointData* outPd, vtkCellData* inCd, vtkIdType cellId, vtkCellData* outCd) override;
77  void Clip(double value, vtkDataArray* cellScalars, vtkIncrementalPointLocator* locator,
78  vtkCellArray* polys, vtkPointData* inPd, vtkPointData* outPd, vtkCellData* inCd,
79  vtkIdType cellId, vtkCellData* outCd, int insideOut) override;
80  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t, double x[3],
81  double pcoords[3], int& subId) override;
82  int Triangulate(int index, vtkIdList* ptIds, vtkPoints* pts) override;
83  void JacobianInverse(const double pcoords[3], double** inverse, double* derivs);
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 
89  int GetParametricCenter(double pcoords[3]) override;
90  double GetParametricDistance(const double pcoords[3]) override;
91 
92  void InterpolateFunctions(const double pcoords[3], double* weights) override = 0;
93  void InterpolateDerivs(const double pcoords[3], double* derivs) override = 0;
94 
95  vtkIdType GetOrder() const { return this->Order; }
96  vtkIdType ComputeOrder();
97  static vtkIdType ComputeOrder(const vtkIdType nPoints);
98 
99  void ToBarycentricIndex(vtkIdType index, vtkIdType* bindex);
100  vtkIdType ToIndex(const vtkIdType* bindex);
101 
102  static void BarycentricIndex(vtkIdType index, vtkIdType* bindex, vtkIdType order);
103  static vtkIdType Index(const vtkIdType* bindex, vtkIdType order);
104  virtual vtkHigherOrderCurve* getEdgeCell() = 0;
105  virtual vtkHigherOrderTriangle* getFaceCell() = 0;
106 
107 protected:
109  ~vtkHigherOrderTetra() override;
110 
111  vtkIdType GetNumberOfSubtetras() const { return this->NumberOfSubtetras; }
112  vtkIdType ComputeNumberOfSubtetras();
113 
114  // Description:
115  // Given the index of the subtriangle, compute the barycentric indices of
116  // the subtriangle's vertices.
117  void SubtetraBarycentricPointIndices(vtkIdType cellIndex, vtkIdType (&pointBIndices)[4][4]);
118  void TetraFromOctahedron(
119  vtkIdType cellIndex, const vtkIdType (&octBIndices)[6][4], vtkIdType (&tetraBIndices)[4][4]);
120 
122  vtkDoubleArray* Scalars; // used to avoid New/Delete in contouring/clipping
126 
127  std::vector<vtkIdType> EdgeIds;
128  std::vector<vtkIdType> BarycentricIndexMap;
129  std::vector<vtkIdType> IndexMap;
130  std::vector<vtkIdType> SubtetraIndexMap;
131 
132 private:
133  vtkHigherOrderTetra(const vtkHigherOrderTetra&) = delete;
134  void operator=(const vtkHigherOrderTetra&) = delete;
135 };
136 
137 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkCell::IntersectWithLine
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.
vtkHigherOrderTetra::EdgeIds
std::vector< vtkIdType > EdgeIds
Definition: vtkHigherOrderTetra.h:127
vtkX3D::function
@ function
Definition: vtkX3D.h:255
vtkHigherOrderTetra::BarycentricIndexMap
std::vector< vtkIdType > BarycentricIndexMap
Definition: vtkHigherOrderTetra.h:128
vtkHigherOrderTetra::GetCellDimension
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
Definition: vtkHigherOrderTetra.h:55
vtkHigherOrderTetra::RequiresInitialization
int RequiresInitialization() override
Some cells require initialization prior to access.
Definition: vtkHigherOrderTetra.h:56
vtkHigherOrderTetra::Scalars
vtkDoubleArray * Scalars
Definition: vtkHigherOrderTetra.h:122
vtkCell::Contour
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.
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:31
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkCell::Initialize
virtual void Initialize()
Definition: vtkCell.h:111
vtkHigherOrderTetra::Order
vtkIdType Order
Definition: vtkHigherOrderTetra.h:123
vtkSmartPointer< vtkPoints >
vtkHigherOrderTetra::IndexMap
std::vector< vtkIdType > IndexMap
Definition: vtkHigherOrderTetra.h:129
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
vtkCell::GetCellType
virtual int GetCellType()=0
Return the type of cell.
vtkHigherOrderCurve
Definition: vtkHigherOrderCurve.h:37
vtkCell::EvaluateLocation
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.
vtkHigherOrderTetra::GetNumberOfEdges
int GetNumberOfEdges() override
Return the number of edges in the cell.
Definition: vtkHigherOrderTetra.h:57
vtkCell::Triangulate
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
vtkHigherOrderTetra::Tetra
vtkTetra * Tetra
Definition: vtkHigherOrderTetra.h:121
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:56
vtkHigherOrderTetra::SubtetraIndexMap
std::vector< vtkIdType > SubtetraIndexMap
Definition: vtkHigherOrderTetra.h:130
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
vtkCell::GetFace
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:179
vtkHigherOrderTetra::GetNumberOfSubtetras
vtkIdType GetNumberOfSubtetras() const
Definition: vtkHigherOrderTetra.h:111
vtkSmartPointer.h
vtkIncrementalPointLocator
Abstract class in support of both point location and point insertion.
Definition: vtkIncrementalPointLocator.h:51
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:30
vtkHigherOrderTetra::PointParametricCoordinates
vtkSmartPointer< vtkPoints > PointParametricCoordinates
Definition: vtkHigherOrderTetra.h:125
vtkX3D::order
@ order
Definition: vtkX3D.h:446
vtkCell::CellBoundary
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...
vtkNonLinearCell.h
vtkCell::InterpolateDerivs
virtual void InterpolateDerivs(const double vtkNotUsed(pcoords)[3], double *vtkNotUsed(derivs))
Definition: vtkCell.h:344
vtkCell::GetParametricDistance
virtual double GetParametricDistance(const double pcoords[3])
Return the distance of the parametric coordinate provided to the cell.
vtkCell::EvaluatePosition
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...
vtkCell::GetParametricCoords
virtual double * GetParametricCoords())
Return a contiguous array of parametric coordinates of the points defining this cell.
vtkNew.h
vtkNonLinearCell
abstract superclass for non-linear cells
Definition: vtkNonLinearCell.h:36
vtkCell::Clip
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.
vtkCell::GetEdge
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
vtkNonLinearCell::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCell::InterpolateFunctions
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
vtkCell::Derivatives
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.
vtkCell::GetParametricCenter
virtual int GetParametricCenter(double pcoords[3])
Return center of the cell in parametric coordinates.
vtkDoubleArray
dynamic, self-adjusting array of double
Definition: vtkDoubleArray.h:35
vtkHigherOrderTetra::GetNumberOfFaces
int GetNumberOfFaces() override
Return the number of faces in the cell.
Definition: vtkHigherOrderTetra.h:58
vtkHigherOrderTetra::NumberOfSubtetras
vtkIdType NumberOfSubtetras
Definition: vtkHigherOrderTetra.h:124
vtkTetra
a 3D cell that represents a tetrahedron
Definition: vtkTetra.h:41
vtkHigherOrderTetra::GetOrder
vtkIdType GetOrder() const
Definition: vtkHigherOrderTetra.h:95
vtkX3D::index
@ index
Definition: vtkX3D.h:252
vtkHigherOrderTriangle
A 2D cell that represents an arbitrary order HigherOrder triangle.
Definition: vtkHigherOrderTriangle.h:47
vtkHigherOrderTetra
A 3D cell that represents an arbitrary order HigherOrder tetrahedron.
Definition: vtkHigherOrderTetra.h:48