vtkNativePartitioningStrategy.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 vtkNativePartitioningStrategy_h
#define vtkNativePartitioningStrategy_h

#include "vtkFiltersParallelDIY2Module.h" // for export macro
#include "vtkPartitioningStrategy.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkBoundingBox;
class vtkDataObjectTree;
class vtkDataObject;
class VTKFILTERSPARALLELDIY2_EXPORT vtkNativePartitioningStrategy : public vtkPartitioningStrategy
{
public:
  static vtkNativePartitioningStrategy* New();
  vtkTypeMacro(vtkNativePartitioningStrategy, vtkPartitioningStrategy);
  void PrintSelf(std::ostream& os, vtkIndent indent) override;

  std::vector<PartitionInformation> ComputePartition(vtkPartitionedDataSetCollection*) override;


  vtkSetMacro(UseExplicitCuts, bool);
  vtkGetMacro(UseExplicitCuts, bool);
  vtkBooleanMacro(UseExplicitCuts, bool);


  void SetExplicitCuts(const std::vector<vtkBoundingBox>& boxes);
  const std::vector<vtkBoundingBox>& GetExplicitCuts() const { return this->ExplicitCuts; }
  void RemoveAllExplicitCuts();
  void AddExplicitCut(const vtkBoundingBox& bbox);
  void AddExplicitCut(const double bbox[6]);
  int GetNumberOfExplicitCuts() const;
  const vtkBoundingBox& GetExplicitCut(int index) const;


  vtkSetMacro(ExpandExplicitCuts, bool);
  vtkGetMacro(ExpandExplicitCuts, bool);
  vtkBooleanMacro(ExpandExplicitCuts, bool);

  std::vector<vtkBoundingBox> ExpandCuts(
    const std::vector<vtkBoundingBox>& cuts, const vtkBoundingBox& bounds);


  const std::vector<vtkBoundingBox>& GetCuts() const { return this->Cuts; }


  vtkSetMacro(LoadBalanceAcrossAllBlocks, bool);
  vtkGetMacro(LoadBalanceAcrossAllBlocks, bool);
  vtkBooleanMacro(LoadBalanceAcrossAllBlocks, bool);


  vtkSetMacro(AssignBoundaryCellsToSmallestRegionId, bool);
  vtkGetMacro(AssignBoundaryCellsToSmallestRegionId, bool);
  vtkBooleanMacro(AssignBoundaryCellsToSmallestRegionId, bool);

  virtual std::vector<vtkBoundingBox> GenerateCuts(vtkDataObject* data);

protected:
  vtkNativePartitioningStrategy() = default;
  ~vtkNativePartitioningStrategy() override = default;

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

  bool InitializeCuts(vtkDataObjectTree* input);

  std::vector<vtkBoundingBox> ExplicitCuts;
  std::vector<vtkBoundingBox> Cuts;
  bool UseExplicitCuts = false;
  bool ExpandExplicitCuts = true;

  bool LoadBalanceAcrossAllBlocks = true;

  bool AssignBoundaryCellsToSmallestRegionId = false;
};
VTK_ABI_NAMESPACE_END

#endif // vtkNativePartitioningStrategy_h