VTK  9.3.0
vtkOverlappingAMR.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
22#ifndef vtkOverlappingAMR_h
23#define vtkOverlappingAMR_h
24
25#include "vtkCommonDataModelModule.h" // For export macro
26#include "vtkUniformGridAMR.h"
27
28VTK_ABI_NAMESPACE_BEGIN
29class vtkAMRBox;
31class vtkUniformGrid;
34
35class VTKCOMMONDATAMODEL_EXPORT vtkOverlappingAMR : public vtkUniformGridAMR
36{
37public:
39
43 int GetDataObjectType() override { return VTK_OVERLAPPING_AMR; }
44
46 void PrintSelf(ostream& os, vtkIndent indent) override;
47
52
54
57 void SetOrigin(const double origin[3]);
58 double* GetOrigin();
60
62
65 void SetSpacing(unsigned int level, const double spacing[3]);
66 void GetSpacing(unsigned int level, double spacing[3]);
68
70
73 void SetAMRBox(unsigned int level, unsigned int id, const vtkAMRBox& box);
74 const vtkAMRBox& GetAMRBox(unsigned int level, unsigned int id);
76
80 void GetBounds(unsigned int level, unsigned int id, double bb[6]);
81
85 void GetOrigin(unsigned int level, unsigned int id, double origin[3]);
86
88
93 {
94 return vtkOverlappingAMR::SafeDownCast(Superclass::GetData(info));
95 }
97 {
98 return vtkOverlappingAMR::SafeDownCast(Superclass::GetData(v, i));
99 }
100
109 void SetRefinementRatio(unsigned int level, int refRatio);
110
114 int GetRefinementRatio(unsigned int level);
115
117
121 void SetAMRBlockSourceIndex(unsigned int level, unsigned int id, int sourceId);
122 int GetAMRBlockSourceIndex(unsigned int level, unsigned int id);
124
129
134
140
146 unsigned int* GetParents(unsigned int level, unsigned int index, unsigned int& numParents);
147
153 unsigned int* GetChildren(unsigned int level, unsigned int index, unsigned int& numChildren);
154
158 void PrintParentChildInfo(unsigned int level, unsigned int index);
159
160 // Unhide superclass method
161 void GetBounds(double b[6]) { Superclass::GetBounds(b); }
162
166 bool FindGrid(double q[3], unsigned int& level, unsigned int& gridId);
167
171 vtkAMRInformation* GetAMRInfo() override { return Superclass::GetAMRInfo(); }
172 void SetAMRInfo(vtkAMRInformation* info) override { return Superclass::SetAMRInfo(info); }
173
175
180 void Audit();
181
182protected:
186
187private:
188 vtkOverlappingAMR(const vtkOverlappingAMR&) = delete;
189 void operator=(const vtkOverlappingAMR&) = delete;
190};
191
192VTK_ABI_NAMESPACE_END
193#endif
Encloses a rectangular region of voxel like cells.
Definition vtkAMRBox.h:29
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:29
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:96
#define VTK_NEWINSTANCE