SpECTRE  v2021.12.06
DenseTriggers::Or Class Reference

Trigger when any of a collection of DenseTriggers triggers. More...

#include <Or.hpp>

Public Types

using is_triggered_argument_tags = tmpl::list< Tags::TimeStepId, Tags::DataBox >
 
using is_ready_argument_tags = tmpl::list< Tags::DataBox >
 

Public Member Functions

 Or (std::vector< std::unique_ptr< DenseTrigger > > triggers)
 
template<typename DbTags >
Result is_triggered (const TimeStepId &time_step_id, const db::DataBox< DbTags > &box) const
 
template<typename Metavariables , typename ArrayIndex , typename Component , typename DbTags >
bool is_ready (Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *const component, const db::DataBox< DbTags > &box) const
 
void pup (PUP::er &p) override
 
- Public Member Functions inherited from DenseTrigger
template<typename DbTags >
Result is_triggered (const db::DataBox< DbTags > &box)
 Check whether the trigger fires.
 
template<typename DbTags , typename Metavariables , typename ArrayIndex , typename Component >
bool is_ready (const db::DataBox< DbTags > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *const component) const
 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.
 
std::optional< double > previous_trigger_time () const
 Reports the value of Tags::Time when the trigger most recently fired, except for the most recent call of is_triggered. More...
 
void pup (PUP::er &p) override
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

Trigger when any of a collection of DenseTriggers triggers.

Member Data Documentation

◆ help

constexpr Options::String DenseTriggers::Or::help
staticconstexpr
Initial value:
=
"Trigger when any of a collection of triggers triggers."

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