VTK  9.2.5
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
32class vtkUniformGrid;
35
36class VTKCOMMONDATAMODEL_EXPORT vtkUniformGridAMR : public vtkCompositeDataSet
37{
38public:
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);
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;
138
142 void DeepCopy(vtkDataObject* src) override;
143
148
150
156
157protected:
160
161 double Bounds[6];
162
166 vtkGetObjectMacro(AMRData, vtkAMRDataInternals);
167
169
171
174 vtkGetObjectMacro(AMRInfo, vtkAMRInformation);
177
179
180private:
181 vtkUniformGridAMR(const vtkUniformGridAMR&) = delete;
182 void operator=(const vtkUniformGridAMR&) = delete;
183
185};
186
187#endif
container of vtkUniformGrid for an AMR data set
Meta data that describes the structure of an AMR data set.
superclass for composite data iterators
abstract superclass for composite (multi-block or AMR) datasets
general representation of visualization data
Definition: vtkDataObject.h:66
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
subclass of vtkCompositeDataIterator with API to get current level and dataset index.
a concrete implementation of vtkCompositeDataSet
void GetMin(double min[3])
Get the (min/max) bounds of the AMR domain.
void GetLevelAndIndex(const unsigned int compositeIdx, unsigned int &level, unsigned int &idx)
Given the compositeIdx (as set by SetCompositeIdx) this method returns the corresponding level and da...
vtkDataObject * GetDataSet(vtkCompositeDataIterator *iter) override
Get the data set pointed to by iter.
virtual void SetDataSet(unsigned int level, unsigned int idx, vtkUniformGrid *grid)
At the passed in level, set grid as the idx'th block at that level.
vtkAMRDataInternals * AMRData
static vtkUniformGridAMR * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
void ShallowCopy(vtkDataObject *src) override
ShallowCopy.
unsigned int GetNumberOfDataSets(const unsigned int level)
Get the number of datasets at the given level, including null blocks.
virtual void Initialize(int numLevels, const int *blocksPerLevel)
Initialize the AMR with a specified number of levels and the blocks per level.
unsigned int GetNumberOfLevels()
Get number of levels.
void GetMax(double max[3])
Get the (min/max) bounds of the AMR domain.
void DeepCopy(vtkDataObject *src) override
DeepCopy.
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
void Initialize() override
Restore data object to initial state.
vtkCompositeDataIterator * NewIterator() override
Return a new iterator (the iterator has to be deleted by the user).
void SetDataSet(vtkCompositeDataIterator *iter, vtkDataObject *dataObj) override
Overriding superclass method.
vtkUniformGrid * GetDataSet(unsigned int level, unsigned int idx)
Get the data set using the (level, index) pair.
void GetBounds(double bounds[6])
Get the (min/max) bounds of the AMR domain.
static vtkUniformGridAMR * New()
void CopyStructure(vtkCompositeDataSet *src) override
CopyStructure.
static vtkUniformGridAMR * GetData(vtkInformationVector *v, int i=0)
Retrieve an instance of this class from an information object.
const double * GetBounds()
Get the (min/max) bounds of the AMR domain.
void RecursiveShallowCopy(vtkDataObject *src) override
ShallowCopy.
virtual void SetAMRInfo(vtkAMRInformation *)
Get/Set the meta AMR meta info.
~vtkUniformGridAMR() override
int GetCompositeIndex(const unsigned int level, const unsigned int index)
Retrieves the composite index associated with the data at the given (level,index) pair.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAMRInformation * AMRInfo
void SetGridDescription(int gridDescription)
Set/Get the data description of this uniform grid instance, e.g.
virtual unsigned int GetTotalNumberOfBlocks()
Get the total number of blocks, including nullptr blocks.
image data with blanking
#define VTK_UNIFORM_GRID_AMR
Definition: vtkType.h:106
#define VTK_NEWINSTANCE
#define max(a, b)