VTK-m  2.0
InputIndex.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_InputIndex_h
11 #define vtk_m_exec_arg_InputIndex_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 
43 {
44  // The index does not really matter because the fetch is going to ignore it.
45  // However, it still has to point to a valid parameter in the
46  // ControlSignature because the templating is going to grab a fetch tag
47  // whether we use it or not. 1 should be guaranteed to be valid since you
48  // need at least one argument for the input domain.
49  static constexpr vtkm::IdComponent INDEX = 1;
51 };
52 
53 template <typename FetchTag, typename ExecObjectType>
54 struct Fetch<FetchTag, vtkm::exec::arg::AspectTagInputIndex, ExecObjectType>
55 {
57 
58  template <typename ThreadIndicesType>
59  VTKM_EXEC vtkm::Id Load(const ThreadIndicesType& indices, const ExecObjectType&) const
60  {
61  return indices.GetInputIndex();
62  }
63 
64  template <typename ThreadIndicesType>
65  VTKM_EXEC void Store(const ThreadIndicesType&, const ExecObjectType&, const ValueType&) const
66  {
67  // Store is a no-op.
68  }
69 };
70 }
71 }
72 } // namespace vtkm::exec::arg
73 
74 #endif //vtk_m_exec_arg_InputIndex_h
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::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
vtkm::Id
vtkm::Int32 Id
Represents an ID (index into arrays).
Definition: Types.h:191
vtkm::exec::arg::AspectTagInputIndex
Aspect tag to use for getting the work index.
Definition: InputIndex.h:29
ExecutionSignatureTagBase.h
Fetch.h
vtkm::exec::arg::Fetch< FetchTag, vtkm::exec::arg::AspectTagInputIndex, ExecObjectType >::Load
VTKM_EXEC vtkm::Id Load(const ThreadIndicesType &indices, const ExecObjectType &) const
Definition: InputIndex.h:59
vtkm::exec::arg::InputIndex::INDEX
static constexpr vtkm::IdComponent INDEX
Definition: InputIndex.h:49
vtkm::exec::arg::Fetch< FetchTag, vtkm::exec::arg::AspectTagInputIndex, ExecObjectType >::ValueType
vtkm::Id ValueType
Definition: InputIndex.h:56
vtkm::exec::arg::Fetch< FetchTag, vtkm::exec::arg::AspectTagInputIndex, ExecObjectType >::Store
VTKM_EXEC void Store(const ThreadIndicesType &, const ExecObjectType &, const ValueType &) const
Definition: InputIndex.h:65
vtkm::exec::arg::InputIndex
The ExecutionSignature tag to use to get the input index.
Definition: InputIndex.h:42