vtkOverlappingAMR.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 vtkOverlappingAMR_h
#define vtkOverlappingAMR_h

#include "vtkAMRBox.h"                // For vtkAMRBox
#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkDeprecation.h"           // for VTK_DEPRECATED_IN_9_6_0
#include "vtkUniformGridAMR.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkAMRBox;
class vtkCompositeDataIterator;
class vtkOverlappingAMRMetaData;
class vtkInformationIdTypeKey;

class VTKCOMMONDATAMODEL_EXPORT vtkOverlappingAMR : public vtkUniformGridAMR
{
public:
  static vtkOverlappingAMR* New();

  int GetDataObjectType() VTK_FUTURE_CONST override { return VTK_OVERLAPPING_AMR; }
  vtkTypeMacro(vtkOverlappingAMR, vtkUniformGridAMR);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetOrigin(const double origin[3]);
  double* GetOrigin();


  void SetSpacing(unsigned int level, const double spacing[3]);
  void GetSpacing(unsigned int level, double spacing[3]);


  void SetAMRBox(unsigned int level, unsigned int id, const vtkAMRBox& box);
  const vtkAMRBox& GetAMRBox(unsigned int level, unsigned int id);

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

  using Superclass::GetBounds;
  const double* GetBounds() override;

  void GetBounds(unsigned int level, unsigned int id, double bb[6]);

  void GetOrigin(unsigned int level, unsigned int id, double origin[3]);

  static vtkInformationIdTypeKey* NUMBER_OF_BLANKED_POINTS();

  static vtkOverlappingAMR* GetData(vtkInformation* info)
  {
    // VTK_DEPRECATED_IN_9_6_0:
    // We cannot use Superclass directly because this method is deprecated
    // When removing deprecated code, please Remove this command and replace
    // `vtkAMRDataObject` by `Superclass` in the line below.
    return vtkOverlappingAMR::SafeDownCast(vtkAMRDataObject::GetData(info));
  }
  static vtkOverlappingAMR* GetData(vtkInformationVector* v, int i = 0)
  {
    // VTK_DEPRECATED_IN_9_6_0:
    // We cannot use Superclass directly because this method is deprecated
    // When removing deprecated code, please Remove this command and replace
    // `vtkAMRDataObject` by `Superclass` in the line below.
    return vtkOverlappingAMR::SafeDownCast(vtkAMRDataObject::GetData(v, i));
  }

  void SetRefinementRatio(unsigned int level, int refRatio);

  int GetRefinementRatio(unsigned int level);


  void SetAMRBlockSourceIndex(unsigned int level, unsigned int id, int sourceId);
  int GetAMRBlockSourceIndex(unsigned int level, unsigned int id);

  int GetRefinementRatio(vtkCompositeDataIterator* iter);

  bool HasChildrenInformation();

  void GenerateParentChildInformation();

  unsigned int* GetParents(unsigned int level, unsigned int index, unsigned int& numParents);

  unsigned int* GetChildren(unsigned int level, unsigned int index, unsigned int& numChildren);

  void PrintParentChildInfo(unsigned int level, unsigned int index);

  bool FindGrid(double q[3], unsigned int& level, unsigned int& gridId);

  VTK_DEPRECATED_IN_9_6_0("This function is deprecated, use CheckValidity")
  void Audit();

  [[nodiscard]] bool CheckValidity();

  [[nodiscard]] vtkOverlappingAMRMetaData* GetOverlappingAMRMetaData();

  VTK_DEPRECATED_IN_9_6_0(
    "This function is deprecated, use GetAMRMetaData() or GetOverlappingAMRMetaData()")
  vtkOverlappingAMRMetaData* GetAMRInfo() override { return this->GetOverlappingAMRMetaData(); }
  VTK_DEPRECATED_IN_9_6_0("This function is deprecated, use SetAMRMetaData()")
  void SetAMRInfo(vtkOverlappingAMRMetaData* info) override;

protected:
  vtkOverlappingAMR();
  ~vtkOverlappingAMR() override;

  void InstantiateMetaData() override;

private:
  vtkOverlappingAMR(const vtkOverlappingAMR&) = delete;
  void operator=(const vtkOverlappingAMR&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif