vtkm::worklet::WorkletNeighborhood Class Reference

#include <WorkletNeighborhood.h>

Inheritance diagram for vtkm::worklet::WorkletNeighborhood:

Classes
struct	Boundary
	The ExecutionSignature tag to query if the current iteration is inside the boundary. More...
struct	CellSetIn
	A control signature tag for input connectivity. More...
struct	FieldIn
	A control signature tag for input point fields. More...
struct	FieldInNeighborhood
	A control signature tag for neighborhood input values. More...
struct	FieldInOut
	A control signature tag for input-output (in-place) point fields. More...
struct	FieldOut
	A control signature tag for output point fields. More...

Public Types
using	ScatterType = vtkm::worklet::ScatterIdentity
	All worklets must define their scatter operation. More...
using	BoundaryType = vtkm::worklet::BoundaryClamp
	All neighborhood worklets must define their boundary type operation. More...

Public Member Functions
VTKM_CONT BoundaryType	GetBoundaryCondition () const
	In addition to defining the boundary type, the worklet must produce the boundary condition. More...

Member Typedef Documentation

BoundaryType

using vtkm::worklet::WorkletNeighborhood::BoundaryType = vtkm::worklet::BoundaryClamp

All neighborhood worklets must define their boundary type operation.

The boundary type determines how loading on boundaries will work.

ScatterType

using vtkm::worklet::WorkletNeighborhood::ScatterType = vtkm::worklet::ScatterIdentity

All worklets must define their scatter operation.

Member Function Documentation

GetBoundaryCondition()

VTKM_CONT BoundaryType vtkm::worklet::WorkletNeighborhood::GetBoundaryCondition ( ) const

inline

In addition to defining the boundary type, the worklet must produce the boundary condition.

The default BoundaryClamp has no state, so just return an instance. Note: Currently only BoundaryClamp is implemented

---

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

• WorkletNeighborhood.h