1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkUniformGridAMR
* @brief a multi-resolution dataset based on vtkUniformGrid
*
* vtkUniformGridAMR (AMR stands for Adaptive Mesh Refinement)
* is a container for vtkUniformGrid. Each grid is added as a block of a given level.
*
* The structure of the container is described in a vtkAMRInformation object.
*
* @sa
* vtkOverlappingAMR, vtkNonOverlappingAMR, vtkAMRInformation, vtkUniformGridAMRDataIterator
*/
#ifndef vtkUniformGridAMR_h
#define vtkUniformGridAMR_h
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkCompositeDataSet.h"
VTK_ABI_NAMESPACE_BEGIN
class vtkCompositeDataIterator;
class vtkUniformGrid;
class vtkAMRInformation;
class vtkAMRDataInternals;
class VTKCOMMONDATAMODEL_EXPORT vtkUniformGridAMR : public vtkCompositeDataSet
{
public:
static vtkUniformGridAMR* New();
vtkTypeMacro(vtkUniformGridAMR, vtkCompositeDataSet);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Return a new iterator (the iterator has to be deleted by the user).
*/
VTK_NEWINSTANCE vtkCompositeDataIterator* NewIterator() override;
/**
* Return class name of data type (see vtkType.h for definitions).
*/
int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_UNIFORM_GRID_AMR; }
/**
* Restore data object to initial state.
*/
void Initialize() override;
/**
* Initialize the AMR with a specified number of levels and the blocks per level.
*/
virtual void Initialize(int numLevels, const int* blocksPerLevel);
/**
* Set/Get the data description of this uniform grid instance,
* e.g. VTK_XYZ_GRID
*/
void SetGridDescription(int gridDescription);
int GetGridDescription();
/**
* Get number of levels.
*/
unsigned int GetNumberOfLevels();
/**
* Get the total number of blocks, including nullptr blocks
*/
virtual unsigned int GetTotalNumberOfBlocks();
/**
* Get the number of datasets at the given level, including null blocks
*/
unsigned int GetNumberOfDataSets(unsigned int level);
///@{
/**
* Get the (min/max) bounds of the AMR domain.
*/
void GetBounds(double bounds[6]);
const double* GetBounds();
void GetMin(double min[3]);
void GetMax(double max[3]);
///@}
/**
* Overriding superclass method.
*/
void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) override;
/**
* At the passed in level, set grid as the idx'th block at that level. idx must be less
* than the number of data sets at that level
*/
virtual void SetDataSet(unsigned int level, unsigned int idx, vtkUniformGrid* grid);
// Needed because, otherwise vtkCompositeData::GetDataSet(unsigned int flatIndex) is hidden.
using Superclass::GetDataSet;
/**
* Get the data set pointed to by iter
*/
vtkDataObject* GetDataSet(vtkCompositeDataIterator* iter) override;
/**
* Get the data set using the (level, index) pair.
*/
vtkUniformGrid* GetDataSet(unsigned int level, unsigned int idx);
/**
* Retrieves the composite index associated with the data at the given
* (level,index) pair.
*/
int GetCompositeIndex(unsigned int level, unsigned int index);
/**
* Given the compositeIdx (as set by SetCompositeIdx) this method returns the
* corresponding level and dataset index within the level.
*/
void GetLevelAndIndex(unsigned int compositeIdx, unsigned int& level, unsigned int& idx);
///@{
/**
* ShallowCopy.
*/
void CompositeShallowCopy(vtkCompositeDataSet* src) override;
void ShallowCopy(vtkDataObject* src) override;
///@}
/**
* DeepCopy.
*/
void DeepCopy(vtkDataObject* src) override;
/**
* CopyStructure.
*/
void CopyStructure(vtkCompositeDataSet* src) override;
///@{
/**
* Retrieve an instance of this class from an information object.
*/
static vtkUniformGridAMR* GetData(vtkInformation* info);
static vtkUniformGridAMR* GetData(vtkInformationVector* v, int i = 0);
///@}
protected:
vtkUniformGridAMR();
~vtkUniformGridAMR() override;
double Bounds[6];
///@{
/**
* Get/Set the meta AMR meta data
*/
vtkGetObjectMacro(AMRData, vtkAMRDataInternals);
virtual void SetAMRData(vtkAMRDataInternals*);
///@}
vtkAMRDataInternals* AMRData;
///@{
/**
* Get/Set the meta AMR meta info
*/
vtkGetObjectMacro(AMRInfo, vtkAMRInformation);
virtual void SetAMRInfo(vtkAMRInformation*);
///@}
vtkAMRInformation* AMRInfo;
private:
vtkUniformGridAMR(const vtkUniformGridAMR&) = delete;
void operator=(const vtkUniformGridAMR&) = delete;
friend class vtkUniformGridAMRDataIterator;
};
VTK_ABI_NAMESPACE_END
#endif
|