VTK  9.2.6
vtkUniformGridAMR.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkUniformGridAMR.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 =========================================================================*/
25 #ifndef vtkUniformGridAMR_h
26 #define vtkUniformGridAMR_h
27 
28 #include "vtkCommonDataModelModule.h" // For export macro
29 #include "vtkCompositeDataSet.h"
30 
32 class vtkUniformGrid;
33 class vtkAMRInformation;
35 
36 class VTKCOMMONDATAMODEL_EXPORT vtkUniformGridAMR : public vtkCompositeDataSet
37 {
38 public:
39  static vtkUniformGridAMR* New();
41  void PrintSelf(ostream& os, vtkIndent indent) override;
42 
47 
51  int GetDataObjectType() override { return VTK_UNIFORM_GRID_AMR; }
52 
56  void Initialize() override;
57 
61  virtual void Initialize(int numLevels, const int* blocksPerLevel);
62 
67  void SetGridDescription(int gridDescription);
68  int GetGridDescription();
69 
73  unsigned int GetNumberOfLevels();
74 
78  virtual unsigned int GetTotalNumberOfBlocks();
79 
83  unsigned int GetNumberOfDataSets(const unsigned int level);
84 
86 
89  void GetBounds(double bounds[6]);
90  const double* GetBounds();
91  void GetMin(double min[3]);
92  void GetMax(double max[3]);
94 
98  void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) override;
99 
104  virtual void SetDataSet(unsigned int level, unsigned int idx, vtkUniformGrid* grid);
105 
106  // Needed because, otherwise vtkCompositeData::GetDataSet(unsigned int flatIndex) is hidden.
107  using Superclass::GetDataSet;
108 
113 
117  vtkUniformGrid* GetDataSet(unsigned int level, unsigned int idx);
118 
123  int GetCompositeIndex(const unsigned int level, const unsigned int index);
124 
129  void GetLevelAndIndex(const unsigned int compositeIdx, unsigned int& level, unsigned int& idx);
130 
132 
135  void ShallowCopy(vtkDataObject* src) override;
136  void RecursiveShallowCopy(vtkDataObject* src) override;
138 
142  void DeepCopy(vtkDataObject* src) override;
143 
147  void CopyStructure(vtkCompositeDataSet* src) override;
148 
150 
154  static vtkUniformGridAMR* GetData(vtkInformationVector* v, int i = 0);
156 
157 protected:
159  ~vtkUniformGridAMR() override;
160 
161  double Bounds[6];
162 
166  vtkGetObjectMacro(AMRData, vtkAMRDataInternals);
167 
169 
171 
174  vtkGetObjectMacro(AMRInfo, vtkAMRInformation);
175  virtual void SetAMRInfo(vtkAMRInformation*);
177 
179 
180 private:
181  vtkUniformGridAMR(const vtkUniformGridAMR&) = delete;
182  void operator=(const vtkUniformGridAMR&) = delete;
183 
185 };
186 
187 #endif
static vtkDataObject * New()
subclass of vtkCompositeDataIterator with API to get current level and dataset index.
Store vtkAlgorithm input/output information.
superclass for composite data iterators
void Initialize() override
Restore data object to initial state,.
virtual void SetDataSet(vtkCompositeDataIterator *iter, vtkDataObject *dataObj)=0
Sets the data set at the location pointed by the iterator.
abstract superclass for composite (multi-block or AMR) datasets
Meta data that describes the structure of an AMR data set.
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkAMRInformation * AMRInfo
#define VTK_UNIFORM_GRID_AMR
Definition: vtkType.h:106
void GetBounds(double bounds[6])
Return the geometric bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
void ShallowCopy(vtkDataObject *src) override
Shallow and Deep copy.
container of vtkUniformGrid for an AMR data set
static vtkCompositeDataSet * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
#define VTK_NEWINSTANCE
image data with blanking
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter)=0
Returns the dataset located at the position pointed by the iterator.
Store zero or more vtkInformation instances.
void DeepCopy(vtkDataObject *src) override
Shallow and Deep copy.
general representation of visualization data
Definition: vtkDataObject.h:65
vtkAMRDataInternals * AMRData
virtual vtkCompositeDataIterator * NewIterator()=0
Return a new iterator (the iterator has to be deleted by user).
a concrete implementation of vtkCompositeDataSet
#define max(a, b)
virtual void CopyStructure(vtkCompositeDataSet *input)
Copies the tree structure from the input.
virtual void RecursiveShallowCopy(vtkDataObject *src)=0
For historical reasons, vtkCompositeDataSet::ShallowCopy simply pass pointers to the leaf non-composi...