VTK  9.2.6
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 =========================================================================*/
25 #ifndef vtkDIYUtilities_h
26 #define vtkDIYUtilities_h
27 
28 #include "vtkDeprecation.h" // for VTK_DEPRECATED_IN_9_1_0
29 #include "vtkObject.h"
30 #include "vtkParallelDIYModule.h" // for export macros
31 #include "vtkSmartPointer.h" // needed for vtkSmartPointer
32 
33 #include <map> // For Link
34 #include <set> // For Link
35 #include <vector> // For GetDataSets
36 
37 // clang-format off
38 #include "vtk_diy2.h" // needed for DIY
39 #include VTK_DIY2(diy/master.hpp)
40 #include VTK_DIY2(diy/mpi.hpp)
41 #include VTK_DIY2(diy/serialization.hpp)
42 #include VTK_DIY2(diy/types.hpp)
43 // clang-format on
44 
45 class vtkDataArray;
46 class vtkBoundingBox;
47 class vtkDataObject;
48 class vtkDataSet;
49 class vtkFieldData;
51 class vtkPoints;
52 class vtkStringArray;
53 
54 class VTKPARALLELDIY_EXPORT vtkDIYUtilities : public vtkObject
55 {
56 public:
57  vtkTypeMacro(vtkDIYUtilities, vtkObject);
58  void PrintSelf(ostream& os, vtkIndent indent) override;
59 
64  static void InitializeEnvironmentForDIY();
65 
71  static diy::mpi::communicator GetCommunicator(vtkMultiProcessController* controller);
72 
74 
77  static void Save(diy::BinaryBuffer& bb, vtkDataSet*);
78  static void Load(diy::BinaryBuffer& bb, vtkDataSet*&);
80 
82 
85  static void Save(diy::BinaryBuffer& bb, vtkFieldData*);
86  static void Load(diy::BinaryBuffer& bb, vtkFieldData*&);
88 
90 
93  static void Save(diy::BinaryBuffer& bb, vtkStringArray*);
94  static void Load(diy::BinaryBuffer& bb, vtkStringArray*&);
96 
98 
101  static void Save(diy::BinaryBuffer& bb, vtkDataArray*);
102  static void Load(diy::BinaryBuffer& bb, vtkDataArray*&);
104 
108  static void AllReduce(diy::mpi::communicator& comm, vtkBoundingBox& bbox);
109 
116  static diy::ContinuousBounds Convert(const vtkBoundingBox& bbox);
117 
124  static vtkBoundingBox Convert(const diy::ContinuousBounds& bds);
125 
130  static void Broadcast(
131  diy::mpi::communicator& comm, std::vector<vtkBoundingBox>& boxes, int source);
132 
139  template <class DataSetT = vtkDataSet>
140  VTK_DEPRECATED_IN_9_1_0("Use vtkCompositeDataSet::GetDataSets instead")
141  static std::vector<DataSetT*> GetDataSets(vtkDataObject* dobj);
142 
144 
150  static std::vector<vtkSmartPointer<vtkPoints>> ExtractPoints(
151  const std::vector<vtkDataSet*>& datasets, bool use_cell_centers);
153 
157  static vtkBoundingBox GetLocalBounds(vtkDataObject* dobj);
158 
167  template <class DummyT>
168  static void Link(diy::Master& master, const diy::Assigner& assigner,
169  const std::vector<std::map<int, DummyT>>& linksMap);
170 
171  static void Link(
172  diy::Master& master, const diy::Assigner& assigner, const std::vector<std::set<int>>& linksMap);
173 
174 protected:
175  vtkDIYUtilities();
176  ~vtkDIYUtilities() override;
177 
178 private:
179  vtkDIYUtilities(const vtkDIYUtilities&) = delete;
180  void operator=(const vtkDIYUtilities&) = delete;
181 };
182 
183 namespace diy
184 {
185 template <>
187 {
188  static void save(BinaryBuffer& bb, vtkDataSet* const& p) { vtkDIYUtilities::Save(bb, p); }
189  static void load(BinaryBuffer& bb, vtkDataSet*& p) { vtkDIYUtilities::Load(bb, p); }
190 };
191 
192 template <>
194 {
195  static void save(BinaryBuffer& bb, vtkDataArray* const& da) { vtkDIYUtilities::Save(bb, da); }
196  static void load(BinaryBuffer& bb, vtkDataArray*& da) { vtkDIYUtilities::Load(bb, da); }
197 };
198 
199 template <>
201 {
202  static void save(BinaryBuffer& bb, vtkFieldData* const& fd) { vtkDIYUtilities::Save(bb, fd); }
203  static void load(BinaryBuffer& bb, vtkFieldData*& fd) { vtkDIYUtilities::Load(bb, fd); }
204 };
205 }
206 
207 // Implementation detail for Schwarz counter idiom.
208 class VTKPARALLELDIY_EXPORT vtkDIYUtilitiesCleanup
209 {
210 public:
213 
214 private:
216  void operator=(const vtkDIYUtilitiesCleanup&) = delete;
217 };
219 
220 #include "vtkDIYUtilities.txx" // for template implementations
221 
222 #endif
static void load(BinaryBuffer &bb, vtkFieldData *&fd)
static void save(BinaryBuffer &bb, vtkFieldData *const &fd)
#define VTK_DEPRECATED_IN_9_1_0(reason)
abstract base class for most VTK objects
Definition: vtkObject.h:62
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
abstract class to specify dataset behavior
Definition: vtkDataSet.h:62
static void load(BinaryBuffer &bb, vtkDataArray *&da)
a vtkAbstractArray subclass for strings
Hold a reference to a vtkObjectBase instance.
Definition: vtkMeta.h:32
static void load(BinaryBuffer &bb, vtkDataSet *&p)
static void save(BinaryBuffer &bb, vtkDataSet *const &p)
static void Load(diy::BinaryBuffer &bb, vtkDataSet *&)
Load/Save a vtkDataSet in a diy::BinaryBuffer.
static void save(BinaryBuffer &bb, vtkDataArray *const &da)
a simple class to control print indentation
Definition: vtkIndent.h:39
static void Save(diy::BinaryBuffer &bb, vtkDataSet *)
Load/Save a vtkDataSet in a diy::BinaryBuffer.
VTKACCELERATORSVTKMCORE_EXPORT vtkDataArray * Convert(const vtkm::cont::Field &input)
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:55
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
collection of helper functions for working with DIY
static vtkDIYUtilitiesCleanup vtkDIYUtilitiesCleanupInstance
general representation of visualization data
Definition: vtkDataObject.h:65
represent and manipulate 3D points
Definition: vtkPoints.h:39
Fast, simple class for representing and operating on 3D bounds.
represent and manipulate fields of data
Definition: vtkFieldData.h:62
Multiprocessing communication superclass.