VTK
vtkPyramid.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkPyramid.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 vtkPyramid_h
32 #define vtkPyramid_h
33 
34 #include "vtkCommonDataModelModule.h" // For export macro
35 #include "vtkCell3D.h"
36 
37 class vtkLine;
38 class vtkQuad;
39 class vtkTriangle;
42 
43 class VTKCOMMONDATAMODEL_EXPORT vtkPyramid : public vtkCell3D
44 {
45 public:
46  static vtkPyramid *New();
47  vtkTypeMacro(vtkPyramid,vtkCell3D);
48  void PrintSelf(ostream& os, vtkIndent indent) override;
49 
51 
54  void GetEdgePoints(int edgeId, int* &pts) override;
55  void GetFacePoints(int faceId, int* &pts) override;
57 
59 
62  int GetCellType() override {return VTK_PYRAMID;}
63  int GetCellDimension() override {return 3;}
64  int GetNumberOfEdges() override {return 8;}
65  int GetNumberOfFaces() override {return 5;}
66  vtkCell *GetEdge(int edgeId) override;
67  vtkCell *GetFace(int faceId) override;
68  int CellBoundary(int subId, double pcoords[3], vtkIdList *pts) override;
69  void Contour(double value, vtkDataArray *cellScalars,
71  vtkCellArray *lines, vtkCellArray *polys,
72  vtkPointData *inPd, vtkPointData *outPd,
73  vtkCellData *inCd, vtkIdType cellId, vtkCellData *outCd) override;
74  int EvaluatePosition(double x[3], double* closestPoint,
75  int& subId, double pcoords[3],
76  double& dist2, double *weights) override;
77  void EvaluateLocation(int& subId, double pcoords[3], double x[3],
78  double *weights) override;
79  int IntersectWithLine(double p1[3], double p2[3], double tol, double& t,
80  double x[3], double pcoords[3], int& subId) override;
81  int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts) override;
82  void Derivatives(int subId, double pcoords[3], double *values,
83  int dim, double *derivs) override;
84  double *GetParametricCoords() override;
86 
90  int GetParametricCenter(double pcoords[3]) override;
91 
95  static void InterpolationFunctions(double pcoords[3], double weights[5]);
99  static void InterpolationDerivs(double pcoords[3], double derivs[15]);
101 
105  void InterpolateFunctions(double pcoords[3], double weights[5]) override
106  {
107  vtkPyramid::InterpolationFunctions(pcoords,weights);
108  }
109  void InterpolateDerivs(double pcoords[3], double derivs[15]) override
110  {
111  vtkPyramid::InterpolationDerivs(pcoords,derivs);
112  }
114 
115  int JacobianInverse(double pcoords[3], double **inverse, double derivs[15]);
116 
118 
122  static int *GetEdgeArray(int edgeId) VTK_SIZEHINT(2);
123  static int *GetFaceArray(int faceId) VTK_SIZEHINT(4);
125 
126 protected:
127  vtkPyramid();
128  ~vtkPyramid() override;
129 
133 
134 private:
135  vtkPyramid(const vtkPyramid&) = delete;
136  void operator=(const vtkPyramid&) = delete;
137 };
138 
139 //----------------------------------------------------------------------------
140 inline int vtkPyramid::GetParametricCenter(double pcoords[3])
141 {
142  pcoords[0] = pcoords[1] = 0.4;
143  pcoords[2] = 0.2;
144  return 0;
145 }
146 
147 #endif
148 
149 
150 
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.
vtkQuad * Quad
Definition: vtkPyramid.h:132
represent and manipulate point attribute data
Definition: vtkPointData.h:31
void InterpolateDerivs(double pcoords[3], double derivs[15]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkPyramid.h:109
int GetCellType() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:62
a 3D cell that represents a linear pyramid
Definition: vtkPyramid.h:43
represent and manipulate cell attribute data
Definition: vtkCellData.h:32
Abstract class in support of both point location and point insertion.
virtual int Triangulate(int index, vtkIdList *ptIds, vtkPoints *pts)=0
Generate simplices of proper dimension.
virtual void EvaluateLocation(int &subId, double pcoords[3], double x[3], double *weights)=0
Determine global coordinate (x[3]) from subId and parametric coordinates.
virtual int EvaluatePosition(double x[3], double *closestPoint, 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...
a cell that represents a 2D quadrilateral
Definition: vtkQuad.h:35
int vtkIdType
Definition: vtkType.h:345
vtkTriangle * Triangle
Definition: vtkPyramid.h:131
int GetCellDimension() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:63
abstract class to specify 3D cell interface
Definition: vtkCell3D.h:38
int GetNumberOfFaces() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:65
void InterpolateFunctions(double pcoords[3], double weights[5]) override
Compute the interpolation functions/derivatives (aka shape functions/derivatives) ...
Definition: vtkPyramid.h:105
cell represents a 1D line
Definition: vtkLine.h:29
abstract class to specify cell behavior
Definition: vtkCell.h:56
a simple class to control print indentation
Definition: vtkIndent.h:33
list of point or cell ids
Definition: vtkIdList.h:30
virtual void Derivatives(int subId, double pcoords[3], double *values, int dim, double *derivs)=0
Compute derivatives given cell subId and parametric coordinates.
dataset represents arbitrary combinations of all possible cell types
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:48
virtual int IntersectWithLine(double p1[3], double p2[3], double tol, double &t, double x[3], double pcoords[3], int &subId)=0
Intersect with a ray.
virtual void GetFacePoints(int faceId, int *&pts)=0
Get the list of vertices that define a face.
#define VTK_SIZEHINT(...)
vtkLine * Line
Definition: vtkPyramid.h:130
virtual vtkCell * GetFace(int faceId)=0
Return the face cell from the faceId of the cell.
int GetNumberOfEdges() override
See the vtkCell API for descriptions of these methods.
Definition: vtkPyramid.h:64
object to represent cell connectivity
Definition: vtkCellArray.h:44
virtual vtkCell * GetEdge(int edgeId)=0
Return the edge cell from the edgeId of the cell.
int GetParametricCenter(double pcoords[3]) override
Return the center of the pyramid in parametric coordinates.
Definition: vtkPyramid.h:140
a cell that represents a triangle
Definition: vtkTriangle.h:35
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void InterpolationDerivs(double pcoords[3], double derivs[15])
virtual int CellBoundary(int subId, double pcoords[3], vtkIdList *pts)=0
Given parametric coordinates of a point, return the closest cell boundary, and whether the point is i...
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
static void InterpolationFunctions(double pcoords[3], double weights[5])
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 void GetEdgePoints(int edgeId, int *&pts)=0
Get the pair of vertices that define an edge.
represent and manipulate 3D points
Definition: vtkPoints.h:33