VTK
vtkLagrangeTetra.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkLagrangeTetra.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 =========================================================================*/
34 #ifndef vtkLagrangeTetra_h
35 #define vtkLagrangeTetra_h
36 
37 #include "vtkCommonDataModelModule.h" // For export macro
38 #include "vtkNonLinearCell.h"
39 
40 #define VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER 6
41 
42 #define MAX_POINTS ((VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER + 1) * \
43  (VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER + 2) * \
44  (VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER + 3)/6)
45 
46 #define MAX_SUBTETRAHEDRA (((VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER - 2) * \
47  (VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER - 1) * \
48  (VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER)) + \
49  4*((VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER - 1) * \
50  (VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER) * \
51  (VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER + 1)) + \
52  ((VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER) * \
53  (VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER + 1) * \
54  (VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER + 2))/6)
55 
56 class vtkTetra;
57 class vtkLagrangeCurve;
59 class vtkDoubleArray;
60 
61 class VTKCOMMONDATAMODEL_EXPORT vtkLagrangeTetra : public vtkNonLinearCell
62 {
63 public:
64  static vtkLagrangeTetra *New();
66  void PrintSelf(ostream& os, vtkIndent indent) override;
67 
68  int GetCellType() override { return VTK_LAGRANGE_TETRAHEDRON; }
69  int GetCellDimension() override { return 3; }
70  int RequiresInitialization() override { return 1; }
71  int GetNumberOfEdges() override { return 6; }
72  int GetNumberOfFaces() override { return 4; }
73  vtkCell *GetEdge(int edgeId) override;
74  vtkCell *GetFace(int faceId) override;
75 
76  void Initialize() override;
77 
79  static int MaximumNumberOfPoints()
80  {
81  return ((vtkLagrangeTetra::MaximumOrder() + 1) *
83  }
84  int CellBoundary(int subId, const double pcoords[3], vtkIdList *pts) override;
85  int EvaluatePosition(const double x[3], double closestPoint[3],
86  int& subId, double pcoords[3],
87  double& dist2, double weights[]) override;
88  void EvaluateLocation(int& subId, const double pcoords[3], double x[3],
89  double *weights) override;
90  void Contour(double value, vtkDataArray *cellScalars,
92  vtkCellArray *lines, vtkCellArray *polys,
93  vtkPointData *inPd, vtkPointData *outPd,
94  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override;
95  void Clip(double value, vtkDataArray *cellScalars,
97  vtkPointData *inPd, vtkPointData *outPd,
98  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd,
99  int insideOut) override;
100  int IntersectWithLine(const double p1[3], const double p2[3], double tol, double& t,
101  double x[3], double pcoords[3], int& subId) override;
102  int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override;
103  void JacobianInverse(const double pcoords[3], double** inverse, double* derivs);
104  void Derivatives(int subId, const double pcoords[3], const double *values,
105  int dim, double *derivs) override;
106  double* GetParametricCoords() override;
107 
108  int GetParametricCenter(double pcoords[3]) override;
109  double GetParametricDistance(const double pcoords[3]) override;
110 
111  void InterpolateFunctions(const double pcoords[3], double* weights) override;
112  void InterpolateDerivs(const double pcoords[3], double* derivs) override;
113 
114  vtkIdType GetOrder() const { return this->Order; }
115  vtkIdType ComputeOrder();
116 
117  void ToBarycentricIndex(vtkIdType index, vtkIdType* bindex);
118  vtkIdType ToIndex(const vtkIdType* bindex);
119 
120  static void BarycentricIndex(vtkIdType index, vtkIdType* bindex,
121  vtkIdType order);
122  static vtkIdType Index(const vtkIdType* bindex, vtkIdType order);
123 
124 protected:
126  ~vtkLagrangeTetra() override;
127 
128  vtkIdType GetNumberOfSubtetras() const { return this->NumberOfSubtetras; }
129  vtkIdType ComputeNumberOfSubtetras();
130 
131  // Description:
132  // Given the index of the subtriangle, compute the barycentric indices of
133  // the subtriangle's vertices.
134  void SubtetraBarycentricPointIndices(vtkIdType cellIndex,
135  vtkIdType (&pointBIndices)[4][4]);
136  void TetraFromOctahedron(vtkIdType cellIndex,
137  const vtkIdType (&octBIndices)[6][4],
138  vtkIdType (&tetraBIndices)[4][4]);
139 
143  vtkDoubleArray *Scalars; //used to avoid New/Delete in contouring/clipping
147 
149  vtkIdType BarycentricIndexMap[4*MAX_POINTS];
153  vtkIdType SubtetraIndexMap[16*MAX_SUBTETRAHEDRA];
154 
155 private:
156  vtkLagrangeTetra(const vtkLagrangeTetra&) = delete;
157  void operator=(const vtkLagrangeTetra&) = delete;
158 };
159 
160 #undef MAX_POINTS
161 #undef MAX_SUBTETRAHEDRA
162 
163 #endif
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:39
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.
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.
vtkLagrangeTetra::GetCellDimension
int GetCellDimension() override
Return the topological dimensional of the cell (0,1,2, or 3).
Definition: vtkLagrangeTetra.h:69
vtkPointData
represent and manipulate point attribute data
Definition: vtkPointData.h:37
vtkX3D::value
Definition: vtkX3D.h:220
vtkLagrangeTetra::MaximumOrder
static int MaximumOrder()
Definition: vtkLagrangeTetra.h:78
vtkLagrangeTetra::Scalars
vtkDoubleArray * Scalars
Definition: vtkLagrangeTetra.h:143
vtkIdType
int vtkIdType
Definition: vtkType.h:347
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkCell::Initialize
virtual void Initialize()
Definition: vtkCell.h:114
vtkLagrangeTetra::GetNumberOfFaces
int GetNumberOfFaces() override
Return the number of faces in the cell.
Definition: vtkLagrangeTetra.h:72
VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER
#define VTK_LAGRANGE_TETRAHEDRON_MAX_ORDER
Definition: vtkLagrangeTetra.h:40
vtkLagrangeTetra::NumberOfSubtetras
vtkIdType NumberOfSubtetras
Definition: vtkLagrangeTetra.h:145
vtkLagrangeTetra::Edge
vtkLagrangeCurve * Edge
Definition: vtkLagrangeTetra.h:140
vtkDataArray
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:54
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.
MAX_POINTS
#define MAX_POINTS
Definition: vtkLagrangeTetra.h:42
vtkLagrangeTetra::MaximumNumberOfPoints
static int MaximumNumberOfPoints()
Definition: vtkLagrangeTetra.h:79
vtkLagrangeTetra::GetNumberOfSubtetras
vtkIdType GetNumberOfSubtetras() const
Definition: vtkLagrangeTetra.h:128
vtkCell::Triangulate
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
vtkLagrangeTetra::GetNumberOfEdges
int GetNumberOfEdges() override
Return the number of edges in the cell.
Definition: vtkLagrangeTetra.h:71
vtkLagrangeTetra::GetOrder
vtkIdType GetOrder() const
Definition: vtkLagrangeTetra.h:114
vtkCell
abstract class to specify cell behavior
Definition: vtkCell.h:59
vtkCellData
represent and manipulate cell attribute data
Definition: vtkCellData.h:38
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:39
vtkCellArray
object to represent cell connectivity
Definition: vtkCellArray.h:50
vtkLagrangeTetra::Tetra
vtkTetra * Tetra
Definition: vtkLagrangeTetra.h:142
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:36
MAX_SUBTETRAHEDRA
#define MAX_SUBTETRAHEDRA
Definition: vtkLagrangeTetra.h:46
vtkLagrangeTriangle
A 2D cell that represents an arbitrary order Lagrange triangle.
Definition: vtkLagrangeTriangle.h:52
vtkLagrangeTetra::Order
vtkIdType Order
Definition: vtkLagrangeTetra.h:144
vtkX3D::order
Definition: vtkX3D.h:440
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:360
vtkCell::GetParametricDistance
virtual double GetParametricDistance(const double pcoords[3])
Return the distance of the parametric coordinate provided to the cell.
VTK_LAGRANGE_TETRAHEDRON
Definition: vtkCellType.h:111
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.
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.
vtkLagrangeTetra
A 3D cell that represents an arbitrary order Lagrange tetrahedron.
Definition: vtkLagrangeTetra.h:61
vtkCell::GetEdge
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
vtkLagrangeTetra::GetCellType
int GetCellType() override
Return the type of cell.
Definition: vtkLagrangeTetra.h:68
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:357
vtkLagrangeTetra::ParametricCoordinates
double * ParametricCoordinates
Definition: vtkLagrangeTetra.h:146
vtkLagrangeTetra::Face
vtkLagrangeTriangle * Face
Definition: vtkLagrangeTetra.h:141
vtkLagrangeCurve
Definition: vtkLagrangeCurve.h:37
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:41
vtkTetra
a 3D cell that represents a tetrahedron
Definition: vtkTetra.h:47
vtkX3D::index
Definition: vtkX3D.h:246
vtkLagrangeTetra::RequiresInitialization
int RequiresInitialization() override
Some cells require initialization prior to access.
Definition: vtkLagrangeTetra.h:70