mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-19 02:25:42 +00:00
63050f68fc
The `MultiBlock` class has been renamed to `PartitionedDataSet`, and its API has been refactored to refer to "partitions", rather than "blocks". Additionally, the `AddBlocks` method has been changed to `AppendPartitions` to more accurately reflect the operation performed. The associated `AssignerMultiBlock` class has also been renamed to `AssignerPartitionedDataSet`. This change is motivated towards unifying VTK-m's data model with VTK. VTK has started to move away from `vtkMultiBlockDataSet`, which is a hierarchical tree of nested datasets, to `vtkPartitionedDataSet`, which is always a flat vector of datasets used to assist geometry distribution in multi-process environments. This simplifies traversal during processing and clarifies the intent of the container: The component datasets are partitions for distribution, not organizational groupings (e.g. materials). Ref #405
112 lines
3.6 KiB
C++
112 lines
3.6 KiB
C++
//============================================================================
|
|
// Copyright (c) Kitware, Inc.
|
|
// All rights reserved.
|
|
// See LICENSE.txt 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.
|
|
//============================================================================
|
|
#ifndef vtk_m_cont_PartitionedDataSet_h
|
|
#define vtk_m_cont_PartitionedDataSet_h
|
|
#include <limits>
|
|
#include <vtkm/StaticAssert.h>
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
#include <vtkm/cont/DataSet.h>
|
|
#include <vtkm/cont/DeviceAdapterAlgorithm.h>
|
|
#include <vtkm/cont/Field.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
|
|
class VTKM_CONT_EXPORT PartitionedDataSet
|
|
{
|
|
using StorageVec = std::vector<vtkm::cont::DataSet>;
|
|
|
|
public:
|
|
using iterator = typename StorageVec::iterator;
|
|
using const_iterator = typename StorageVec::const_iterator;
|
|
using value_type = typename StorageVec::value_type;
|
|
using reference = typename StorageVec::reference;
|
|
using const_reference = typename StorageVec::const_reference;
|
|
|
|
/// create a new PartitionedDataSet containng a single DataSet @a ds
|
|
VTKM_CONT
|
|
PartitionedDataSet(const vtkm::cont::DataSet& ds);
|
|
/// create a new PartitionedDataSet with the existing one @a src
|
|
VTKM_CONT
|
|
PartitionedDataSet(const vtkm::cont::PartitionedDataSet& src);
|
|
/// create a new PartitionedDataSet with a DataSet vector @a partitions.
|
|
VTKM_CONT
|
|
explicit PartitionedDataSet(const std::vector<vtkm::cont::DataSet>& partitions);
|
|
/// create a new PartitionedDataSet with the capacity set to be @a size
|
|
VTKM_CONT
|
|
explicit PartitionedDataSet(vtkm::Id size);
|
|
|
|
VTKM_CONT
|
|
PartitionedDataSet();
|
|
|
|
VTKM_CONT
|
|
PartitionedDataSet& operator=(const vtkm::cont::PartitionedDataSet& src);
|
|
|
|
VTKM_CONT
|
|
~PartitionedDataSet();
|
|
/// get the field @a field_name from partition @a partition_index
|
|
VTKM_CONT
|
|
vtkm::cont::Field GetField(const std::string& field_name, int partition_index);
|
|
|
|
VTKM_CONT
|
|
vtkm::Id GetNumberOfPartitions() const;
|
|
|
|
VTKM_CONT
|
|
const vtkm::cont::DataSet& GetPartition(vtkm::Id partId) const;
|
|
|
|
VTKM_CONT
|
|
const std::vector<vtkm::cont::DataSet>& GetPartitions() const;
|
|
|
|
/// add DataSet @a ds to the end of the contained DataSet vector
|
|
VTKM_CONT
|
|
void AppendPartition(const vtkm::cont::DataSet& ds);
|
|
|
|
/// add DataSet @a ds to position @a index of the contained DataSet vector
|
|
VTKM_CONT
|
|
void InsertPartition(vtkm::Id index, const vtkm::cont::DataSet& ds);
|
|
|
|
/// replace the @a index positioned element of the contained DataSet vector
|
|
/// with @a ds
|
|
VTKM_CONT
|
|
void ReplacePartition(vtkm::Id index, const vtkm::cont::DataSet& ds);
|
|
|
|
/// append the DataSet vector "partitions" to the end of the contained one
|
|
VTKM_CONT
|
|
void AppendPartitions(const std::vector<vtkm::cont::DataSet>& partitions);
|
|
|
|
VTKM_CONT
|
|
void PrintSummary(std::ostream& stream) const;
|
|
|
|
//@{
|
|
/// API to support range-based for loops on partitions.
|
|
VTKM_CONT
|
|
iterator begin() noexcept { return this->Partitions.begin(); }
|
|
VTKM_CONT
|
|
iterator end() noexcept { return this->Partitions.end(); }
|
|
VTKM_CONT
|
|
const_iterator begin() const noexcept { return this->Partitions.begin(); }
|
|
VTKM_CONT
|
|
const_iterator end() const noexcept { return this->Partitions.end(); }
|
|
VTKM_CONT
|
|
const_iterator cbegin() const noexcept { return this->Partitions.cbegin(); }
|
|
VTKM_CONT
|
|
const_iterator cend() const noexcept { return this->Partitions.cend(); }
|
|
//@}
|
|
private:
|
|
std::vector<vtkm::cont::DataSet> Partitions;
|
|
};
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif
|