mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-16 17:22:55 +00:00
2945813755
`ExecutionWholeArray` is an archaic class in VTK-m that is a thin wrapper around an array portal. In the early days of VTK-m, this class was used to transfer whole arrays to the execution environment. However, now the supported method is to use `WholeArray*` tags in the `ControlSignature` of a worklet. Nevertheless, the `WholeArray*` tags caused the array portal transferred to the worklet to be wrapped inside of an `ExecutionWholeArray` class. This is unnecessary and can cause confusion about the types of data being used. Most code is unaffected by this change. Some code that had to work around the issue of the portal wrapped in another class used the `GetPortal` method which is no longer needed (for obvious reasons). One extra feature that `ExecutionWholeArray` had was that it provided an subscript operator (somewhat incorrectly). Thus, any use of '[..]' to index the array portal have to be changed to use the `Get` method.
84 lines
2.8 KiB
C++
84 lines
2.8 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_arg_TransportTagWholeArrayInOut_h
|
|
#define vtk_m_cont_arg_TransportTagWholeArrayInOut_h
|
|
|
|
#include <vtkm/Types.h>
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
|
|
#include <vtkm/cont/arg/Transport.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace cont
|
|
{
|
|
namespace arg
|
|
{
|
|
|
|
/// \brief \c Transport tag for in-place arrays with random access.
|
|
///
|
|
/// \c TransportTagWholeArrayInOut is a tag used with the \c Transport class to
|
|
/// transport \c ArrayHandle objects for data that is both input and output
|
|
/// (that is, in place modification of array data).
|
|
///
|
|
/// The worklet will have random access to the array through a portal
|
|
/// interface, but care should be taken to not write a value in one instance
|
|
/// that will be read by or overridden by another entry.
|
|
///
|
|
struct TransportTagWholeArrayInOut
|
|
{
|
|
};
|
|
|
|
template <typename ContObjectType, typename Device>
|
|
struct Transport<vtkm::cont::arg::TransportTagWholeArrayInOut, ContObjectType, Device>
|
|
{
|
|
// MSVC will issue deprecation warnings here if this template is instantiated with
|
|
// a deprecated class even if the template is used from a section of code where
|
|
// deprecation warnings are suppressed. This is annoying behavior since this template
|
|
// has no control over what class it is used with. To get around it, we have to
|
|
// suppress all deprecation warnings here.
|
|
#ifdef VTKM_MSVC
|
|
VTKM_DEPRECATED_SUPPRESS_BEGIN
|
|
#endif
|
|
|
|
// If you get a compile error here, it means you tried to use an object that
|
|
// is not an array handle as an argument that is expected to be one.
|
|
VTKM_IS_ARRAY_HANDLE(ContObjectType);
|
|
|
|
using ValueType = typename ContObjectType::ValueType;
|
|
using StorageTag = typename ContObjectType::StorageTag;
|
|
|
|
using ExecObjectType = typename ContObjectType::WritePortalType;
|
|
|
|
template <typename InputDomainType>
|
|
VTKM_CONT ExecObjectType operator()(ContObjectType& array,
|
|
const InputDomainType&,
|
|
vtkm::Id,
|
|
vtkm::Id,
|
|
vtkm::cont::Token& token) const
|
|
{
|
|
// Note: we ignore the size of the domain because the randomly accessed
|
|
// array might not have the same size depending on how the user is using
|
|
// the array.
|
|
|
|
return array.PrepareForInPlace(Device{}, token);
|
|
}
|
|
|
|
#ifdef VTKM_MSVC
|
|
VTKM_DEPRECATED_SUPPRESS_END
|
|
#endif
|
|
};
|
|
}
|
|
}
|
|
} // namespace vtkm::cont::arg
|
|
|
|
#endif //vtk_m_cont_arg_TransportTagWholeArrayInOut_h
|