vtkAMRDataObject.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 vtkAMRDataObject_h
#define vtkAMRDataObject_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // for VTK_DEPRECATED_IN_9_6_0
#include "vtkNew.h"                   // for vtkNew
#include "vtkPartitionedDataSetCollection.h"
#include "vtkSmartPointer.h" // for vtkSmartPointer

VTK_ABI_NAMESPACE_BEGIN
class vtkAMRDataInternals; // VTK_DEPRECATED_IN_9_6_0
class vtkAMRMetaData;
class vtkCartesianGrid;
class vtkCompositeDataIterator;
class vtkDataSet;
class vtkImageData;
class vtkOverlappingAMRMetaData; // VTK_DEPRECATED_IN_9_6_0
class vtkRectilinearGrid;
class vtkUniformGrid;
class VTKCOMMONDATAMODEL_EXPORT vtkAMRDataObject : public vtkPartitionedDataSetCollection
{
public:
  static vtkAMRDataObject* New();
  vtkTypeMacro(vtkAMRDataObject, vtkPartitionedDataSetCollection);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  VTK_NEWINSTANCE vtkCompositeDataIterator* NewIterator() override;

  int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_AMR_DATA_OBJECT; }

  void Initialize() override;

  virtual void Initialize(const std::vector<unsigned int>& blocksPerLevel);

  virtual void Initialize(vtkAMRMetaData* metadata);

  VTK_DEPRECATED_IN_9_6_0("Use Initialize(const std::vector<unsigned int>&) instead")
  virtual void Initialize(int numLevels, const int* blocksPerLevel);


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

  [[nodiscard]] unsigned int GetNumberOfLevels() const;

  [[nodiscard]] unsigned int GetNumberOfBlocks() const;

  VTK_DEPRECATED_IN_9_6_0("Use GetNumberOfBlocks instead")
  virtual unsigned int GetTotalNumberOfBlocks() { return this->GetNumberOfBlocks(); }

  [[nodiscard]] unsigned int GetNumberOfBlocks(unsigned int level) const;

  VTK_DEPRECATED_IN_9_6_0("Use GetNumberOfBlocks(level) instead")
  unsigned int GetNumberOfDataSets(unsigned int level) { return this->GetNumberOfBlocks(level); }


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

  using Superclass::SetDataSet;
  virtual void SetDataSet(unsigned int level, unsigned int idx, vtkDataSet* grid);

  vtkCartesianGrid* GetDataSetAsCartesianGrid(unsigned int level, unsigned int idx);

  vtkImageData* GetDataSetAsImageData(unsigned int level, unsigned int idx);

  vtkRectilinearGrid* GetDataSetAsRectilinearGrid(unsigned int level, unsigned int idx);

  using Superclass::GetDataSet;
  VTK_DEPRECATED_IN_9_6_0("Use GetDataSetAsImageData or GetDataSetAsCartesianGrid instead")
  vtkUniformGrid* GetDataSet(unsigned int level, unsigned int idx);

  [[nodiscard]] int GetAbsoluteBlockIndex(unsigned int level, unsigned int index) const;

  VTK_DEPRECATED_IN_9_6_0("This function is deprecated, use GetAbsoluteBlockIndex() instead")
  int GetCompositeIndex(unsigned int level, unsigned int index)
  {
    return this->GetAbsoluteBlockIndex(level, index);
  }

  void ComputeIndexPair(unsigned int index, unsigned int& level, unsigned int& id);

  VTK_DEPRECATED_IN_9_6_0("This function is deprecated, use ComputeIndexPair() instead")
  void GetLevelAndIndex(unsigned int compositeIdx, unsigned int& level, unsigned int& idx)
  {
    this->ComputeIndexPair(compositeIdx, level, idx);
  }


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

  void DeepCopy(vtkDataObject* src) override;

  void CopyStructure(vtkCompositeDataSet* src) override;


  static vtkAMRDataObject* GetData(vtkInformation* info);
  static vtkAMRDataObject* GetData(vtkInformationVector* v, int i = 0);


  [[nodiscard]] vtkAMRMetaData* GetAMRMetaData();
  void SetAMRMetaData(vtkAMRMetaData* metadata);


  void SetPartition(unsigned int idx, unsigned int partition, vtkDataObject* object) override;
  vtkDataSet* GetPartition(unsigned int idx, unsigned int partition) override;

protected:
  vtkAMRDataObject();
  ~vtkAMRDataObject() override;

  virtual void InstantiateMetaData();


  VTK_DEPRECATED_IN_9_6_0("This function is deprecated and should not be used, returns nullptr")
  virtual vtkAMRDataInternals* GetAMRData() { return nullptr; }
  VTK_DEPRECATED_IN_9_6_0("This function is deprecated and has no effect")
  virtual void SetAMRData(vtkAMRDataInternals*) {};


  VTK_DEPRECATED_IN_9_6_0(
    "This function is deprecated and should not be inherited, use GetAMRMetaData() instead")
  virtual vtkOverlappingAMRMetaData* GetAMRInfo() { return nullptr; };
  VTK_DEPRECATED_IN_9_6_0("This function is deprecated and should not be inherited, use "
                          "SetAMRMetaData() or Initialize(vtkAMRMetaData*) instead")
  virtual void SetAMRInfo(vtkOverlappingAMRMetaData*) {};

private:
  vtkAMRDataObject(const vtkAMRDataObject&) = delete;
  void operator=(const vtkAMRDataObject&) = delete;

  void InitializeInternal();

  double Bounds[6] = {
    VTK_DOUBLE_MAX,
    VTK_DOUBLE_MIN,
    VTK_DOUBLE_MAX,
    VTK_DOUBLE_MIN,
    VTK_DOUBLE_MAX,
    VTK_DOUBLE_MIN,
  };
  vtkSmartPointer<vtkAMRMetaData> AMRMetaData;
};

VTK_ABI_NAMESPACE_END
#endif