2016-12-06 00:30:57 +00:00
|
|
|
//============================================================================
|
|
|
|
// Copyright (c) Kitware, Inc.
|
|
|
|
// All rights reserved.
|
|
|
|
// See LICENSE.txt for details.
|
2019-04-15 23:24:21 +00:00
|
|
|
//
|
2016-12-06 00:30:57 +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_exec_arg_OutputIndex_h
|
|
|
|
#define vtk_m_exec_arg_OutputIndex_h
|
|
|
|
|
|
|
|
#include <vtkm/exec/arg/ExecutionSignatureTagBase.h>
|
2017-05-18 14:51:24 +00:00
|
|
|
#include <vtkm/exec/arg/Fetch.h>
|
2016-12-06 00:30:57 +00:00
|
|
|
|
2017-05-18 14:29:41 +00:00
|
|
|
namespace vtkm
|
|
|
|
{
|
|
|
|
namespace exec
|
|
|
|
{
|
|
|
|
namespace arg
|
|
|
|
{
|
2016-12-06 00:30:57 +00:00
|
|
|
|
2024-02-12 06:18:09 +00:00
|
|
|
/// @brief Aspect tag to use for getting the work index.
|
2016-12-06 00:30:57 +00:00
|
|
|
///
|
2024-02-12 06:18:09 +00:00
|
|
|
/// The `AspectTagOutputIndex` aspect tag causes the `Fetch` class to ignore
|
2016-12-06 00:30:57 +00:00
|
|
|
/// whatever data is in the associated execution object and return the index
|
|
|
|
/// of the output element.
|
|
|
|
///
|
2017-05-18 14:29:41 +00:00
|
|
|
struct AspectTagOutputIndex
|
|
|
|
{
|
|
|
|
};
|
2016-12-06 00:30:57 +00:00
|
|
|
|
2024-02-12 06:18:09 +00:00
|
|
|
/// @brief The `ExecutionSignature` tag to use to get the output index
|
|
|
|
///
|
|
|
|
/// This tag produces a `vtkm::Id` that identifies the index of the output element.
|
|
|
|
/// (This is generally the same as `WorkIndex`.)
|
2016-12-06 00:30:57 +00:00
|
|
|
///
|
|
|
|
/// When a worklet is dispatched, it broken into pieces defined by the output
|
2024-02-12 06:18:09 +00:00
|
|
|
/// domain and scheduled on independent threads. This tag in the
|
|
|
|
/// `ExecutionSignature` passes the index of the output element that the work
|
2016-12-06 00:30:57 +00:00
|
|
|
/// thread is currently working on. When a worklet has a scatter associated
|
2024-02-12 06:18:09 +00:00
|
|
|
/// with it, the output and output indices can be different.
|
2016-12-06 00:30:57 +00:00
|
|
|
///
|
|
|
|
struct OutputIndex : vtkm::exec::arg::ExecutionSignatureTagBase
|
|
|
|
{
|
|
|
|
// The index does not really matter because the fetch is going to ignore it.
|
|
|
|
// However, it still has to point to a valid parameter in the
|
|
|
|
// ControlSignature because the templating is going to grab a fetch tag
|
|
|
|
// whether we use it or not. 1 should be guaranteed to be valid since you
|
|
|
|
// need at least one argument for the output domain.
|
2018-02-27 14:25:25 +00:00
|
|
|
static constexpr vtkm::IdComponent INDEX = 1;
|
2017-06-23 18:50:34 +00:00
|
|
|
using AspectTag = vtkm::exec::arg::AspectTagOutputIndex;
|
2016-12-06 00:30:57 +00:00
|
|
|
};
|
|
|
|
|
2020-04-14 15:00:46 +00:00
|
|
|
template <typename FetchTag, typename ExecObjectType>
|
|
|
|
struct Fetch<FetchTag, vtkm::exec::arg::AspectTagOutputIndex, ExecObjectType>
|
2016-12-06 00:30:57 +00:00
|
|
|
{
|
2017-06-23 18:50:34 +00:00
|
|
|
using ValueType = vtkm::Id;
|
2016-12-06 00:30:57 +00:00
|
|
|
|
2020-04-14 15:00:46 +00:00
|
|
|
template <typename ThreadIndicesType>
|
|
|
|
VTKM_EXEC vtkm::Id Load(const ThreadIndicesType& indices, const ExecObjectType&) const
|
2016-12-06 00:30:57 +00:00
|
|
|
{
|
|
|
|
return indices.GetOutputIndex();
|
|
|
|
}
|
|
|
|
|
2020-04-14 15:00:46 +00:00
|
|
|
template <typename ThreadIndicesType>
|
|
|
|
VTKM_EXEC void Store(const ThreadIndicesType&, const ExecObjectType&, const ValueType&) const
|
2016-12-06 00:30:57 +00:00
|
|
|
{
|
|
|
|
// Store is a no-op.
|
|
|
|
}
|
|
|
|
};
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} // namespace vtkm::exec::arg
|
|
|
|
|
|
|
|
#endif //vtk_m_exec_arg_OutputIndex_h
|