VTK  9.2.6
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=========================================================================*/
28#ifndef vtkOverlappingAMR_h
29#define vtkOverlappingAMR_h
30
31#include "vtkCommonDataModelModule.h" // For export macro
32#include "vtkUniformGridAMR.h"
33
34class vtkAMRBox;
36class vtkUniformGrid;
39
40class VTKCOMMONDATAMODEL_EXPORT vtkOverlappingAMR : public vtkUniformGridAMR
41{
42public:
44
48 int GetDataObjectType() override { return VTK_OVERLAPPING_AMR; }
49
51 void PrintSelf(ostream& os, vtkIndent indent) override;
52
57
59
62 void SetOrigin(const double origin[3]);
63 double* GetOrigin();
65
67
70 void SetSpacing(unsigned int level, const double spacing[3]);
71 void GetSpacing(unsigned int level, double spacing[3]);
73
75
78 void SetAMRBox(unsigned int level, unsigned int id, const vtkAMRBox& box);
79 const vtkAMRBox& GetAMRBox(unsigned int level, unsigned int id);
81
85 void GetBounds(unsigned int level, unsigned int id, double bb[6]);
86
90 void GetOrigin(unsigned int level, unsigned int id, double origin[3]);
91
93
98 {
99 return vtkOverlappingAMR::SafeDownCast(Superclass::GetData(info));
100 }
102 {
103 return vtkOverlappingAMR::SafeDownCast(Superclass::GetData(v, i));
104 }
105
114 void SetRefinementRatio(unsigned int level, int refRatio);
115
119 int GetRefinementRatio(unsigned int level);
120
122
126 void SetAMRBlockSourceIndex(unsigned int level, unsigned int id, int sourceId);
127 int GetAMRBlockSourceIndex(unsigned int level, unsigned int id);
129
134
139
145
151 unsigned int* GetParents(unsigned int level, unsigned int index, unsigned int& numParents);
152
158 unsigned int* GetChildren(unsigned int level, unsigned int index, unsigned int& numChildren);
159
163 void PrintParentChildInfo(unsigned int level, unsigned int index);
164
165 // Unhide superclass method
166 void GetBounds(double b[6]) { Superclass::GetBounds(b); }
167
171 bool FindGrid(double q[3], unsigned int& level, unsigned int& gridId);
172
176 vtkAMRInformation* GetAMRInfo() override { return Superclass::GetAMRInfo(); }
177 void SetAMRInfo(vtkAMRInformation* info) override { return Superclass::SetAMRInfo(info); }
178
180
185 void Audit();
186
187protected:
191
192private:
193 vtkOverlappingAMR(const vtkOverlappingAMR&) = delete;
194 void operator=(const vtkOverlappingAMR&) = delete;
195};
196
197#endif
Encloses a rectangular region of voxel like cells.
Definition vtkAMRBox.h:34
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:34
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
Get/Set the meta AMR meta info.
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.
a concrete implementation of vtkCompositeDataSet
image data with blanking
#define VTK_OVERLAPPING_AMR
Definition vtkType.h:108
#define VTK_NEWINSTANCE