mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-16 17:22:55 +00:00
3e1339f9a7
With the major revision 2.0 of VTK-m, many items previously marked as deprecated were removed. If updating to a new version of VTK-m, it is recommended to first update to VTK-m 1.9, which will include the deprecated features but provide warnings (with the right compiler) that will point to the replacement code. Once the deprecations have been fixed, updating to 2.0 should be smoother.
63 lines
2.1 KiB
C++
63 lines
2.1 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_FieldRangeCompute_h
|
|
#define vtk_m_cont_FieldRangeCompute_h
|
|
|
|
#include <vtkm/cont/DataSet.h>
|
|
#include <vtkm/cont/Field.h>
|
|
#include <vtkm/cont/PartitionedDataSet.h>
|
|
|
|
#include <numeric>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
/// \brief Compute ranges for fields in a DataSet or PartitionedDataSet.
|
|
///
|
|
/// These methods to compute ranges for fields in a single dataset or a
|
|
/// partitioned dataset.
|
|
/// When using VTK-m in a hybrid-parallel environment with distributed processing,
|
|
/// this class uses ranges for locally available data alone. Use FieldRangeGlobalCompute
|
|
/// to compute ranges globally across all ranks even in distributed mode.
|
|
|
|
//{@
|
|
/// Returns the range for a field from a dataset. If the field is not present, an empty
|
|
/// ArrayHandle will be returned.
|
|
VTKM_CONT_EXPORT
|
|
VTKM_CONT
|
|
vtkm::cont::ArrayHandle<vtkm::Range> FieldRangeCompute(
|
|
const vtkm::cont::DataSet& dataset,
|
|
const std::string& name,
|
|
vtkm::cont::Field::Association assoc = vtkm::cont::Field::Association::Any);
|
|
//@}
|
|
|
|
//{@
|
|
/// Returns the range for a field from a PartitionedDataSet. If the field is
|
|
/// not present on any of the partitions, an empty ArrayHandle will be
|
|
/// returned. If the field is present on some partitions, but not all, those
|
|
/// partitions without the field are skipped.
|
|
///
|
|
/// The returned array handle will have as many values as the maximum number of
|
|
/// components for the selected field across all partitions.
|
|
///
|
|
VTKM_CONT_EXPORT
|
|
VTKM_CONT
|
|
vtkm::cont::ArrayHandle<vtkm::Range> FieldRangeCompute(
|
|
const vtkm::cont::PartitionedDataSet& pds,
|
|
const std::string& name,
|
|
vtkm::cont::Field::Association assoc = vtkm::cont::Field::Association::Any);
|
|
//@}
|
|
|
|
}
|
|
} // namespace vtkm::cont
|
|
|
|
#endif
|