VTK-m  2.2
Public Member Functions | Private Attributes | List of all members
vtkm::exec::arg::ThreadIndicesBasic3D Class Reference

Container for 3D thread indices in a worklet invocation. More...

#include <ThreadIndicesBasic3D.h>

Inheritance diagram for vtkm::exec::arg::ThreadIndicesBasic3D:
vtkm::exec::arg::ThreadIndicesBasic

Public Member Functions

 ThreadIndicesBasic3D (const vtkm::Id3 &threadIndex3D, vtkm::Id threadIndex1D, vtkm::Id inIndex, vtkm::IdComponent visitIndex, vtkm::Id outIndex)
 
vtkm::Id3 GetInputIndex3D () const
 The 3D index into the input domain. More...
 
- Public Member Functions inherited from vtkm::exec::arg::ThreadIndicesBasic
 ThreadIndicesBasic (vtkm::Id threadIndex, vtkm::Id inIndex, vtkm::IdComponent visitIndex, vtkm::Id outIndex)
 
vtkm::Id GetThreadIndex () const
 The index of the thread or work invocation. More...
 
vtkm::Id GetInputIndex () const
 The index into the input domain. More...
 
vtkm::Id3 GetInputIndex3D () const
 The 3D index into the input domain. More...
 
vtkm::Id GetOutputIndex () const
 The index into the output domain. More...
 
vtkm::IdComponent GetVisitIndex () const
 The visit index. More...
 

Private Attributes

vtkm::Id3 ThreadIndex3D
 

Detailed Description

Container for 3D thread indices in a worklet invocation.

During the execution of a worklet function in an execution environment thread, VTK-m has to manage several indices. To simplify this management and to provide a single place to store them (so that they do not have to be recomputed), WorkletInvokeFunctor creates a ThreadIndices object. This object gets passed to Fetch operations to help them load data.

Constructor & Destructor Documentation

◆ ThreadIndicesBasic3D()

vtkm::exec::arg::ThreadIndicesBasic3D::ThreadIndicesBasic3D ( const vtkm::Id3 threadIndex3D,
vtkm::Id  threadIndex1D,
vtkm::Id  inIndex,
vtkm::IdComponent  visitIndex,
vtkm::Id  outIndex 
)
inline

Member Function Documentation

◆ GetInputIndex3D()

vtkm::Id3 vtkm::exec::arg::ThreadIndicesBasic3D::GetInputIndex3D ( ) const
inline

The 3D index into the input domain.

This index refers to the input element (array value, cell, etc.) that this thread is being invoked for. If the input domain has 2 or 3 dimensional indexing, this result will preserve that. If the domain indexing is just one dimensional, the result will have the index in the first component with the remaining components set to 0.

Member Data Documentation

◆ ThreadIndex3D

vtkm::Id3 vtkm::exec::arg::ThreadIndicesBasic3D::ThreadIndex3D
private

The documentation for this class was generated from the following file: