vtkPartitioningStrategy.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 vtkPartitioningStrategy_h
#define vtkPartitioningStrategy_h
 
#include "vtkFiltersParallelDIY2Module.h" // for export macro
#include "vtkObject.h"
#include "vtkSmartPointer.h" // for member variables
 
VTK_ABI_NAMESPACE_BEGIN
class vtkIdTypeArray;
class vtkMultiProcessController;
class vtkPartitionedDataSetCollection;
class VTKFILTERSPARALLELDIY2_EXPORT vtkPartitioningStrategy : public vtkObject
{
public:
  vtkTypeMacro(vtkPartitioningStrategy, vtkObject);
  void PrintSelf(std::ostream& os, vtkIndent indent) override;

  enum PartitionedEntity
  {
    POINTS = 0,
    CELLS = 1
  };

  struct PartitionInformation
  {
  public:
    PartitionedEntity TargetEntity = CELLS;
    vtkNew<vtkIdTypeArray> TargetPartitions;
    vtkNew<vtkIdTypeArray> BoundaryNeighborPartitions;
    vtkIdType NumberOfPartitions = 0;
  };

  virtual std::vector<PartitionInformation> ComputePartition(vtkPartitionedDataSetCollection*) = 0;


  void SetController(vtkMultiProcessController*);
  vtkGetObjectMacro(Controller, vtkMultiProcessController);


  vtkGetMacro(NumberOfPartitions, vtkIdType);
  vtkSetMacro(NumberOfPartitions, vtkIdType);
 
protected:
  vtkPartitioningStrategy();
  ~vtkPartitioningStrategy() override;
 
  vtkMultiProcessController* Controller = nullptr;
 
  vtkIdType NumberOfPartitions = -1;
 
private:
  vtkPartitioningStrategy(const vtkPartitioningStrategy&) = delete;
  void operator=(const vtkPartitioningStrategy&) = delete;
};
VTK_ABI_NAMESPACE_END
 
#endif // vtkPartitioningStrategy_h