SpECTRE  2021.08.02
DenseTrigger Class Reference

Base class for checking whether to run an Event at arbitrary times. More...

#include <DenseTrigger.hpp>

Classes

struct  Result
 Result type for the is_triggered method. More...
 

Public Member Functions

template<typename DbTags >
Result is_triggered (const db::DataBox< DbTags > &box) const noexcept
 Check whether the trigger fires.
 
template<typename DbTags >
bool is_ready (const db::DataBox< DbTags > &box) const noexcept
 Check whether all data required to evaluate the trigger is available. The trigger is not responsible for checking whether dense output of the evolved variables is possible, but may need to check things such as the availability of FunctionOfTime data.
 

Detailed Description

Base class for checking whether to run an Event at arbitrary times.

The DataBox passed to the member functions will have Tags::Time, and therefore any compute tags depending on that value, set to the time to be tested. Any discrete properties of steps or slabs, such as the step size, may have the values from times off by one step. The evolved variables will be in an unspecified state.