VTK  9.1.0
vtkOverlappingAMR.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkOverlappingAMR.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=========================================================================*/
67#ifndef vtkOverlappingAMR_h
68#define vtkOverlappingAMR_h
69
70#include "vtkCommonDataModelModule.h" // For export macro
71#include "vtkUniformGridAMR.h"
72
73class vtkAMRBox;
75class vtkUniformGrid;
78
79class VTKCOMMONDATAMODEL_EXPORT vtkOverlappingAMR : public vtkUniformGridAMR
80{
81public:
83
87 int GetDataObjectType() override { return VTK_OVERLAPPING_AMR; }
88
90 void PrintSelf(ostream& os, vtkIndent indent) override;
91
96
98
101 void SetOrigin(const double origin[3]);
102 double* GetOrigin();
104
106
109 void SetSpacing(unsigned int level, const double spacing[3]);
110 void GetSpacing(unsigned int level, double spacing[3]);
112
114
117 void SetAMRBox(unsigned int level, unsigned int id, const vtkAMRBox& box);
118 const vtkAMRBox& GetAMRBox(unsigned int level, unsigned int id);
120
124 void GetBounds(unsigned int level, unsigned int id, double bb[6]);
125
129 void GetOrigin(unsigned int level, unsigned int id, double origin[3]);
130
132
137 {
138 return vtkOverlappingAMR::SafeDownCast(Superclass::GetData(info));
139 }
141 {
142 return vtkOverlappingAMR::SafeDownCast(Superclass::GetData(v, i));
143 }
144
153 void SetRefinementRatio(unsigned int level, int refRatio);
154
158 int GetRefinementRatio(unsigned int level);
159
161
165 void SetAMRBlockSourceIndex(unsigned int level, unsigned int id, int sourceId);
166 int GetAMRBlockSourceIndex(unsigned int level, unsigned int id);
168
173
178
184
190 unsigned int* GetParents(unsigned int level, unsigned int index, unsigned int& numParents);
191
197 unsigned int* GetChildren(unsigned int level, unsigned int index, unsigned int& numChildren);
198
202 void PrintParentChildInfo(unsigned int level, unsigned int index);
203
204 // Unhide superclass method
205 void GetBounds(double b[6]) { Superclass::GetBounds(b); }
206
210 bool FindGrid(double q[3], unsigned int& level, unsigned int& gridId);
211
215 vtkAMRInformation* GetAMRInfo() override { return Superclass::GetAMRInfo(); }
216 void SetAMRInfo(vtkAMRInformation* info) override { return Superclass::SetAMRInfo(info); }
217
219
224 void Audit();
225
226protected:
230
231private:
232 vtkOverlappingAMR(const vtkOverlappingAMR&) = delete;
233 void operator=(const vtkOverlappingAMR&) = delete;
234};
235
236#endif
Encloses a rectangular region of voxel like cells.
Definition: vtkAMRBox.h:73
Meta data that describes the structure of an AMR data set.
superclass for composite data iterators
void GetBounds(double bounds[6])
Return the geometric bounding box in the form (xmin,xmax, ymin,ymax, zmin,zmax).
a simple class to control print indentation
Definition: vtkIndent.h:113
Key for vtkIdType values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
hierarchical dataset of vtkUniformGrids
static vtkOverlappingAMR * New()
static vtkInformationIdTypeKey * NUMBER_OF_BLANKED_POINTS()
static vtkOverlappingAMR * GetData(vtkInformationVector *v, int i=0)
int GetRefinementRatio(unsigned int level)
Returns the refinement of a given level.
~vtkOverlappingAMR() override
Check whether the data set is internally consistent, e.g.
void SetAMRBox(unsigned int level, unsigned int id, const vtkAMRBox &box)
Set/Get the AMRBox for a given block.
static vtkOverlappingAMR * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
void SetAMRBlockSourceIndex(unsigned int level, unsigned int id, int sourceId)
Set/Get the source id of a block.
int GetRefinementRatio(vtkCompositeDataIterator *iter)
Returns the refinement ratio for the position pointed by the iterator.
vtkAMRInformation * GetAMRInfo() override
Get/Set the internal representation of amr meta meta data.
void GetBounds(double b[6])
const vtkAMRBox & GetAMRBox(unsigned int level, unsigned int id)
Set/Get the AMRBox for a given block.
bool HasChildrenInformation()
Return whether parent child information has been generated.
void GetBounds(unsigned int level, unsigned int id, double bb[6])
Returns the bounding information of a data set.
unsigned int * GetChildren(unsigned int level, unsigned int index, unsigned int &numChildren)
Return a pointer to Children of a block.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void GetSpacing(unsigned int level, double spacing[3])
Get/Set the grid spacing at a given level.
int GetAMRBlockSourceIndex(unsigned int level, unsigned int id)
Set/Get the source id of a block.
bool FindGrid(double q[3], unsigned int &level, unsigned int &gridId)
Given a point q, find the highest level grid that contains it.
void SetAMRInfo(vtkAMRInformation *info) override
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
void SetSpacing(unsigned int level, const double spacing[3])
Get/Set the grid spacing at a given level.
double * GetOrigin()
Get/Set the global origin of the amr data set.
void GetOrigin(unsigned int level, unsigned int id, double origin[3])
Returns the origin of an AMR block.
void SetRefinementRatio(unsigned int level, int refRatio)
Sets the refinement of a given level.
void Audit()
Check whether the data set is internally consistent, e.g.
vtkCompositeDataIterator * NewIterator() override
Return a new iterator (the iterator has to be deleted by the user).
void SetOrigin(const double origin[3])
Get/Set the global origin of the amr data set.
static vtkOverlappingAMR * SafeDownCast(vtkObjectBase *o)
void PrintParentChildInfo(unsigned int level, unsigned int index)
Prints the parents and children of a requested block (Debug Routine)
void GenerateParentChildInformation()
Generate the parent/child relationships - needed to be called before GetParents or GetChildren can be...
vtkOverlappingAMR()
Check whether the data set is internally consistent, e.g.
unsigned int * GetParents(unsigned int level, unsigned int index, unsigned int &numParents)
Return a pointer to Parents of a block.
image data with blanking
#define VTK_OVERLAPPING_AMR
Definition: vtkType.h:108
#define VTK_NEWINSTANCE