VTK  9.3.0
vtkUnstructuredGrid.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
22#ifndef vtkUnstructuredGrid_h
23#define vtkUnstructuredGrid_h
24
25#include "vtkAbstractCellLinks.h" // For vtkAbstractCellLinks
26#include "vtkCellArray.h" // inline GetCellPoints()
27#include "vtkCommonDataModelModule.h" // For export macro
28#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_2_0
29#include "vtkIdTypeArray.h" // inline GetCellPoints()
31
32#include "vtkSmartPointer.h" // for smart pointer
33
34VTK_ABI_NAMESPACE_BEGIN
35class vtkCellArray;
36class vtkBezierCurve;
40class vtkBezierTetra;
41class vtkBezierWedge;
43class vtkEmptyCell;
44class vtkHexahedron;
45class vtkIdList;
46class vtkIdTypeArray;
53class vtkLine;
54class vtkPixel;
55class vtkPolyLine;
56class vtkPolyVertex;
57class vtkPolygon;
58class vtkPyramid;
61class vtkQuad;
70class vtkTetra;
71class vtkTriangle;
74class vtkVertex;
75class vtkVoxel;
76class vtkWedge;
85class vtkCubicLine;
86class vtkPolyhedron;
87class vtkIdTypeArray;
88
89class VTKCOMMONDATAMODEL_EXPORT vtkUnstructuredGrid : public vtkUnstructuredGridBase
90{
91public:
97
99
103 void PrintSelf(ostream& os, vtkIndent indent) override;
105
109 int GetDataObjectType() override { return VTK_UNSTRUCTURED_GRID; }
110
120 bool AllocateEstimate(vtkIdType numCells, vtkIdType maxCellSize)
121 {
122 return this->AllocateExact(numCells, numCells * maxCellSize);
123 }
124
134 bool AllocateExact(vtkIdType numCells, vtkIdType connectivitySize);
135
145 void Allocate(vtkIdType numCells = 1000, int vtkNotUsed(extSize) = 1000) override
146 {
147 this->AllocateExact(numCells, numCells);
148 }
149
151
154 void Reset();
155 void CopyStructure(vtkDataSet* ds) override;
158 vtkCell* GetCell(vtkIdType cellId) override;
159 void GetCell(vtkIdType cellId, vtkGenericCell* cell) override;
160 void GetCellBounds(vtkIdType cellId, double bounds[6]) override;
161 void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds) override;
162 void GetPointCells(vtkIdType ptId, vtkIdList* cellIds) override;
165
169 int GetCellType(vtkIdType cellId) override;
170
175
187 void GetCellTypes(vtkCellTypes* types) override;
188
202
215 void GetCellPoints(vtkIdType cellId, vtkIdType& npts, vtkIdType const*& pts)
216 {
217 this->Connectivity->GetCellAtId(cellId, npts, pts);
218 }
219
236 vtkIdType cellId, vtkIdType& npts, vtkIdType const*& pts, vtkIdList* ptIds) override
237 {
238 this->Connectivity->GetCellAtId(cellId, npts, pts, ptIds);
239 }
240
242
247 void GetPointCells(vtkIdType ptId, vtkIdType& ncells, vtkIdType*& cells)
248 VTK_SIZEHINT(cells, ncells);
250
258
262 void Squeeze() override;
263
267 void Initialize() override;
268
272 int GetMaxCellSize() override;
273
279
281
287
295 VTK_DEPRECATED_IN_9_3_0("Use GetLinks() instead.")
296 vtkAbstractCellLinks* GetCellLinks();
297
304 void GetFaceStream(vtkIdType cellId, vtkIdList* ptIds);
305
314 void GetFaceStream(vtkIdType cellId, vtkIdType& nfaces, vtkIdType const*& ptIds);
315
317
326 void SetCells(int type, vtkCellArray* cells);
327 void SetCells(int* types, vtkCellArray* cells);
328 void SetCells(vtkUnsignedCharArray* cellTypes, vtkCellArray* cells);
329 void SetCells(vtkUnsignedCharArray* cellTypes, vtkCellArray* cells, vtkIdTypeArray* faceLocations,
330 vtkIdTypeArray* faces);
332
336 vtkCellArray* GetCells() { return this->Connectivity; }
337
339
345 void GetCellNeighbors(vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds) override
346 {
347 this->GetCellNeighbors(cellId, ptIds->GetNumberOfIds(), ptIds->GetPointer(0), cellIds);
348 }
350 vtkIdType cellId, vtkIdType npts, const vtkIdType* ptIds, vtkIdList* cellIds);
352
354
365 vtkIdType cellId, vtkIdType npts, const vtkIdType* ptIds, vtkIdType& neighborCellId);
366 bool IsCellBoundary(vtkIdType cellId, vtkIdType npts, const vtkIdType* ptIds)
367 {
368 vtkIdType neighborCellId;
369 return this->IsCellBoundary(cellId, npts, ptIds, neighborCellId);
370 }
371 VTK_DEPRECATED_IN_9_3_0("Use the overload that doesn't take a vtkIdList instead.")
372 bool IsCellBoundary(
373 vtkIdType cellId, vtkIdType npts, const vtkIdType* ptIds, vtkIdList* vtkNotUsed(cellIds))
374 {
375 return this->IsCellBoundary(cellId, npts, ptIds);
376 }
378
380
384 vtkIdType InsertNextLinkedCell(int type, int npts, const vtkIdType pts[]) VTK_SIZEHINT(pts, npts);
387 void ResizeCellList(vtkIdType ptId, int size);
389
391
394 virtual int GetPiece();
395 virtual int GetNumberOfPieces();
397
401 virtual int GetGhostLevel();
402
411 unsigned long GetActualMemorySize() override;
412
414
417 void ShallowCopy(vtkDataObject* src) override;
418 void DeepCopy(vtkDataObject* src) override;
420
426 void GetIdsOfCellsOfType(int type, vtkIdTypeArray* array) override;
427
431 int IsHomogeneous() override;
432
439
441
447
452
454
460
469
478
491 static void DecomposeAPolyhedronCell(vtkCellArray* polyhedronCellArray, vtkIdType& nCellpts,
492 vtkIdType& nCellfaces, vtkCellArray* cellArray, vtkIdTypeArray* faces);
493
494 static void DecomposeAPolyhedronCell(const vtkIdType* polyhedronCellStream, vtkIdType& nCellpts,
495 vtkIdType& nCellfaces, vtkCellArray* cellArray, vtkIdTypeArray* faces);
496
509 static void DecomposeAPolyhedronCell(vtkIdType nCellFaces, const vtkIdType* inFaceStream,
510 vtkIdType& nCellpts, vtkCellArray* cellArray, vtkIdTypeArray* faces);
511
518 static void ConvertFaceStreamPointIds(vtkIdList* faceStream, vtkIdType* idMap);
519
525 static void ConvertFaceStreamPointIds(vtkIdType nfaces, vtkIdType* faceStream, vtkIdType* idMap);
526
527 //====================== Begin Legacy Methods ================================
528
537
539
556 vtkUnsignedCharArray* cellTypes, vtkIdTypeArray* cellLocations, vtkCellArray* cells);
557 void SetCells(vtkUnsignedCharArray* cellTypes, vtkIdTypeArray* cellLocations, vtkCellArray* cells,
558 vtkIdTypeArray* faceLocations, vtkIdTypeArray* faces);
560
561 //====================== End Legacy Methods ==================================
562
563protected:
566
568
569 // These are all the cells that vtkUnstructuredGrid can represent. Used by
570 // GetCell() (and similar) methods.
619
620 // Points derived from vtkPointSet.
621 // Attribute data (i.e., point and cell data (i.e., scalars, vectors, normals, tcoords)
622 // derived from vtkDataSet.
623
624 // The heart of the data representation. The points are managed by the
625 // superclass vtkPointSet. A cell is defined by its connectivity (i.e., the
626 // point ids that define the cell) and the cell type, represented by the
627 // Connectivity and Types arrays.
628 // Finally, when certain topological information is needed (e.g.,
629 // all the cells that use a point), the cell links array is built.
633
634 // Set of all cell types present in the grid. All entries are unique.
636
637 // The DistinctCellTypes is cached, so we keep track of the last time it was
638 // updated so we can compare it to the modified time of the Types array.
640
641 // Special support for polyhedra/cells with explicit face representations.
642 // The Faces class represents polygonal faces using a modified vtkCellArray
643 // structure. Each cell face list begins with the total number of faces in
644 // the cell, followed by a vtkCellArray data organization
645 // (n,i,j,k,n,i,j,k,...).
648
649 // Legacy support -- stores the old-style cell array locations.
651
652 vtkIdType InternalInsertNextCell(int type, vtkIdType npts, const vtkIdType ptIds[]) override;
653 vtkIdType InternalInsertNextCell(int type, vtkIdList* ptIds) override;
655 vtkIdType nfaces, const vtkIdType faces[]) override;
656 void InternalReplaceCell(vtkIdType cellId, int npts, const vtkIdType pts[]) override;
657
658private:
659 // Hide these from the user and the compiler.
661 void operator=(const vtkUnstructuredGrid&) = delete;
662
663 void Cleanup();
664};
665
666VTK_ABI_NAMESPACE_END
667#endif
A 3D cell that represents an arbitrary order Bezier hex.
A 3D cell that represents an arbitrary order Bezier tetrahedron.
A 2D cell that represents an arbitrary order Bezier triangle.
A 3D cell that represents an arbitrary order Bezier wedge.
cell represents a parabolic, 9-node isoparametric quad
cell represents a biquadratic, 24-node isoparametric hexahedron
cell represents a parabolic, 18-node isoparametric wedge
cell represents a parabolic, isoparametric triangle
object to represent cell connectivity
Efficient cell iterator for vtkDataSet topologies.
object provides direct access to cells in vtkCellArray and type information
abstract class to specify cell behavior
Definition vtkCell.h:50
a 3D cell defined by a set of convex points
cell represents a cubic , isoparametric 1D line
general representation of visualization data
abstract class to specify dataset behavior
Definition vtkDataSet.h:53
virtual vtkCell * GetCell(vtkIdType cellId)=0
Get cell with cellId such that: 0 <= cellId < NumberOfCells.
virtual void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
Topological inquiry to get all cells using list of points exclusive of cell specified (e....
an empty cell used as a place-holder during processing
Detect and break reference loops.
provides thread-safe access to cells
a 3D cell that represents a prism with hexagonal base
a cell that represents a linear 3D hexahedron
list of point or cell ids
Definition vtkIdList.h:23
vtkIdType GetNumberOfIds() const noexcept
Return the number of id's in the list.
Definition vtkIdList.h:49
vtkIdType * GetPointer(vtkIdType i)
Get a pointer to a particular data index.
Definition vtkIdList.h:115
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition vtkIndent.h:29
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
A 3D cell that represents an arbitrary order Lagrange hex.
A 3D cell that represents an arbitrary order Lagrange tetrahedron.
A 2D cell that represents an arbitrary order Lagrange triangle.
A 3D cell that represents an arbitrary order Lagrange wedge.
cell represents a 1D line
Definition vtkLine.h:23
a 3D cell that represents a convex prism with pentagonal base
a cell that represents an orthogonal quadrilateral
Definition vtkPixel.h:27
cell represents a set of 1D lines
Definition vtkPolyLine.h:30
cell represents a set of 0D vertices
a cell that represents an n-sided polygon
Definition vtkPolygon.h:32
A 3D cell defined by a set of polygonal faces.
a 3D cell that represents a linear pyramid
Definition vtkPyramid.h:36
a cell that represents a 2D quadrilateral
Definition vtkQuad.h:28
cell represents a parabolic, isoparametric edge
cell represents a parabolic, 20-node isoparametric hexahedron
cell represents a quadratic-linear, 6-node isoparametric quad
cell represents a, 12-node isoparametric wedge
a cell that represents a parabolic n-sided polygon
cell represents a parabolic, 13-node isoparametric pyramid
cell represents a parabolic, 8-node isoparametric quad
cell represents a parabolic, 10-node isoparametric tetrahedron
cell represents a parabolic, isoparametric triangle
cell represents a parabolic, 15-node isoparametric wedge
Hold a reference to a vtkObjectBase instance.
a 3D cell that represents a tetrahedron
Definition vtkTetra.h:34
cell represents a parabolic, 27-node isoparametric hexahedron
cell represents a parabolic, 19-node isoparametric pyramid
a cell that represents a triangle strip
a cell that represents a triangle
Definition vtkTriangle.h:28
dynamic, self-adjusting array of unsigned char
dataset represents arbitrary combinations of all possible cell types.
dataset represents arbitrary combinations of all possible cell types
vtkBezierCurve * BezierCurve
void RemoveReferenceToCell(vtkIdType ptId, vtkIdType cellId)
Use these methods only if the dataset has been specified as Editable.
void SetCells(vtkUnsignedCharArray *cellTypes, vtkIdTypeArray *cellLocations, vtkCellArray *cells)
Special methods specific to vtkUnstructuredGrid for defining the cells composing the dataset.
void GetCellTypes(vtkCellTypes *types) override
Get a list of types of cells in a dataset.
vtkLagrangeWedge * LagrangeWedge
vtkQuadraticLinearWedge * QuadraticLinearWedge
vtkQuadraticQuad * QuadraticQuad
vtkIdType * GetFaces(vtkIdType cellId)
Special support for polyhedron.
vtkQuadraticTriangle * QuadraticTriangle
void GetCell(vtkIdType cellId, vtkGenericCell *cell) override
Standard vtkDataSet methods; see vtkDataSet.h for documentation.
vtkQuadraticPyramid * QuadraticPyramid
void SetCells(vtkUnsignedCharArray *cellTypes, vtkIdTypeArray *cellLocations, vtkCellArray *cells, vtkIdTypeArray *faceLocations, vtkIdTypeArray *faces)
Special methods specific to vtkUnstructuredGrid for defining the cells composing the dataset.
void InternalReplaceCell(vtkIdType cellId, int npts, const vtkIdType pts[]) override
vtkBezierQuadrilateral * BezierQuadrilateral
vtkSmartPointer< vtkIdTypeArray > CellLocations
vtkQuadraticLinearQuad * QuadraticLinearQuad
vtkTriangleStrip * TriangleStrip
vtkBiQuadraticTriangle * BiQuadraticTriangle
vtkLagrangeQuadrilateral * LagrangeQuadrilateral
void GetCellPoints(vtkIdType cellId, vtkIdType &npts, vtkIdType const *&pts)
A higher-performing variant of the virtual vtkDataSet::GetCellPoints() for unstructured grids.
vtkBiQuadraticQuadraticWedge * BiQuadraticQuadraticWedge
vtkIdType InternalInsertNextCell(int type, vtkIdList *ptIds) override
virtual vtkMTimeType GetMeshMTime()
Return the mesh (geometry/topology) modification time.
vtkSmartPointer< vtkCellTypes > DistinctCellTypes
vtkQuadraticTetra * QuadraticTetra
vtkCell * GetCell(vtkIdType cellId) override
Standard vtkDataSet methods; see vtkDataSet.h for documentation.
vtkMTimeType DistinctCellTypesUpdateMTime
void GetCellPoints(vtkIdType cellId, vtkIdList *ptIds) override
Standard vtkDataSet methods; see vtkDataSet.h for documentation.
vtkSmartPointer< vtkIdTypeArray > Faces
void Squeeze() override
Squeeze all arrays in the grid to conserve memory.
vtkQuadraticPolygon * QuadraticPolygon
vtkLagrangeHexahedron * LagrangeHexahedron
vtkIdType GetCellSize(vtkIdType cellId) override
Get the size of the cell with given cellId.
static void DecomposeAPolyhedronCell(vtkIdType nCellFaces, const vtkIdType *inFaceStream, vtkIdType &nCellpts, vtkCellArray *cellArray, vtkIdTypeArray *faces)
A static method for converting an input polyhedron cell stream of format [nFace0Pts,...
vtkTriQuadraticHexahedron * TriQuadraticHexahedron
vtkIdTypeArray * GetFaces()
Get pointer to faces and facelocations.
vtkLagrangeTriangle * LagrangeTriangle
vtkHexagonalPrism * HexagonalPrism
vtkBiQuadraticQuad * BiQuadraticQuad
vtkQuadraticEdge * QuadraticEdge
int IsHomogeneous() override
Returns whether cells are all of the same type.
static void ConvertFaceStreamPointIds(vtkIdList *faceStream, vtkIdType *idMap)
Convert pid in a face stream into idMap[pid].
vtkIdType InternalInsertNextCell(int type, vtkIdType npts, const vtkIdType ptIds[]) override
static vtkUnstructuredGrid * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
void GetCellNeighbors(vtkIdType cellId, vtkIdType npts, const vtkIdType *ptIds, vtkIdList *cellIds)
A topological inquiry to retrieve all of the cells using list of points exclusive of the current cell...
void ResizeCellList(vtkIdType ptId, int size)
Use these methods only if the dataset has been specified as Editable.
vtkBiQuadraticQuadraticHexahedron * BiQuadraticQuadraticHexahedron
bool AllocateEstimate(vtkIdType numCells, vtkIdType maxCellSize)
Pre-allocate memory in internal data structures.
int InitializeFacesRepresentation(vtkIdType numPrevCells)
Special function used by vtkUnstructuredGridReader.
bool IsCellBoundary(vtkIdType cellId, vtkIdType npts, const vtkIdType *ptIds, vtkIdType &neighborCellId)
A topological inquiry to determine whether a topological entity (e.g., point, edge,...
void GetCellBounds(vtkIdType cellId, double bounds[6]) override
Standard vtkDataSet methods; see vtkDataSet.h for documentation.
vtkGetSmartPointerMacro(Links, vtkAbstractCellLinks)
Set/Get the links that you created possibly without using BuildLinks.
vtkUnsignedCharArray * GetDistinctCellTypesArray()
Get a list of types of cells in a dataset.
vtkIdType InternalInsertNextCell(int type, vtkIdType npts, const vtkIdType ptIds[], vtkIdType nfaces, const vtkIdType faces[]) override
vtkSetSmartPointerMacro(Links, vtkAbstractCellLinks)
Set/Get the links that you created possibly without using BuildLinks.
vtkIdTypeArray * GetCellLocationsArray()
Get the array of all the starting indices of cell definitions in the cell array.
static void DecomposeAPolyhedronCell(const vtkIdType *polyhedronCellStream, vtkIdType &nCellpts, vtkIdType &nCellfaces, vtkCellArray *cellArray, vtkIdTypeArray *faces)
vtkBezierWedge * BezierWedge
void ReportReferences(vtkGarbageCollector *) override
bool IsCellBoundary(vtkIdType cellId, vtkIdType npts, const vtkIdType *ptIds)
A topological inquiry to determine whether a topological entity (e.g., point, edge,...
vtkIdType InsertNextLinkedCell(int type, int npts, const vtkIdType pts[])
Use these methods only if the dataset has been specified as Editable.
vtkSmartPointer< vtkAbstractCellLinks > Links
vtkIdType GetNumberOfCells() override
Standard vtkDataSet methods; see vtkDataSet.h for documentation.
void Allocate(vtkIdType numCells=1000, int vtkNotUsed(extSize)=1000) override
Method allocates initial storage for the cell connectivity.
vtkLagrangeTetra * LagrangeTetra
vtkQuadraticHexahedron * QuadraticHexahedron
bool AllocateExact(vtkIdType numCells, vtkIdType connectivitySize)
Pre-allocate memory in internal data structures.
void Reset()
Standard vtkDataSet methods; see vtkDataSet.h for documentation.
vtkSmartPointer< vtkIdTypeArray > FaceLocations
void GetPointCells(vtkIdType ptId, vtkIdList *cellIds) override
Standard vtkDataSet methods; see vtkDataSet.h for documentation.
vtkBezierTetra * BezierTetra
vtkCellIterator * NewCellIterator() override
Standard vtkDataSet methods; see vtkDataSet.h for documentation.
void GetPointCells(vtkIdType ptId, vtkIdType &ncells, vtkIdType *&cells)
Special (efficient) operation to return the list of cells using the specified point ptId.
vtkSmartPointer< vtkUnsignedCharArray > Types
vtkLagrangeCurve * LagrangeCurve
void RemoveGhostCells()
This method will remove any cell that is marked as ghost (has the vtkDataSetAttributes::DUPLICATECELL...
void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds) override
A topological inquiry to retrieve all of the cells using list of points exclusive of the current cell...
static vtkUnstructuredGrid * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
void CopyStructure(vtkDataSet *ds) override
Standard vtkDataSet methods; see vtkDataSet.h for documentation.
void Initialize() override
Reset the grid to an empty state and free any memory.
int GetMaxCellSize() override
Get the size, in number of points, of the largest cell.
vtkConvexPointSet * ConvexPointSet
vtkSmartPointer< vtkCellArray > Connectivity
vtkBezierHexahedron * BezierHexahedron
~vtkUnstructuredGrid() override
static void DecomposeAPolyhedronCell(vtkCellArray *polyhedronCellArray, vtkIdType &nCellpts, vtkIdType &nCellfaces, vtkCellArray *cellArray, vtkIdTypeArray *faces)
A static method for converting a polyhedron vtkCellArray of format [nCellFaces, nFace0Pts,...
vtkTriQuadraticPyramid * TriQuadraticPyramid
virtual int GetGhostLevel()
Get the ghost level.
int GetCellType(vtkIdType cellId) override
Get the type of the cell with the given cellId.
vtkQuadraticWedge * QuadraticWedge
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for type information and printing.
static void ConvertFaceStreamPointIds(vtkIdType nfaces, vtkIdType *faceStream, vtkIdType *idMap)
Convert pid in a face stream into idMap[pid].
void BuildLinks()
Build topological links from points to lists of cells that use each point.
void GetIdsOfCellsOfType(int type, vtkIdTypeArray *array) override
Fill vtkIdTypeArray container with list of cell Ids.
virtual int GetPiece()
Set / Get the piece and the number of pieces.
vtkPentagonalPrism * PentagonalPrism
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
vtkBezierTriangle * BezierTriangle
virtual int GetNumberOfPieces()
Set / Get the piece and the number of pieces.
void AddReferenceToCell(vtkIdType ptId, vtkIdType cellId)
Use these methods only if the dataset has been specified as Editable.
static vtkUnstructuredGrid * ExtendedNew()
vtkIdTypeArray * GetFaceLocations()
Get pointer to faces and facelocations.
static vtkUnstructuredGrid * New()
Standard instantiation method.
vtkUnsignedCharArray * GetCellTypesArray()
Get the array of all cell types in the grid.
void GetCellPoints(vtkIdType cellId, vtkIdType &npts, vtkIdType const *&pts, vtkIdList *ptIds) override
A higher-performing variant of the virtual vtkDataSet::GetCellPoints() for unstructured grids.
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
void DeepCopy(vtkDataObject *src) override
Shallow and Deep copy.
int GetDataObjectType() override
Standard vtkDataSet API methods.
a cell that represents a 3D point
Definition vtkVertex.h:23
a cell that represents a 3D orthogonal parallelepiped
Definition vtkVoxel.h:31
a 3D cell that represents a linear wedge
Definition vtkWedge.h:36
#define VTK_DEPRECATED_IN_9_3_0(reason)
int vtkIdType
Definition vtkType.h:315
#define VTK_UNSTRUCTURED_GRID
Definition vtkType.h:69
vtkTypeUInt32 vtkMTimeType
Definition vtkType.h:270
#define VTK_SIZEHINT(...)