VTK
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 =========================================================================*/
34 #ifndef vtkOverlappingAMR_h
35 #define vtkOverlappingAMR_h
36 
37 #include "vtkCommonDataModelModule.h" // For export macro
38 #include "vtkUniformGridAMR.h"
39 
40 class vtkAMRBox;
42 class vtkUniformGrid;
43 class vtkAMRInformation;
45 
46 class VTKCOMMONDATAMODEL_EXPORT vtkOverlappingAMR: public vtkUniformGridAMR
47 {
48 public:
50 
54  int GetDataObjectType() override {return VTK_OVERLAPPING_AMR;}
55 
57  void PrintSelf(ostream& os, vtkIndent indent) override;
58 
63 
65 
68  void SetOrigin(const double*);
69  double* GetOrigin();
71 
73 
76  void SetSpacing(unsigned int level, const double spacing[3]);
77  void GetSpacing(unsigned int level, double spacing[3]);
79 
81 
84  void SetAMRBox(unsigned int level, unsigned int id, const vtkAMRBox& box) ;
85  const vtkAMRBox& GetAMRBox(unsigned int level, unsigned int id) ;
87 
91  void GetBounds(unsigned int level, unsigned int id, double* bb);
92 
93 
97  void GetOrigin(unsigned int level, unsigned int id, double origin[3]);
98 
100 
105  { return vtkOverlappingAMR::SafeDownCast(Superclass::GetData(info)); }
107  { return vtkOverlappingAMR::SafeDownCast(Superclass::GetData(v, i)); }
108 
117  void SetRefinementRatio(unsigned int level, int refRatio);
118 
122  int GetRefinementRatio(unsigned int level);
123 
125 
129  void SetAMRBlockSourceIndex(unsigned int level, unsigned int id, int sourceId);
130  int GetAMRBlockSourceIndex(unsigned int level, unsigned int id);
132 
137 
142 
148 
154  unsigned int *GetParents(unsigned int level, unsigned int index, unsigned int& numParents);
155 
161  unsigned int *GetChildren(unsigned int level, unsigned int index, unsigned int& numChildren);
162 
166  void PrintParentChildInfo(unsigned int level, unsigned int index);
167 
168  //Unhide superclass method
169  void GetBounds(double b[6]) { Superclass::GetBounds(b);}
170 
174  bool FindGrid(double q[3], unsigned int& level, unsigned int& gridId);
175 
180  { return Superclass::GetAMRInfo();}
182  { return Superclass::SetAMRInfo(info);}
183 
185 
190  void Audit();
191  protected:
193  ~vtkOverlappingAMR() override;
195 
196 private:
197  vtkOverlappingAMR(const vtkOverlappingAMR&) = delete;
198  void operator=(const vtkOverlappingAMR&) = delete;
199 };
200 
201 #endif
vtkAMRBox
Encloses a rectangular region of voxel like cells.
Definition: vtkAMRBox.h:40
vtkInformationIdTypeKey
Key for vtkIdType values in vtkInformation.
Definition: vtkInformationIdTypeKey.h:35
vtkOverlappingAMR::GetParents
unsigned int * GetParents(unsigned int level, unsigned int index, unsigned int &numParents)
Return a pointer to Parents of a block.
vtkOverlappingAMR::NewIterator
vtkCompositeDataIterator * NewIterator() override
Return a new iterator (the iterator has to be deleted by the user).
vtkOverlappingAMR::NUMBER_OF_BLANKED_POINTS
static vtkInformationIdTypeKey * NUMBER_OF_BLANKED_POINTS()
vtkOverlappingAMR::GenerateParentChildInformation
void GenerateParentChildInformation()
Generate the parent/child relationships - needed to be called before GetParents or GetChildren can be...
vtkOverlappingAMR::GetRefinementRatio
int GetRefinementRatio(unsigned int level)
Returns the refinement of a given level.
vtkOverlappingAMR::FindGrid
bool FindGrid(double q[3], unsigned int &level, unsigned int &gridId)
Given a point q, find the highest level grid that contains it.
vtkAMRInformation
Meta data that describes the structure of an AMR data set.
Definition: vtkAMRInformation.h:49
vtkInformationVector
Store zero or more vtkInformation instances.
Definition: vtkInformationVector.h:42
vtkOverlappingAMR::Audit
void Audit()
Check whether the data set is internally consistent, e.g.
vtkUniformGrid
image data with blanking
Definition: vtkUniformGrid.h:41
vtkUniformGridAMR.h
vtkOverlappingAMR::SetAMRInfo
void SetAMRInfo(vtkAMRInformation *info) override
Definition: vtkOverlappingAMR.h:181
vtkOverlappingAMR::SetAMRBlockSourceIndex
void SetAMRBlockSourceIndex(unsigned int level, unsigned int id, int sourceId)
Set/Get the source id of a block.
vtkOverlappingAMR::GetOrigin
void GetOrigin(unsigned int level, unsigned int id, double origin[3])
Returns the origin of an AMR block.
vtkX3D::level
@ level
Definition: vtkX3D.h:395
vtkOverlappingAMR::SafeDownCast
static vtkOverlappingAMR * SafeDownCast(vtkObjectBase *o)
vtkOverlappingAMR::GetAMRBlockSourceIndex
int GetAMRBlockSourceIndex(unsigned int level, unsigned int id)
vtkCompositeDataIterator
superclass for composite data iterators
Definition: vtkCompositeDataIterator.h:39
vtkOverlappingAMR::GetAMRBox
const vtkAMRBox & GetAMRBox(unsigned int level, unsigned int id)
vtkOverlappingAMR::GetOrigin
double * GetOrigin()
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkOverlappingAMR::GetAMRInfo
vtkAMRInformation * GetAMRInfo() override
Get/Set the internal representation of amr meta meta data.
Definition: vtkOverlappingAMR.h:179
vtkOverlappingAMR::GetChildren
unsigned int * GetChildren(unsigned int level, unsigned int index, unsigned int &numChildren)
Return a pointer to Children of a block.
vtkOverlappingAMR::SetAMRBox
void SetAMRBox(unsigned int level, unsigned int id, const vtkAMRBox &box)
Set/Get the AMRBox for a given block.
vtkOverlappingAMR::New
static vtkOverlappingAMR * New()
vtkOverlappingAMR::GetData
static vtkOverlappingAMR * GetData(vtkInformation *info)
Retrieve an instance of this class from an information object.
Definition: vtkOverlappingAMR.h:104
vtkOverlappingAMR::GetDataObjectType
int GetDataObjectType() override
Return class name of data type (see vtkType.h for definitions).
Definition: vtkOverlappingAMR.h:54
vtkOverlappingAMR
hierarchical dataset of vtkUniformGrids
Definition: vtkOverlappingAMR.h:47
vtkX3D::spacing
@ spacing
Definition: vtkX3D.h:481
vtkOverlappingAMR::GetBounds
void GetBounds(unsigned int level, unsigned int id, double *bb)
Returns the bounding information of a data set.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:87
vtkOverlappingAMR::PrintParentChildInfo
void PrintParentChildInfo(unsigned int level, unsigned int index)
Prints the parents and children of a requested block (Debug Routine)
vtkX3D::info
@ info
Definition: vtkX3D.h:376
vtkOverlappingAMR::~vtkOverlappingAMR
~vtkOverlappingAMR() override
VTK_OVERLAPPING_AMR
#define VTK_OVERLAPPING_AMR
Definition: vtkType.h:122
vtkOverlappingAMR::SetSpacing
void SetSpacing(unsigned int level, const double spacing[3])
Get/Set the grid spacing at a given level.
vtkOverlappingAMR::GetBounds
void GetBounds(double b[6])
Definition: vtkOverlappingAMR.h:169
vtkOverlappingAMR::HasChildrenInformation
bool HasChildrenInformation()
Return whether parent child information has been generated.
vtkOverlappingAMR::GetSpacing
void GetSpacing(unsigned int level, double spacing[3])
vtkUniformGridAMR
Definition: vtkUniformGridAMR.h:34
VTK_NEWINSTANCE
#define VTK_NEWINSTANCE
Definition: vtkWrappingHints.h:39
vtkOverlappingAMR::GetRefinementRatio
int GetRefinementRatio(vtkCompositeDataIterator *iter)
Returns the refinement ratio for the position pointed by the iterator.
vtkOverlappingAMR::vtkOverlappingAMR
vtkOverlappingAMR()
vtkOverlappingAMR::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkOverlappingAMR::GetData
static vtkOverlappingAMR * GetData(vtkInformationVector *v, int i=0)
Definition: vtkOverlappingAMR.h:106
vtkX3D::index
@ index
Definition: vtkX3D.h:246
vtkOverlappingAMR::SetOrigin
void SetOrigin(const double *)
Get/Set the global origin of the amr data set.
vtkOverlappingAMR::SetRefinementRatio
void SetRefinementRatio(unsigned int level, int refRatio)
Sets the refinement of a given level.