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.
79 lines
2.7 KiB
C++
79 lines
2.7 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_ThreadIndices_h
|
|
#define vtk_m_exec_arg_ThreadIndices_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 thread indices.
|
|
///
|
|
/// The `AspectTagThreadIndices` aspect tag causes the `Fetch` class to
|
|
/// ignore whatever data is in the associated execution object and return the
|
|
/// thread indices.
|
|
///
|
|
struct AspectTagThreadIndices
|
|
{
|
|
};
|
|
|
|
/// @brief The `ExecutionSignature` tag to use to get the thread indices
|
|
///
|
|
/// This tag produces an internal object that manages indices and other metadata
|
|
/// of the current thread. Thread indices objects vary by worklet type, but most
|
|
/// users can get the information they need through other signature tags.
|
|
///
|
|
/// When a worklet is dispatched, it broken into pieces defined by the input
|
|
/// domain and scheduled on independent threads. During this process multiple
|
|
/// indices associated with the input and output can be generated. This tag in
|
|
/// the `ExecutionSignature` passes the index for this work.
|
|
///
|
|
struct ThreadIndices : 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::AspectTagThreadIndices;
|
|
};
|
|
|
|
template <typename FetchTag, typename ExecObjectType>
|
|
struct Fetch<FetchTag, vtkm::exec::arg::AspectTagThreadIndices, ExecObjectType>
|
|
{
|
|
|
|
template <typename ThreadIndicesType>
|
|
VTKM_EXEC const ThreadIndicesType& Load(const ThreadIndicesType& indices,
|
|
const ExecObjectType&) const
|
|
{
|
|
return indices;
|
|
}
|
|
|
|
template <typename ThreadIndicesType>
|
|
VTKM_EXEC void Store(const ThreadIndicesType&,
|
|
const ExecObjectType&,
|
|
const ThreadIndicesType&) const
|
|
{
|
|
// Store is a no-op.
|
|
}
|
|
};
|
|
}
|
|
}
|
|
} // namespace vtkm::exec::arg
|
|
|
|
#endif //vtk_m_exec_arg_ThreadIndices_h
|