Container for thread indices in a topology map. More...
#include <ThreadIndicesTopologyMap.h>
Public Types | |
| using | IndicesIncidentType = typename ConnectivityType::IndicesType |
| using | CellShapeTag = typename ConnectivityType::CellShapeTag |
| using | Connectivity = ConnectivityType |
Public Member Functions | |
| VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC | ThreadIndicesTopologyMap (vtkm::Id threadIndex, vtkm::Id inputIndex, vtkm::IdComponent visitIndex, vtkm::Id outputIndex, const ConnectivityType &connectivity) |
| const VTKM_EXEC IndicesIncidentType & | GetIndicesIncident () const |
| The indices of the incident elements. More... | |
| const VTKM_EXEC IndicesIncidentType * | GetIndicesIncidentPointer () const |
| The input indices of the incident elements in pointer form. More... | |
| VTKM_EXEC CellShapeTag | GetCellShape () const |
| The shape of the input cell. More... | |
 Public Member Functions inherited from vtkm::exec::arg::ThreadIndicesBasic | |
| VTKM_EXEC | ThreadIndicesBasic (vtkm::Id threadIndex, vtkm::Id inIndex, vtkm::IdComponent visitIndex, vtkm::Id outIndex) |
| VTKM_EXEC vtkm::Id | GetThreadIndex () const |
| The index of the thread or work invocation. More... | |
| VTKM_EXEC vtkm::Id | GetInputIndex () const |
| The index into the input domain. More... | |
| VTKM_EXEC vtkm::Id3 | GetInputIndex3D () const |
| The 3D index into the input domain. More... | |
| VTKM_EXEC vtkm::Id | GetOutputIndex () const |
| The index into the output domain. More... | |
| VTKM_EXEC vtkm::IdComponent | GetVisitIndex () const |
| The visit index. More... | |
Private Types | |
| using | Superclass = vtkm::exec::arg::ThreadIndicesBasic |
Private Attributes | |
| IndicesIncidentType | IndicesIncident |
| CellShapeTag | CellShape |
Detailed Description
template<typename ConnectivityType, typename ScatterAndMaskMode>
class vtkm::exec::arg::ThreadIndicesTopologyMap< ConnectivityType, ScatterAndMaskMode >
Container for thread indices in a topology map.
This specialization of ThreadIndices adds extra indices that deal with topology maps. In particular, it saves the incident element indices. The input and output indices from the superclass are considered to be indexing the visited elements.
This class is templated on the type that stores the connectivity (such as ConnectivityExplicit or ConnectivityStructured).
Member Typedef Documentation
◆ CellShapeTag
| using vtkm::exec::arg::ThreadIndicesTopologyMap< ConnectivityType, ScatterAndMaskMode >::CellShapeTag = typename ConnectivityType::CellShapeTag |
◆ Connectivity
| using vtkm::exec::arg::ThreadIndicesTopologyMap< ConnectivityType, ScatterAndMaskMode >::Connectivity = ConnectivityType |
◆ IndicesIncidentType
| using vtkm::exec::arg::ThreadIndicesTopologyMap< ConnectivityType, ScatterAndMaskMode >::IndicesIncidentType = typename ConnectivityType::IndicesType |
◆ Superclass
|
private |
Constructor & Destructor Documentation
◆ ThreadIndicesTopologyMap()
|
inline |
Member Function Documentation
◆ GetCellShape()
|
inline |
The shape of the input cell.
In topology maps that map from points to something, the indices make up the structure of a cell. Although the shape tag is not technically and index, it defines the meaning of the indices, so we put it here. (That and this class is the only convenient place to store it.)
◆ GetIndicesIncident()
|
inline |
The indices of the incident elements.
A topology map has "visited" and "incident" elements (e.g. points, cells, etc). For each worklet invocation, there is exactly one visited element, but there can be several incident elements. This method returns a Vec-like object containing the indices to the incident elements.
◆ GetIndicesIncidentPointer()
|
inline |
The input indices of the incident elements in pointer form.
Returns the same object as GetIndicesIncident except that it returns a pointer to the internally held object rather than a reference or copy. Since the from indices can be a sizeable Vec (8 entries is common), it is best not to have a bunch a copies. Thus, you can pass around a pointer instead. However, care should be taken to make sure that this object does not go out of scope, at which time the returned pointer becomes invalid.
Member Data Documentation
◆ CellShape
|
private |
◆ IndicesIncident
|
private |
The documentation for this class was generated from the following file:
