mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-09-16 17:22:55 +00:00
46508487a0
Some versions of doxygen have issues with documenting `typedef`s (or the equivalent `using`). This was causing warnings with doxygen and failing to create some of the documentation. This fixes the problem by moving the documentation to the classes things are defined to.
76 lines
2.6 KiB
C++
76 lines
2.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_exec_arg_InputIndex_h
|
|
#define vtk_m_exec_arg_InputIndex_h
|
|
|
|
#include <vtkm/exec/arg/ExecutionSignatureTagBase.h>
|
|
#include <vtkm/exec/arg/Fetch.h>
|
|
|
|
namespace vtkm
|
|
{
|
|
namespace exec
|
|
{
|
|
namespace arg
|
|
{
|
|
|
|
/// @brief Aspect tag to use for getting the work index.
|
|
///
|
|
/// The `AspectTagInputIndex` aspect tag causes the \c Fetch class to ignore
|
|
/// whatever data is in the associated execution object and return the index
|
|
/// of the input element.
|
|
///
|
|
struct AspectTagInputIndex
|
|
{
|
|
};
|
|
|
|
/// @brief The `ExecutionSignature` tag to use to get the input index
|
|
///
|
|
/// This tag produces a `vtkm::Id` that identifies the index of the input
|
|
/// element, which can differ from the `WorkIndex` in a worklet with a scatter.
|
|
///
|
|
/// When a worklet is dispatched, it broken into pieces defined by the input
|
|
/// domain and scheduled on independent threads. This tag in the
|
|
/// `ExecutionSignature` passes the index of the input element that the work
|
|
/// thread is currently working on. When a worklet has a scatter associated
|
|
/// with it, the input and output indices can be different.
|
|
struct InputIndex : 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 input domain.
|
|
static constexpr vtkm::IdComponent INDEX = 1;
|
|
using AspectTag = vtkm::exec::arg::AspectTagInputIndex;
|
|
};
|
|
|
|
template <typename FetchTag, typename ExecObjectType>
|
|
struct Fetch<FetchTag, vtkm::exec::arg::AspectTagInputIndex, ExecObjectType>
|
|
{
|
|
using ValueType = vtkm::Id;
|
|
|
|
template <typename ThreadIndicesType>
|
|
VTKM_EXEC vtkm::Id Load(const ThreadIndicesType& indices, const ExecObjectType&) const
|
|
{
|
|
return indices.GetInputIndex();
|
|
}
|
|
|
|
template <typename ThreadIndicesType>
|
|
VTKM_EXEC void Store(const ThreadIndicesType&, const ExecObjectType&, const ValueType&) const
|
|
{
|
|
// Store is a no-op.
|
|
}
|
|
};
|
|
}
|
|
}
|
|
} // namespace vtkm::exec::arg
|
|
|
|
#endif //vtk_m_exec_arg_InputIndex_h
|