ryujin::Trigger< Number > Class Template Reference

#include <include/ryujin/interface/task.h>

Public Member Functions
	Trigger (TriggerMode mode=TriggerMode::timer_tick, unsigned int multiplier=1, Number interval=Number(0.))
	Trigger (const Trigger &)=delete
Trigger &	operator= (const Trigger &)=delete
void	add_parameters (dealii::ParameterAcceptor &acceptor, const std::string &prefix="trigger")
bool	fire (const TaskContext< Number > &context)

Detailed Description

template<typename Number = double>
class ryujin::Trigger< Number >

A Trigger decides in which cycles a task performs (part of) its work: every n-th cycle, at every n-th timer tick, after an interval of wall time, or at given time points.

A task owns a Trigger for every cadence it needs and evaluates it in Interface::Task::execute() with fire().

Definition at line 216 of file task.h.

Constructor & Destructor Documentation

Trigger() [1/2]

template<typename Number = double>

ryujin::Trigger< Number >::Trigger ( TriggerMode  mode = TriggerMode::timer_tick, unsigned int  multiplier = 1, Number  interval = Number(0.)  )

inline

Constructor.

Definition at line 222 of file task.h.

Trigger() [2/2]

template<typename Number = double>

ryujin::Trigger< Number >::Trigger ( const Trigger< Number > &  )

delete

Member Function Documentation

operator=()

template<typename Number = double>

Trigger & ryujin::Trigger< Number >::operator= ( const Trigger< Number > &  )

delete

add_parameters()

template<typename Number = double>

void ryujin::Trigger< Number >::add_parameters ( dealii::ParameterAcceptor &  acceptor, const std::string &  prefix = "trigger"  )

inline

Declare the run time parameters "<prefix>", "<prefix> multiplier", "<prefix> interval", and "<prefix> time points" in the subsection of acceptor.

Definition at line 240 of file task.h.

fire()

template<typename Number = double>

bool ryujin::Trigger< Number >::fire ( const TaskContext< Number > &  context )

inline

Return whether the trigger fires in the current cycle.

Definition at line 273 of file task.h.

References ryujin::TaskContext< Number >::cycle, ryujin::every_cycle, ryujin::Trigger< Number >::fire(), ryujin::TaskContext< Number >::t, ryujin::time_points, ryujin::TaskContext< Number >::timer_cycle, ryujin::timer_tick, ryujin::TaskContext< Number >::timer_tick, ryujin::wall_clock, and ryujin::TaskContext< Number >::wall_time.

Referenced by ryujin::Trigger< Number >::fire().

---

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

• include/ryujin/interface/task.h