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 
52  static void InitializeEnvironmentForDIY();
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 
119  static vtkBoundingBox GetLocalBounds(vtkDataObject* dobj);
120 
121 protected:
122  vtkDIYUtilities();
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
vtkPoints
represent and manipulate 3D points
Definition: vtkPoints.h:33
vtkDIYUtilities::Save
static void Save(diy::BinaryBuffer &bb, vtkDataSet *)
Load/Save a vtkDataSet in a diy::BinaryBuffer.
vtkDIYUtilities::Load
static void Load(diy::BinaryBuffer &bb, vtkDataSet *&)
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
tovtkm::Convert
VTKACCELERATORSVTKM_EXPORT vtkm::cont::Field Convert(vtkDataArray *input, int association)
vtkDIYUtilitiesCleanupInstance
static vtkDIYUtilitiesCleanup vtkDIYUtilitiesCleanupInstance
Definition: vtkDIYUtilities.h:151
vtkBoundingBox
Fast, simple class for dealing with 3D bounds.
Definition: vtkBoundingBox.h:34
diy
Definition: vtkDIYUtilities.h:130
vtkMultiProcessController
Multiprocessing communication superclass.
Definition: vtkMultiProcessController.h:75
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkSmartPointer.h
vtkDIYUtilities
collection of helper functions for working with DIY
Definition: vtkDIYUtilities.h:42
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkObject.h
vtkDataSet
abstract class to specify dataset behavior
Definition: vtkDataSet.h:56
source
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
Definition: vtkBoostGraphAdapter.h:959
diy::Serialization< vtkDataSet * >::save
static void save(BinaryBuffer &bb, vtkDataSet *const &p)
Definition: vtkDIYUtilities.h:135
vtkDIYUtilitiesCleanup
Definition: vtkDIYUtilities.h:141
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:59
diy::Serialization< vtkDataSet * >::load
static void load(BinaryBuffer &bb, vtkDataSet *&p)
Definition: vtkDIYUtilities.h:136