vtkUniformGridAMR.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkUniformGridAMR_h
#define vtkUniformGridAMR_h
 
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkCompositeDataSet.h"
#include "vtkDeprecation.h" // For VTK_DEPRECATED_IN_9_3_0
 
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;

  VTK_NEWINSTANCE vtkCompositeDataIterator* NewIterator() override;

  int GetDataObjectType() override { return VTK_UNIFORM_GRID_AMR; }

  void Initialize() override;

  virtual void Initialize(int numLevels, const int* blocksPerLevel);

  void SetGridDescription(int gridDescription);
  int GetGridDescription();

  unsigned int GetNumberOfLevels();

  virtual unsigned int GetTotalNumberOfBlocks();

  unsigned int GetNumberOfDataSets(unsigned int level);


  void GetBounds(double bounds[6]);
  const double* GetBounds();
  void GetMin(double min[3]);
  void GetMax(double max[3]);

  void SetDataSet(vtkCompositeDataIterator* iter, vtkDataObject* dataObj) override;

  virtual void SetDataSet(unsigned int level, unsigned int idx, vtkUniformGrid* grid);
 
  // Needed because, otherwise vtkCompositeData::GetDataSet(unsigned int flatIndex) is hidden.
  using Superclass::GetDataSet;

  vtkDataObject* GetDataSet(vtkCompositeDataIterator* iter) override;

  vtkUniformGrid* GetDataSet(unsigned int level, unsigned int idx);

  int GetCompositeIndex(unsigned int level, unsigned int index);

  void GetLevelAndIndex(unsigned int compositeIdx, unsigned int& level, unsigned int& idx);


  void CompositeShallowCopy(vtkCompositeDataSet* src) override;
  void ShallowCopy(vtkDataObject* src) override;

  VTK_DEPRECATED_IN_9_3_0("Please use ShallowCopy instead.")
  void RecursiveShallowCopy(vtkDataObject* src) override;

  void DeepCopy(vtkDataObject* src) override;

  void CopyStructure(vtkCompositeDataSet* src) override;


  static vtkUniformGridAMR* GetData(vtkInformation* info);
  static vtkUniformGridAMR* GetData(vtkInformationVector* v, int i = 0);
 
protected:
  vtkUniformGridAMR();
  ~vtkUniformGridAMR() override;
 
  double Bounds[6];


  vtkGetObjectMacro(AMRData, vtkAMRDataInternals);
  virtual void SetAMRData(vtkAMRDataInternals*);
 
  vtkAMRDataInternals* AMRData;


  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