VTK  9.3.1
vtkExplicitStructuredGrid.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
45 #ifndef vtkExplicitStructuredGrid_h
46 #define vtkExplicitStructuredGrid_h
47 
48 #include "vtkAbstractCellLinks.h" // For vtkAbstractCellLinks
49 #include "vtkCellArray.h" // For vtkCellArray
50 #include "vtkCommonDataModelModule.h" // For export macro
51 #include "vtkNew.h" // for vtkNew
52 #include "vtkPointSet.h"
53 #include "vtkStructuredData.h" // For static method usage
54 
55 VTK_ABI_NAMESPACE_BEGIN
56 class vtkCellArray;
57 class vtkEmptyCell;
58 class vtkHexahedron;
59 
60 class VTKCOMMONDATAMODEL_EXPORT vtkExplicitStructuredGrid : public vtkPointSet
61 {
62 public:
64 
69  void PrintSelf(ostream& os, vtkIndent indent) override;
71 
76 
78 
81  void Initialize() override;
82  using vtkDataSet::GetCell;
83  vtkCell* GetCell(vtkIdType cellId) override;
84  void GetCell(vtkIdType cellId, vtkGenericCell* cell) override;
85  void GetCellBounds(vtkIdType cellId, double bounds[6]) override;
86  int GetCellType(vtkIdType cellId) override;
87  vtkIdType GetCellSize(vtkIdType cellId) override;
88  vtkIdType GetNumberOfCells() override;
89  void GetCellPoints(vtkIdType cellId, vtkIdList* ptIds) override;
90  void GetPointCells(vtkIdType ptId, vtkIdList* cellIds) override;
91  int GetMaxCellSize() override { return 8; } // hexahedron is the largest
92  void GetCellNeighbors(vtkIdType cellId, vtkIdList* ptIds, vtkIdList* cellIds) override;
94 
98  void CopyStructure(vtkDataSet* ds) override;
99 
101 
104  void ShallowCopy(vtkDataObject* src) override;
105  void DeepCopy(vtkDataObject* src) override;
107 
111  inline int GetDataDimension() { return 3; }
112 
114 
119  void SetDimensions(int i, int j, int k);
120  void SetDimensions(int dim[3]);
121  void GetDimensions(int dim[3]);
123 
129  void GetCellDims(int cellDims[3]);
130 
134  int GetExtentType() override { return VTK_3D_EXTENT; }
135 
137 
144  void SetExtent(int x0, int x1, int y0, int y1, int z0, int z1);
145  void SetExtent(int extent[6]);
146  vtkGetVector6Macro(Extent, int);
148 
150 
153  vtkSetSmartPointerMacro(Cells, vtkCellArray);
154  vtkGetSmartPointerMacro(Cells, vtkCellArray);
156 
161  void BuildLinks();
162 
164 
167  vtkSetSmartPointerMacro(Links, vtkAbstractCellLinks);
168  vtkGetSmartPointerMacro(Links, vtkAbstractCellLinks);
170 
177 
183  void GetCellPoints(vtkIdType cellId, vtkIdType& npts, vtkIdType*& pts);
184 
193  void GetCellPoints(
194  vtkIdType cellId, vtkIdType& npts, vtkIdType const*& pts, vtkIdList* ptIds) override;
195 
199  void GetCellNeighbors(vtkIdType cellId, vtkIdType neighbors[6], int* wholeExtent = nullptr);
200 
209  void ComputeCellStructuredCoords(
210  vtkIdType cellId, int& i, int& j, int& k, bool adjustForExtent = true);
211 
220  vtkIdType ComputeCellId(int i, int j, int k, bool adjustForExtent = true);
221 
227  void ComputeFacesConnectivityFlagsArray();
228 
230 
233  vtkSetStringMacro(FacesConnectivityFlagsArrayName);
234  vtkGetStringMacro(FacesConnectivityFlagsArrayName);
236 
238 
244  void BlankCell(vtkIdType cellId);
245  void UnBlankCell(vtkIdType cellId);
247 
251  bool HasAnyBlankCells() override;
252 
258  unsigned char IsCellVisible(vtkIdType cellId);
259 
265  unsigned char IsCellGhost(vtkIdType cellId);
266 
270  bool HasAnyGhostCells();
271 
273 
278  void Crop(const int* updateExtent) override;
279  virtual void Crop(
280  vtkExplicitStructuredGrid* input, const int* updateExtent, bool generateOriginalCellIds);
282 
284 
290 
299  unsigned long GetActualMemorySize() override;
300 
311  void CheckAndReorderFaces();
312 
314 
320  void GenerateGhostArray(int zeroExt[6], bool cellOnly) override;
322 
323 protected:
325  ~vtkExplicitStructuredGrid() override;
326 
327  void ReportReferences(vtkGarbageCollector*) override;
328 
333  void ComputeScalarRange() override;
334 
338  virtual void InternalCopy(vtkExplicitStructuredGrid* src);
339 
343  void GetCell(vtkIdType, vtkCell*);
344 
348  void InternalCheckAndReorderFaces(bool swap);
349 
354  int FindConnectedFaces(int foundFaces[3]);
355 
360  static void CheckConnectedFaces(int& nFoundFaces, int foundFaces[3]);
361 
365  static void ComputeSwapFlag(int foundFaces[3], int swap[3]);
366 
370  static void ComputeMirrorFlag(int foundFaces[3], int mirror[3]);
371 
375  void ReorderCellsPoints(const int* ptsMap, const int transformFlag[3]);
376 
377  // Used by GetCell method
380 
383  int Extent[6];
385 
386 private:
388  void operator=(const vtkExplicitStructuredGrid&) = delete;
389 };
390 
391 //----------------------------------------------------------------------------
393 {
395 }
396 
397 //----------------------------------------------------------------------------
398 inline void vtkExplicitStructuredGrid::GetCellDims(int cellDims[3])
399 {
401 }
402 
403 //----------------------------------------------------------------------------
405  vtkIdType cellId, int& i, int& j, int& k, bool adjustForExtent)
406 {
407  int ijk[3];
408  if (adjustForExtent)
409  {
411  }
412  else
413  {
414  int dims[3];
415  this->GetDimensions(dims);
417  }
418  i = ijk[0];
419  j = ijk[1];
420  k = ijk[2];
421 }
422 
423 //----------------------------------------------------------------------------
424 inline vtkIdType vtkExplicitStructuredGrid::ComputeCellId(int i, int j, int k, bool adjustForExtent)
425 {
426  int ijk[] = { i, j, k };
427  if (adjustForExtent)
428  {
430  }
431  else
432  {
433  int dims[3];
434  this->GetDimensions(dims);
435  return vtkStructuredData::ComputeCellId(dims, ijk);
436  }
437 }
438 VTK_ABI_NAMESPACE_END
439 #endif
static void GetCellDimensionsFromExtent(const int ext[6], int celldims[3], int dataDescription=VTK_EMPTY)
Returns the cell dimensions, i.e., the number of cells along the i,j,k for the grid with the given gr...
vtkIdType GetCellSize(vtkIdType) override
This method always returns 1, as all cells are point in a pure vtkPointSet.
Definition: vtkPointSet.h:158
virtual void GenerateGhostArray(int zeroExt[6])
Normally called by pipeline executives or algorithms only.
Definition: vtkDataSet.h:433
virtual void ComputeScalarRange()
Compute the range of the scalars and cache it into ScalarRange only if the cache became invalid (Scal...
Store vtkAlgorithm input/output information.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:52
vtkSmartPointer< vtkCellArray > Cells
#define VTK_3D_EXTENT
Definition: vtkDataObject.h:51
vtkNew< vtkHexahedron > Hexahedron
void GetCellPoints(vtkIdType, vtkIdList *idList) override
Topological inquiry to get points defining cell.
Definition: vtkPointSet.h:139
static void GetDimensionsFromExtent(const int ext[6], int dims[3], int dataDescription=VTK_EMPTY)
Computes the structured grid dimensions based on the given extent.
static vtkPointSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
concrete class for storing a set of points
Definition: vtkPointSet.h:58
vtkIdType GetNumberOfCells() override
This method always returns 0, as there are no cells in a vtkPointSet.
Definition: vtkPointSet.h:123
an empty cell used as a place-holder during processing
Definition: vtkEmptyCell.h:21
int vtkIdType
Definition: vtkType.h:315
vtkIdType ComputeCellId(int i, int j, int k, bool adjustForExtent=true)
Given a location in structured coordinates (i-j-k), return the cell id.
int GetExtentType() override
The extent type is a 3D extent.
virtual bool HasAnyBlankCells()
Returns 1 if there are any blanking cells 0 otherwise.
Definition: vtkDataSet.h:473
int GetCellType(vtkIdType) override
This method always returns VTK_EMPTY_CELL, as there is no cell in a vtkPointSet.
Definition: vtkPointSet.h:152
void GetCellDims(int cellDims[3])
Computes the cell dimensions according to internal point dimensions.
Detect and break reference loops.
provides thread-safe access to cells
void GetDimensions(int dim[3])
Set/Get the dimensions of this structured dataset in term of number of points along each direction...
virtual void Crop(const int *updateExtent)
This method crops the data object (if necessary) so that the extent matches the update extent...
abstract class to specify cell behavior
Definition: vtkCell.h:49
int GetDataObjectType() override
Return what type of dataset this is.
void DeepCopy(vtkDataObject *src) override
Shallow and Deep copy.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for type information and printing.
a simple class to control print indentation
Definition: vtkIndent.h:28
void ComputeCellStructuredCoords(vtkIdType cellId, int &i, int &j, int &k, bool adjustForExtent=true)
Given a cellId, get the structured coordinates (i-j-k).
static vtkPointSet * New()
Standard instantiation method.
list of point or cell ids
Definition: vtkIdList.h:22
bool HasAnyGhostCells()
Returns 1 if there are any ghost cells 0 otherwise.
void Initialize() override
Reset to an empty state and free any memory.
int GetDataDimension()
Return the dimensionality of the data.
vtkSmartPointer< vtkAbstractCellLinks > Links
#define VTK_EXPLICIT_STRUCTURED_GRID
Definition: vtkType.h:105
a cell that represents a linear 3D hexahedron
Definition: vtkHexahedron.h:33
virtual void GetCellNeighbors(vtkIdType cellId, vtkIdList *ptIds, vtkIdList *cellIds)
Topological inquiry to get all cells using list of points exclusive of cell specified (e...
static void ComputeCellStructuredCoordsForExtent(vtkIdType cellIdx, const int ext[6], int ijk[3], int dataDescription=VTK_EMPTY)
Given the global grid extent and the linear index of a cell within the grid extent, this method computes the corresponding structured coordinates of the given cell.
int GetMaxCellSize() override
Standard vtkDataSet API methods.
object to represent cell connectivity
Definition: vtkCellArray.h:175
structured grid with explicit topology and geometry
static vtkIdType ComputeCellIdForExtent(const int extent[6], const int ijk[3], int dataDescription=VTK_EMPTY)
Given a location in structured coordinates (i-j-k), and the extent of the structured dataset...
static vtkIdType ComputeCellId(const int dim[3], const int ijk[3], int dataDescription=VTK_EMPTY)
Given a location in structured coordinates (i-j-k), and the dimensions of the structured dataset...
static void ComputeCellStructuredCoords(vtkIdType cellId, const int dim[3], int ijk[3], int dataDescription=VTK_EMPTY)
Given a cellId and grid dimensions 'dim', get the structured coordinates (i-j-k). ...
void GetPointCells(vtkIdType, vtkIdList *idList) override
Topological inquiry to get cells using point.
Definition: vtkPointSet.h:140
Store zero or more vtkInformation instances.
unsigned long GetActualMemorySize() override
Return the actual size of the data in kibibytes (1024 bytes).
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
vtkCell * GetCell(vtkIdType) override
This method always return a vtkEmptyCell, as there is no cell in a vtkPointSet.
void CopyStructure(vtkDataSet *pd) override
Copy the geometric structure of an input point set object.
general representation of visualization data
Definition: vtkDataObject.h:54
void ReportReferences(vtkGarbageCollector *) override
virtual vtkCell * GetCell(vtkIdType cellId)=0
Get cell with cellId such that: 0 <= cellId < NumberOfCells.
virtual void GetCellBounds(vtkIdType cellId, double bounds[6])
Get the bounds of the cell with cellId such that: 0 <= cellId < NumberOfCells.