VTK-m  2.2
List of all members
vtkm::worklet::WorkletNeighborhood::Boundary Struct Reference

The ExecutionSignature tag to query if the current iteration is inside the boundary. More...

#include <WorkletNeighborhood.h>

Inheritance diagram for vtkm::worklet::WorkletNeighborhood::Boundary:
vtkm::exec::arg::Boundary vtkm::exec::arg::ExecutionSignatureTagBase vtkm::worklet::WorkletCellNeighborhood::Boundary vtkm::worklet::WorkletPointNeighborhood::Boundary

Additional Inherited Members

- Public Types inherited from vtkm::exec::arg::Boundary
using AspectTag = vtkm::exec::arg::AspectTagBoundary
 
- Static Public Attributes inherited from vtkm::exec::arg::Boundary
static constexpr vtkm::IdComponent INDEX = 1
 

Detailed Description

The ExecutionSignature tag to query if the current iteration is inside the boundary.

This ExecutionSignature tag provides a vtkm::exec::BoundaryState object that provides information about where the local neighborhood is in relationship to the full mesh. It allows you to query whether the neighborhood of the current worklet call is completely inside the bounds of the mesh or if it extends beyond the mesh. This is important as when you are on a boundary the neighboordhood will contain empty values for a certain subset of values, and in this case the values returned will depend on the boundary behavior.


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