VTK  9.3.0
vtkDIYKdTreeUtilities.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
12 #ifndef vtkDIYKdTreeUtilities_h
13 #define vtkDIYKdTreeUtilities_h
14 
15 #include "vtkBoundingBox.h" // for vtkBoundingBox
16 #include "vtkDIYExplicitAssigner.h" // for vtkDIYExplicitAssigner
17 #include "vtkFiltersParallelDIY2Module.h" // for export macros
18 #include "vtkObject.h"
19 #include "vtkSmartPointer.h" // for vtkSmartPointer
20 
21 #include <memory> // for std::shared_ptr
22 #include <vector> // for std::vector
23 
24 VTK_ABI_NAMESPACE_BEGIN
25 class vtkDataObject;
26 class vtkDataSet;
27 class vtkIntArray;
30 class vtkPoints;
32 
33 class VTKFILTERSPARALLELDIY2_EXPORT vtkDIYKdTreeUtilities : public vtkObject
34 {
35 public:
37  void PrintSelf(ostream& os, vtkIndent indent) override;
38 
52  static std::vector<vtkBoundingBox> GenerateCuts(vtkDataObject* dobj, int number_of_partitions,
53  bool use_cell_centers, vtkMultiProcessController* controller = nullptr,
54  const double* local_bounds = nullptr);
55 
60  static std::vector<vtkBoundingBox> GenerateCuts(const std::vector<vtkDataObject*>& dobjs,
61  int number_of_partitions, bool use_cell_centers,
62  vtkMultiProcessController* controller = nullptr, const double* local_bounds = nullptr);
63 
77  static std::vector<vtkBoundingBox> GenerateCuts(
78  const std::vector<vtkSmartPointer<vtkPoints>>& points, int number_of_partitions,
79  vtkMultiProcessController* controller = nullptr, const double* local_bounds = nullptr);
80 
101  vtkMultiProcessController* controller, std::shared_ptr<diy::Assigner> block_assigner = nullptr);
102 
112  vtkMultiProcessController* controller, vtkIdType* mb_offset = nullptr);
113 
122  static std::vector<int> ComputeAssignments(int num_blocks, int num_ranks);
123 
129  static vtkDIYExplicitAssigner CreateAssigner(diy::mpi::communicator& comm, int num_blocks);
130 
139  static void ResizeCuts(std::vector<vtkBoundingBox>& cuts, int size);
140 
141 protected:
144 
145 private:
147  void operator=(const vtkDIYKdTreeUtilities&) = delete;
148 };
149 
150 VTK_ABI_NAMESPACE_END
151 #endif
assigner for use with DIY
collection of utility functions for DIY-based KdTree algorithm
static std::vector< vtkBoundingBox > GenerateCuts(const std::vector< vtkSmartPointer< vtkPoints >> &points, int number_of_partitions, vtkMultiProcessController *controller=nullptr, const double *local_bounds=nullptr)
Given a collection of points, this method will generate box cuts in the domain to approximately load ...
static vtkDIYExplicitAssigner CreateAssigner(diy::mpi::communicator &comm, int num_blocks)
Returns an assigner that assigns power-of-two blocks to an arbitrary number of ranks such that each r...
static void ResizeCuts(std::vector< vtkBoundingBox > &cuts, int size)
GenerateCuts returns a kd-tree with power of 2 nodes.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static std::vector< vtkBoundingBox > GenerateCuts(const std::vector< vtkDataObject * > &dobjs, int number_of_partitions, bool use_cell_centers, vtkMultiProcessController *controller=nullptr, const double *local_bounds=nullptr)
Another variant to GenerateCuts that simply takes in a vector of dataobjects, each can be a dataset o...
static std::vector< int > ComputeAssignments(int num_blocks, int num_ranks)
GenerateCuts returns a kd-tree with power of 2 nodes.
static std::vector< vtkBoundingBox > GenerateCuts(vtkDataObject *dobj, int number_of_partitions, bool use_cell_centers, vtkMultiProcessController *controller=nullptr, const double *local_bounds=nullptr)
Given a dataset (or a composite dataset), this method will generate box cuts in the domain to approxi...
static vtkSmartPointer< vtkPartitionedDataSet > Exchange(vtkPartitionedDataSet *parts, vtkMultiProcessController *controller, std::shared_ptr< diy::Assigner > block_assigner=nullptr)
Exchange parts in the partitioned dataset among ranks in the parallel group defined by the controller...
static bool GenerateGlobalCellIds(vtkPartitionedDataSet *parts, vtkMultiProcessController *controller, vtkIdType *mb_offset=nullptr)
Generates and adds global cell ids to datasets in parts.
~vtkDIYKdTreeUtilities() override
general representation of visualization data
Definition: vtkDataObject.h:55
abstract class to specify dataset behavior
Definition: vtkDataSet.h:53
a simple class to control print indentation
Definition: vtkIndent.h:29
dynamic, self-adjusting array of int
Definition: vtkIntArray.h:35
Multiprocessing communication superclass.
abstract base class for most VTK objects
Definition: vtkObject.h:52
composite dataset to encapsulates a dataset consisting of partitions.
represent and manipulate 3D points
Definition: vtkPoints.h:29
dataset represents arbitrary combinations of all possible cell types
@ points
Definition: vtkX3D.h:446
@ vector
Definition: vtkX3D.h:237
@ size
Definition: vtkX3D.h:253
int vtkIdType
Definition: vtkType.h:315