SpECTRE  v2025.01.30
Events and Triggers

Classes and functions related to events and triggers. More...

Namespaces

namespace  DenseTriggers
 Contains denser triggers.
 
namespace  Triggers
 Contains the available triggers.
 

Classes

class  control_system::Trigger< ControlSystems >
 Trigger for control system measurements. More...
 
struct  elliptic::Actions::RunEventsAndTriggers< ObservationId >
 Run the events and triggers. More...
 
class  elliptic::Triggers::EveryNIterations< Label >
 Trigger every N iterations of the solver identifid by the Label, after a given offset. More...
 
class  elliptic::Triggers::HasConverged< Label >
 Trigger when the solver identified by the Label has converged. More...
 
struct  evolution::Actions::RunEventsAndDenseTriggers< Postprocessors >
 Run the events and dense triggers. More...
 
struct  evolution::Actions::RunEventsAndTriggers< LocalTimeStepping >
 Run the events and triggers. More...
 
class  DenseTrigger
 Base class for checking whether to run an Event at arbitrary times. More...
 
class  DenseTriggers::Filter
 Filter activations of a dense trigger using a non-dense trigger. More...
 
class  DenseTriggers::Or
 Trigger when any of a collection of DenseTriggers triggers. More...
 
class  DenseTriggers::Times
 Trigger at specified times. More...
 
struct  Tags::PreviousTriggerTime
 Previous time at which the trigger activated. More...
 
class  EventsAndDenseTriggers
 Class that checks dense triggers and runs events. More...
 
struct  OptionTags::EventsAndDenseTriggers
 The Events to run based on DenseTriggers, similar to OptionTags::EventsAndTriggers. More...
 
struct  Tags::EventsAndDenseTriggers
 The Events to run based on DenseTriggers. More...
 
class  Events::Completion
 Sets the termination flag for the code to exit. More...
 
class  Event
 Base class for something that can happen during a simulation (such as an observation). More...
 
class  EventsAndTriggers
 Class that checks triggers and runs events. More...
 
class  Triggers::Always
 Always triggers. More...
 
class  Triggers::Not
 Negates another trigger. More...
 
class  Triggers::And
 Short-circuiting logical AND of other triggers. More...
 
class  Triggers::Or
 Short-circuiting logical OR of other triggers. More...
 
struct  OptionTags::EventsAndTriggers< WhenToCheck >
 Contains the events and triggers. More...
 
struct  Tags::EventsAndTriggers< WhenToCheck >
 Contains the events and triggers. More...
 
class  Trigger
 Base class for checking whether to run an Event. More...
 
class  Triggers::NearTimes
 Trigger in intervals surrounding particular times. More...
 
class  Triggers::OnSubsteps
 
class  Triggers::SlabCompares
 Trigger based on a comparison with the slab number. More...
 
class  Triggers::Slabs
 Trigger at specified numbers of slabs after the simulation start. More...
 
class  Triggers::StepsWithinSlab
 Trigger at specified numbers of slabs after the simulation start. More...
 
class  Triggers::TimeCompares
 Trigger based on a comparison with the time. More...
 
class  Triggers::Times
 Trigger at particular times. More...
 

Typedefs

using Triggers::time_triggers = tmpl::list< NearTimes, OnSubsteps, SlabCompares, Slabs, TimeCompares, Times >
 Typelist of Time triggers.
 

Enumerations

enum class  Triggers::WhenToCheck : uint8_t { Triggers::WhenToCheck::AtIterations , Triggers::WhenToCheck::AtSlabs , Triggers::WhenToCheck::AtSteps }
 Frequency at which Events and Triggers are checked. More...
 

Detailed Description

Classes and functions related to events and triggers.

Enumeration Type Documentation

◆ WhenToCheck

enum class Triggers::WhenToCheck : uint8_t
strong

Frequency at which Events and Triggers are checked.

Enumerator
AtIterations 

checked at iterations e.g.

of an elliptic solve

AtSlabs 

checked at time Slab boundaries

AtSteps 

checked at time step boundaries