VTK-m  2.0
Public Types | Public Member Functions | Private Attributes | List of all members
vtkm::worklet::AveragePointNeighborhood Class Reference

#include <AveragePointNeighborhood.h>

Inheritance diagram for vtkm::worklet::AveragePointNeighborhood:
vtkm::worklet::WorkletPointNeighborhood vtkm::worklet::WorkletNeighborhood vtkm::exec::FunctorBase

Public Types

using ControlSignature = void(CellSetIn cellSet, FieldInNeighborhood inputField, FieldOut outputField)
 
using ExecutionSignature = _3(_2, Boundary)
 
using InputDomain = _1
 
- Public Types inherited from vtkm::worklet::WorkletPointNeighborhood
template<typename Worklet >
using Dispatcher = vtkm::worklet::DispatcherPointNeighborhood< Worklet >
 
template<bool Cond, typename ReturnType >
using EnableFnWhen = typename std::enable_if< Cond, ReturnType >::type
 
- Public Types inherited from vtkm::worklet::WorkletNeighborhood
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

 AveragePointNeighborhood (vtkm::IdComponent radius)
 
template<typename InputFieldPortalType >
VTKM_EXEC InputFieldPortalType::ValueType operator() (const vtkm::exec::FieldNeighborhood< InputFieldPortalType > &inputField, const vtkm::exec::BoundaryState &boundary) const
 
- Public Member Functions inherited from vtkm::worklet::WorkletPointNeighborhood
template<typename OutToInArrayType , typename VisitArrayType , typename ThreadToOutArrayType , vtkm::IdComponent Dimension>
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC vtkm::exec::arg::ThreadIndicesPointNeighborhood GetThreadIndices (vtkm::Id threadIndex, const OutToInArrayType &outToIn, const VisitArrayType &visit, const ThreadToOutArrayType &threadToOut, const vtkm::exec::ConnectivityStructured< vtkm::TopologyElementTagPoint, vtkm::TopologyElementTagCell, Dimension > &inputDomain) const
 Point neighborhood worklets use the related thread indices class. More...
 
template<typename OutToInArrayType , typename VisitArrayType , typename ThreadToOutArrayType , typename InputDomainType , bool S = IsScatterIdentity, bool M = IsMaskNone>
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC EnableFnWhen< S &&M, vtkm::exec::arg::ThreadIndicesPointNeighborhoodGetThreadIndices (vtkm::Id threadIndex1D, const vtkm::Id3 &threadIndex3D, const OutToInArrayType &vtkmNotUsed(outToIn), const VisitArrayType &vtkmNotUsed(visit), const ThreadToOutArrayType &vtkmNotUsed(threadToOut), const InputDomainType &connectivity) const
 
template<typename OutToInArrayType , typename VisitArrayType , typename ThreadToOutArrayType , typename InputDomainType , bool S = IsScatterIdentity, bool M = IsMaskNone>
VTKM_SUPPRESS_EXEC_WARNINGS VTKM_EXEC EnableFnWhen<!(S &&M), vtkm::exec::arg::ThreadIndicesPointNeighborhoodGetThreadIndices (vtkm::Id threadIndex1D, const vtkm::Id3 &threadIndex3D, const OutToInArrayType &outToIn, const VisitArrayType &visit, const ThreadToOutArrayType &threadToOut, const InputDomainType &connectivity) const
 
- Public Member Functions inherited from vtkm::worklet::WorkletNeighborhood
VTKM_CONT BoundaryType GetBoundaryCondition () const
 In addition to defining the boundary type, the worklet must produce the boundary condition. More...
 

Private Attributes

vtkm::IdComponent BoundaryRadius
 

Member Typedef Documentation

◆ ControlSignature

◆ ExecutionSignature

◆ InputDomain

Constructor & Destructor Documentation

◆ AveragePointNeighborhood()

vtkm::worklet::AveragePointNeighborhood::AveragePointNeighborhood ( vtkm::IdComponent  radius)
inline

Member Function Documentation

◆ operator()()

template<typename InputFieldPortalType >
VTKM_EXEC InputFieldPortalType::ValueType vtkm::worklet::AveragePointNeighborhood::operator() ( const vtkm::exec::FieldNeighborhood< InputFieldPortalType > &  inputField,
const vtkm::exec::BoundaryState boundary 
) const
inline

Member Data Documentation

◆ BoundaryRadius

vtkm::IdComponent vtkm::worklet::AveragePointNeighborhood::BoundaryRadius
private

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