VTK  9.3.20240328
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
61 #ifndef vtkOverlappingAMR_h
62 #define vtkOverlappingAMR_h
63 
64 #include "vtkCommonDataModelModule.h" // For export macro
65 #include "vtkUniformGridAMR.h"
66 
67 VTK_ABI_NAMESPACE_BEGIN
68 class vtkAMRBox;
70 class vtkUniformGrid;
71 class vtkAMRInformation;
73 
74 class VTKCOMMONDATAMODEL_EXPORT vtkOverlappingAMR : public vtkUniformGridAMR
75 {
76 public:
78 
82  int GetDataObjectType() override { return VTK_OVERLAPPING_AMR; }
83 
85  void PrintSelf(ostream& os, vtkIndent indent) override;
86 
91 
93 
96  void SetOrigin(const double origin[3]);
97  double* GetOrigin();
99 
101 
104  void SetSpacing(unsigned int level, const double spacing[3]);
105  void GetSpacing(unsigned int level, double spacing[3]);
107 
109 
112  void SetAMRBox(unsigned int level, unsigned int id, const vtkAMRBox& box);
113  const vtkAMRBox& GetAMRBox(unsigned int level, unsigned int id);
115 
119  void GetBounds(unsigned int level, unsigned int id, double bb[6]);
120 
124  void GetOrigin(unsigned int level, unsigned int id, double origin[3]);
125 
127 
132  {
134  }
136  {
138  }
139 
148  void SetRefinementRatio(unsigned int level, int refRatio);
149 
153  int GetRefinementRatio(unsigned int level);
154 
156 
160  void SetAMRBlockSourceIndex(unsigned int level, unsigned int id, int sourceId);
161  int GetAMRBlockSourceIndex(unsigned int level, unsigned int id);
163 
168 
173 
179 
185  unsigned int* GetParents(unsigned int level, unsigned int index, unsigned int& numParents);
186 
192  unsigned int* GetChildren(unsigned int level, unsigned int index, unsigned int& numChildren);
193 
197  void PrintParentChildInfo(unsigned int level, unsigned int index);
198 
199  // Unhide superclass method
200  void GetBounds(double b[6]) { Superclass::GetBounds(b); }
201 
205  bool FindGrid(double q[3], unsigned int& level, unsigned int& gridId);
206 
210  vtkAMRInformation* GetAMRInfo() override { return Superclass::GetAMRInfo(); }
211  void SetAMRInfo(vtkAMRInformation* info) override { return Superclass::SetAMRInfo(info); }
212 
214 
219  void Audit();
220 
221 protected:
223  ~vtkOverlappingAMR() override;
225 
226 private:
227  vtkOverlappingAMR(const vtkOverlappingAMR&) = delete;
228  void operator=(const vtkOverlappingAMR&) = delete;
229 };
230 
231 VTK_ABI_NAMESPACE_END
232 #endif
Encloses a rectangular region of voxel like cells.
Definition: vtkAMRBox.h:68
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:108
Key for vtkIdType values in vtkInformation.
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
hierarchical dataset of vtkUniformGrids
int GetRefinementRatio(unsigned int level)
Returns the refinement of a given level.
vtkCompositeDataIterator * NewIterator() override
Return a new iterator (the iterator has to be deleted by the user).
~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.
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.
void GetBounds(double b[6])
bool HasChildrenInformation()
Return whether parent child information has been generated.
static vtkOverlappingAMR * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
void GetBounds(unsigned int level, unsigned int id, double bb[6])
Returns the bounding information of a data set.
unsigned int * GetParents(unsigned int level, unsigned int index, unsigned int &numParents)
Return a pointer to Parents of a block.
double * GetOrigin()
Get/Set the global origin of the amr data set.
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.
const vtkAMRBox & GetAMRBox(unsigned int level, unsigned int id)
Set/Get the AMRBox for a given block.
unsigned int * GetChildren(unsigned int level, unsigned int index, unsigned int &numChildren)
Return a pointer to Children of a block.
static vtkOverlappingAMR * SafeDownCast(vtkObjectBase *o)
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.
static vtkOverlappingAMR * GetData(vtkInformationVector *v, int i=0)
vtkAMRInformation * GetAMRInfo() override
Get/Set the internal representation of amr meta meta data.
void GetOrigin(unsigned int level, unsigned int id, double origin[3])
Returns the origin of an AMR block.
static vtkOverlappingAMR * New()
void SetRefinementRatio(unsigned int level, int refRatio)
Sets the refinement of a given level.
static vtkInformationIdTypeKey * NUMBER_OF_BLANKED_POINTS()
void Audit()
Check whether the data set is internally consistent, e.g.
void SetOrigin(const double origin[3])
Get/Set the global origin of the amr data set.
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.
a concrete implementation of vtkCompositeDataSet
image data with blanking
vtkSmartPointer< vtkDataArray > GetData(const Ioss::GroupingEntity *entity, const std::string &fieldname, Ioss::Transform *transform=nullptr, Cache *cache=nullptr, const std::string &cachekey=std::string())
Returns a VTK array for a given field (fieldname) on the chosen block (or set) entity.
@ info
Definition: vtkX3D.h:376
@ level
Definition: vtkX3D.h:395
@ spacing
Definition: vtkX3D.h:481
@ index
Definition: vtkX3D.h:246
#define VTK_OVERLAPPING_AMR
Definition: vtkType.h:96
#define VTK_NEWINSTANCE