VTK  9.0.1
vtkDIYUtilities.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDIYUtilities.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
22 #ifndef vtkDIYUtilities_h
23 #define vtkDIYUtilities_h
24 
25 #include "vtkObject.h"
26 #include "vtkParallelDIYModule.h" // for export macros
27 #include "vtkSmartPointer.h" // needed for vtkSmartPointer
28 
29 // clang-format off
30 #include "vtk_diy2.h" // needed for DIY
31 #include VTK_DIY2(diy/mpi.hpp)
32 #include VTK_DIY2(diy/serialization.hpp)
33 #include VTK_DIY2(diy/types.hpp)
34 // clang-format on
35 
36 class vtkBoundingBox;
37 class vtkDataObject;
38 class vtkDataSet;
40 class vtkPoints;
41 
42 class VTKPARALLELDIY_EXPORT vtkDIYUtilities : public vtkObject
43 {
44 public:
45  vtkTypeMacro(vtkDIYUtilities, vtkObject);
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47 
53 
59  static diy::mpi::communicator GetCommunicator(vtkMultiProcessController* controller);
60 
62 
65  static void Save(diy::BinaryBuffer& bb, vtkDataSet*);
66  static void Load(diy::BinaryBuffer& bb, vtkDataSet*&);
68 
72  static void AllReduce(diy::mpi::communicator& comm, vtkBoundingBox& bbox);
73 
80  static diy::ContinuousBounds Convert(const vtkBoundingBox& bbox);
81 
88  static vtkBoundingBox Convert(const diy::ContinuousBounds& bds);
89 
94  static void Broadcast(
95  diy::mpi::communicator& comm, std::vector<vtkBoundingBox>& boxes, int source);
96 
103  static std::vector<vtkDataSet*> GetDataSets(vtkDataObject* dobj);
104 
106 
112  static std::vector<vtkSmartPointer<vtkPoints> > ExtractPoints(
113  const std::vector<vtkDataSet*>& datasets, bool use_cell_centers);
115 
120 
121 protected:
123  ~vtkDIYUtilities() override;
124 
125 private:
126  vtkDIYUtilities(const vtkDIYUtilities&) = delete;
127  void operator=(const vtkDIYUtilities&) = delete;
128 };
129 
130 namespace diy
131 {
132 template <>
133 struct Serialization<vtkDataSet*>
134 {
135  static void save(BinaryBuffer& bb, vtkDataSet* const& p) { vtkDIYUtilities::Save(bb, p); }
136  static void load(BinaryBuffer& bb, vtkDataSet*& p) { vtkDIYUtilities::Load(bb, p); }
137 };
138 }
139 
140 // Implementation detail for Schwarz counter idiom.
141 class VTKPARALLELDIY_EXPORT vtkDIYUtilitiesCleanup
142 {
143 public:
146 
147 private:
149  void operator=(const vtkDIYUtilitiesCleanup&) = delete;
150 };
152 
153 #endif
154 // VTK-HeaderTest-Exclude: vtkDIYUtilities.h
Fast, simple class for dealing with 3D bounds.
collection of helper functions for working with DIY
static void Broadcast(diy::mpi::communicator &comm, std::vector< vtkBoundingBox > &boxes, int source)
Broadcast a vector of bounding boxes.
static void InitializeEnvironmentForDIY()
In MPI-enabled builds, DIY filters need MPI to be initialized.
static vtkBoundingBox Convert(const diy::ContinuousBounds &bds)
Convert diy::ContinuousBounds to vtkBoundingBox.
static std::vector< vtkSmartPointer< vtkPoints > > ExtractPoints(const std::vector< vtkDataSet * > &datasets, bool use_cell_centers)
Extracts points from the input.
static std::vector< vtkDataSet * > GetDataSets(vtkDataObject *dobj)
Extract datasets from the given data object.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
static void Load(diy::BinaryBuffer &bb, vtkDataSet *&)
~vtkDIYUtilities() override
static diy::ContinuousBounds Convert(const vtkBoundingBox &bbox)
Convert vtkBoundingBox to diy::ContinuousBounds.
static void Save(diy::BinaryBuffer &bb, vtkDataSet *)
Load/Save a vtkDataSet in a diy::BinaryBuffer.
static vtkBoundingBox GetLocalBounds(vtkDataObject *dobj)
Convenience method to get local bounds for the data object.
static void AllReduce(diy::mpi::communicator &comm, vtkBoundingBox &bbox)
Reduce bounding box.
static diy::mpi::communicator GetCommunicator(vtkMultiProcessController *controller)
Converts a vtkMultiProcessController to a diy::mpi::communicator.
general representation of visualization data
Definition: vtkDataObject.h:60
abstract class to specify dataset behavior
Definition: vtkDataSet.h:57
a simple class to control print indentation
Definition: vtkIndent.h:34
Multiprocessing communication superclass.
abstract base class for most VTK objects
Definition: vtkObject.h:63
represent and manipulate 3D points
Definition: vtkPoints.h:34
static void save(BinaryBuffer &bb, vtkDataSet *const &p)
static void load(BinaryBuffer &bb, vtkDataSet *&p)
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
static vtkDIYUtilitiesCleanup vtkDIYUtilitiesCleanupInstance