VTK-m  2.0
ThreadIndices.h
Go to the documentation of this file.
1 //============================================================================
2 // Copyright (c) Kitware, Inc.
3 // All rights reserved.
4 // See LICENSE.txt for details.
5 //
6 // This software is distributed WITHOUT ANY WARRANTY; without even
7 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
8 // PURPOSE. See the above copyright notice for more information.
9 //============================================================================
10 #ifndef vtk_m_exec_arg_ThreadIndices_h
11 #define vtk_m_exec_arg_ThreadIndices_h
12 
14 #include <vtkm/exec/arg/Fetch.h>
15 
16 namespace vtkm
17 {
18 namespace exec
19 {
20 namespace arg
21 {
22 
30 {
31 };
32 
42 {
43  // The index does not really matter because the fetch is going to ignore it.
44  // However, it still has to point to a valid parameter in the
45  // ControlSignature because the templating is going to grab a fetch tag
46  // whether we use it or not. 1 should be guaranteed to be valid since you
47  // need at least one argument for the input domain.
48  static constexpr vtkm::IdComponent INDEX = 1;
50 };
51 
52 template <typename FetchTag, typename ExecObjectType>
53 struct Fetch<FetchTag, vtkm::exec::arg::AspectTagThreadIndices, ExecObjectType>
54 {
55 
56  template <typename ThreadIndicesType>
57  VTKM_EXEC const ThreadIndicesType& Load(const ThreadIndicesType& indices,
58  const ExecObjectType&) const
59  {
60  return indices;
61  }
62 
63  template <typename ThreadIndicesType>
64  VTKM_EXEC void Store(const ThreadIndicesType&,
65  const ExecObjectType&,
66  const ThreadIndicesType&) const
67  {
68  // Store is a no-op.
69  }
70 };
71 }
72 }
73 } // namespace vtkm::exec::arg
74 
75 #endif //vtk_m_exec_arg_ThreadIndices_h
vtkm::exec::arg::ThreadIndices::INDEX
static constexpr vtkm::IdComponent INDEX
Definition: ThreadIndices.h:48
vtkm::exec::arg::AspectTagThreadIndices
Aspect tag to use for getting the thread indices.
Definition: ThreadIndices.h:29
VTKM_EXEC
#define VTKM_EXEC
Definition: ExportMacros.h:51
vtkm
Groups connected points that have the same field value.
Definition: Atomic.h:19
vtkm::exec::arg::ExecutionSignatureTagBase
The base class for all tags used in an ExecutionSignature.
Definition: ExecutionSignatureTagBase.h:37
vtkm::exec::arg::Fetch< FetchTag, vtkm::exec::arg::AspectTagThreadIndices, ExecObjectType >::Load
const VTKM_EXEC ThreadIndicesType & Load(const ThreadIndicesType &indices, const ExecObjectType &) const
Definition: ThreadIndices.h:57
vtkm::IdComponent
vtkm::Int32 IdComponent
Represents a component ID (index of component in a vector).
Definition: Types.h:168
vtkm::exec::arg::Fetch
Class for loading and storing values in thread instance.
Definition: Fetch.h:49
ExecutionSignatureTagBase.h
Fetch.h
vtkm::exec::arg::ThreadIndices
The ExecutionSignature tag to use to get the thread indices.
Definition: ThreadIndices.h:41
vtkm::exec::arg::Fetch< FetchTag, vtkm::exec::arg::AspectTagThreadIndices, ExecObjectType >::Store
VTKM_EXEC void Store(const ThreadIndicesType &, const ExecObjectType &, const ThreadIndicesType &) const
Definition: ThreadIndices.h:64