2015-12-03 23:26:10 +00:00
|
|
|
//============================================================================
|
|
|
|
// Copyright (c) Kitware, Inc.
|
|
|
|
// All rights reserved.
|
|
|
|
// See LICENSE.txt for details.
|
2019-04-15 23:24:21 +00:00
|
|
|
//
|
2015-12-03 23:26:10 +00:00
|
|
|
// 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_TransportTagWholeArrayOut_h
|
|
|
|
#define vtk_m_cont_arg_TransportTagWholeArrayOut_h
|
|
|
|
|
2022-11-11 21:34:13 +00:00
|
|
|
#include <vtkm/Deprecated.h>
|
2015-12-03 23:26:10 +00:00
|
|
|
#include <vtkm/Types.h>
|
|
|
|
|
|
|
|
#include <vtkm/cont/ArrayHandle.h>
|
|
|
|
|
|
|
|
#include <vtkm/cont/arg/Transport.h>
|
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace vtkm
|
|
|
|
{
|
|
|
|
namespace cont
|
|
|
|
{
|
|
|
|
namespace arg
|
|
|
|
{
|
2015-12-03 23:26:10 +00:00
|
|
|
|
|
|
|
/// \brief \c Transport tag for in-place arrays with random access.
|
|
|
|
///
|
|
|
|
/// \c TransportTagWholeArrayOut is a tag used with the \c Transport class to
|
|
|
|
/// transport \c ArrayHandle objects for output data. The array needs to be
|
|
|
|
/// allocated before passed as an argument to Invoke.
|
|
|
|
///
|
|
|
|
/// 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 overridden by another entry.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
struct TransportTagWholeArrayOut
|
|
|
|
{
|
|
|
|
};
|
2015-12-03 23:26:10 +00:00
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename ContObjectType, typename Device>
|
|
|
|
struct Transport<vtkm::cont::arg::TransportTagWholeArrayOut, ContObjectType, Device>
|
2015-12-03 23:26:10 +00:00
|
|
|
{
|
2020-09-09 12:09:39 +00:00
|
|
|
// 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
|
|
|
|
|
2015-12-03 23:26:10 +00:00
|
|
|
// 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);
|
|
|
|
|
2017-06-23 18:50:34 +00:00
|
|
|
using ValueType = typename ContObjectType::ValueType;
|
|
|
|
using StorageTag = typename ContObjectType::StorageTag;
|
2015-12-03 23:26:10 +00:00
|
|
|
|
2022-10-27 21:07:41 +00:00
|
|
|
using ExecObjectType = typename ContObjectType::WritePortalType;
|
2015-12-03 23:26:10 +00:00
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
template <typename InputDomainType>
|
2020-01-19 06:36:14 +00:00
|
|
|
VTKM_CONT ExecObjectType operator()(ContObjectType& array,
|
|
|
|
const InputDomainType&,
|
|
|
|
vtkm::Id,
|
|
|
|
vtkm::Id,
|
|
|
|
vtkm::cont::Token& token) const
|
2015-12-03 23:26:10 +00:00
|
|
|
{
|
|
|
|
// 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.
|
|
|
|
|
2022-10-27 21:07:41 +00:00
|
|
|
return array.PrepareForOutput(array.GetNumberOfValues(), Device{}, token);
|
2015-12-03 23:26:10 +00:00
|
|
|
}
|
2020-09-09 12:09:39 +00:00
|
|
|
|
|
|
|
#ifdef VTKM_MSVC
|
|
|
|
VTKM_DEPRECATED_SUPPRESS_END
|
|
|
|
#endif
|
2015-12-03 23:26:10 +00:00
|
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} // namespace vtkm::cont::arg
|
|
|
|
|
|
|
|
#endif //vtk_m_cont_arg_TransportTagWholeArrayOut_h
|