VTK-m  2.0
Public Member Functions | Private Attributes | List of all members
vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType > Class Template Reference

#include <Stepper.h>

Inheritance diagram for vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType >:
vtkm::cont::ExecutionObjectBase

Public Member Functions

VTKM_CONT Stepper ()=default
 
VTKM_CONT Stepper (const EvaluatorType &evaluator, const vtkm::FloatDefault deltaT)
 
VTKM_CONT void SetTolerance (vtkm::FloatDefault tolerance)
 
VTKM_CONT auto PrepareForExecution (vtkm::cont::DeviceAdapterId device, vtkm::cont::Token &token) const -> StepperImpl< decltype(this->Integrator.PrepareForExecution(device, token)), decltype(this->Evaluator.PrepareForExecution(device, token))>
 Return the StepperImpl object Prepares the execution object of Stepper. More...
 

Private Attributes

IntegratorType Integrator
 
EvaluatorType Evaluator
 
vtkm::FloatDefault DeltaT
 
vtkm::FloatDefault Tolerance
 

Constructor & Destructor Documentation

◆ Stepper() [1/2]

template<typename IntegratorType , typename EvaluatorType >
VTKM_CONT vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType >::Stepper ( )
default

◆ Stepper() [2/2]

template<typename IntegratorType , typename EvaluatorType >
VTKM_CONT vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType >::Stepper ( const EvaluatorType &  evaluator,
const vtkm::FloatDefault  deltaT 
)
inline

Member Function Documentation

◆ PrepareForExecution()

template<typename IntegratorType , typename EvaluatorType >
VTKM_CONT auto vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType >::PrepareForExecution ( vtkm::cont::DeviceAdapterId  device,
vtkm::cont::Token token 
) const -> StepperImpl<decltype(this->Integrator.PrepareForExecution(device, token)), decltype(this->Evaluator.PrepareForExecution(device, token))>
inline

Return the StepperImpl object Prepares the execution object of Stepper.

◆ SetTolerance()

template<typename IntegratorType , typename EvaluatorType >
VTKM_CONT void vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType >::SetTolerance ( vtkm::FloatDefault  tolerance)
inline

Member Data Documentation

◆ DeltaT

template<typename IntegratorType , typename EvaluatorType >
vtkm::FloatDefault vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType >::DeltaT
private

◆ Evaluator

template<typename IntegratorType , typename EvaluatorType >
EvaluatorType vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType >::Evaluator
private

◆ Integrator

template<typename IntegratorType , typename EvaluatorType >
IntegratorType vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType >::Integrator
private

◆ Tolerance

template<typename IntegratorType , typename EvaluatorType >
vtkm::FloatDefault vtkm::worklet::flow::Stepper< IntegratorType, EvaluatorType >::Tolerance
private
Initial value:
=
std::numeric_limits<vtkm::FloatDefault>::epsilon() * static_cast<vtkm::FloatDefault>(100.0f)

The documentation for this class was generated from the following file:
vtkm::FloatDefault
vtkm::Float32 FloatDefault
The floating point type to use when no other precision is specified.
Definition: Types.h:198