You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
155 lines
4.7 KiB
C++
155 lines
4.7 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkDIYUtilities.h
|
|
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
|
All rights reserved.
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notice for more information.
|
|
|
|
=========================================================================*/
|
|
/**
|
|
* @class vtkDIYUtilities
|
|
* @brief collection of helper functions for working with DIY
|
|
*
|
|
* vtkDIYUtilities provides a set of utility functions when using DIY in a VTK
|
|
* filters.
|
|
*/
|
|
#ifndef vtkDIYUtilities_h
|
|
#define vtkDIYUtilities_h
|
|
|
|
#include "vtkObject.h"
|
|
#include "vtkParallelDIYModule.h" // for export macros
|
|
#include "vtkSmartPointer.h" // needed for vtkSmartPointer
|
|
|
|
// clang-format off
|
|
#include "vtk_diy2.h" // needed for DIY
|
|
#include VTK_DIY2(diy/mpi.hpp)
|
|
#include VTK_DIY2(diy/serialization.hpp)
|
|
#include VTK_DIY2(diy/types.hpp)
|
|
// clang-format on
|
|
|
|
class vtkBoundingBox;
|
|
class vtkDataObject;
|
|
class vtkDataSet;
|
|
class vtkMultiProcessController;
|
|
class vtkPoints;
|
|
|
|
class VTKPARALLELDIY_EXPORT vtkDIYUtilities : public vtkObject
|
|
{
|
|
public:
|
|
vtkTypeMacro(vtkDIYUtilities, vtkObject);
|
|
void PrintSelf(ostream& os, vtkIndent indent) override;
|
|
|
|
/**
|
|
* In MPI-enabled builds, DIY filters need MPI to be initialized.
|
|
* Calling this method in such filters will ensure that that's the case.
|
|
*/
|
|
static void InitializeEnvironmentForDIY();
|
|
|
|
/**
|
|
* Converts a vtkMultiProcessController to a diy::mpi::communicator.
|
|
* If controller is nullptr or not a vtkMPIController, then
|
|
* diy::mpi::communicator(MPI_COMM_NULL) is created.
|
|
*/
|
|
static diy::mpi::communicator GetCommunicator(vtkMultiProcessController* controller);
|
|
|
|
//@{
|
|
/**
|
|
* Load/Save a vtkDataSet in a diy::BinaryBuffer.
|
|
*/
|
|
static void Save(diy::BinaryBuffer& bb, vtkDataSet*);
|
|
static void Load(diy::BinaryBuffer& bb, vtkDataSet*&);
|
|
//@}
|
|
|
|
/**
|
|
* Reduce bounding box.
|
|
*/
|
|
static void AllReduce(diy::mpi::communicator& comm, vtkBoundingBox& bbox);
|
|
|
|
/**
|
|
* Convert vtkBoundingBox to diy::ContinuousBounds.
|
|
*
|
|
* Note, there is a loss of precision since vtkBoundingBox uses `double` while
|
|
* diy::ContinuousBounds uses float.
|
|
*/
|
|
static diy::ContinuousBounds Convert(const vtkBoundingBox& bbox);
|
|
|
|
/**
|
|
* Convert diy::ContinuousBounds to vtkBoundingBox.
|
|
*
|
|
* Note, there is a change of precision since vtkBoundingBox uses `double` while
|
|
* diy::ContinuousBounds uses float.
|
|
*/
|
|
static vtkBoundingBox Convert(const diy::ContinuousBounds& bds);
|
|
|
|
/**
|
|
* Broadcast a vector of bounding boxes. Only the source vector needs to have
|
|
* a valid size.
|
|
*/
|
|
static void Broadcast(
|
|
diy::mpi::communicator& comm, std::vector<vtkBoundingBox>& boxes, int source);
|
|
|
|
/**
|
|
* Extract datasets from the given data object. This method returns a vector
|
|
* of vtkDataSet* from the `dobj`. If dobj is a vtkDataSet, the returned
|
|
* vector will have just 1 vtkDataSet. If dobj is a vtkCompositeDataSet, then
|
|
* we iterate over it and add all non-null leaf nodes to the returned vector.
|
|
*/
|
|
static std::vector<vtkDataSet*> GetDataSets(vtkDataObject* dobj);
|
|
|
|
//@{
|
|
/**
|
|
* Extracts points from the input. If input is not a vtkPointSet, it will use
|
|
* an appropriate filter to extract the vtkPoints. If use_cell_centers is
|
|
* true, cell-centers will be computed and extracted instead of the dataset
|
|
* points.
|
|
*/
|
|
static std::vector<vtkSmartPointer<vtkPoints> > ExtractPoints(
|
|
const std::vector<vtkDataSet*>& datasets, bool use_cell_centers);
|
|
//@}
|
|
|
|
/**
|
|
* Convenience method to get local bounds for the data object.
|
|
*/
|
|
static vtkBoundingBox GetLocalBounds(vtkDataObject* dobj);
|
|
|
|
protected:
|
|
vtkDIYUtilities();
|
|
~vtkDIYUtilities() override;
|
|
|
|
private:
|
|
vtkDIYUtilities(const vtkDIYUtilities&) = delete;
|
|
void operator=(const vtkDIYUtilities&) = delete;
|
|
};
|
|
|
|
namespace diy
|
|
{
|
|
template <>
|
|
struct Serialization<vtkDataSet*>
|
|
{
|
|
static void save(BinaryBuffer& bb, vtkDataSet* const& p) { vtkDIYUtilities::Save(bb, p); }
|
|
static void load(BinaryBuffer& bb, vtkDataSet*& p) { vtkDIYUtilities::Load(bb, p); }
|
|
};
|
|
}
|
|
|
|
// Implementation detail for Schwarz counter idiom.
|
|
class VTKPARALLELDIY_EXPORT vtkDIYUtilitiesCleanup
|
|
{
|
|
public:
|
|
vtkDIYUtilitiesCleanup();
|
|
~vtkDIYUtilitiesCleanup();
|
|
|
|
private:
|
|
vtkDIYUtilitiesCleanup(const vtkDIYUtilitiesCleanup&) = delete;
|
|
void operator=(const vtkDIYUtilitiesCleanup&) = delete;
|
|
};
|
|
static vtkDIYUtilitiesCleanup vtkDIYUtilitiesCleanupInstance;
|
|
|
|
#endif
|
|
// VTK-HeaderTest-Exclude: vtkDIYUtilities.h
|