SpECTRE  v2021.11.01
control_system::Event< ControlSystems > Class Template Reference

Event for running control system measurements. More...

#include <Event.hpp>

Public Types

using compute_tags_for_observation_box = tmpl::list<>
 
using argument_tags = tmpl::list<::Tags::DataBox >
 
using is_ready_argument_tags = tmpl::list<::Tags::Time >
 

Public Member Functions

template<typename DbTags , typename Metavariables , typename ArrayIndex , typename Component >
void operator() (const db::DataBox< DbTags > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *const component) const
 
template<typename Metavariables , typename ArrayIndex , typename Component >
bool is_ready (const double time, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *const component) const
 
bool needs_evolved_variables () const override
 Whether the event uses anything depending on the evolved_variables. If this returns false, anything depending on the evolved variables may have an incorrect value when the event is run. More...
 
- Public Member Functions inherited from Event
 Event (CkMigrateMessage *msg)
 
 WRAPPED_PUPable_abstract (Event)
 
template<typename ComputeTagsList , typename DataBoxType , typename Metavariables , typename ArrayIndex , typename ComponentPointer >
void run (const ObservationBox< ComputeTagsList, DataBoxType > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ComponentPointer) const
 
template<typename DbTags , typename Metavariables , typename ArrayIndex , typename ComponentPointer >
bool is_ready (const db::DataBox< DbTags > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ComponentPointer) const
 
virtual bool needs_evolved_variables () const =0
 Whether the event uses anything depending on the evolved_variables. If this returns false, anything depending on the evolved variables may have an incorrect value when the event is run. More...
 

Static Public Attributes

static constexpr bool factory_creatable = false
 

Detailed Description

template<typename ControlSystems>
class control_system::Event< ControlSystems >

Event for running control system measurements.

This event is only intended to be used with the control_system::Trigger trigger. A specialization of this event will be created during control system initialization for each unique measurement.

These events must be added to the factory_creation struct in the metavariables, even though they cannot be created from the input file. The control_system::control_system_events metafunction provides the list of events to include.

Member Function Documentation

◆ needs_evolved_variables()

template<typename ControlSystems >
bool control_system::Event< ControlSystems >::needs_evolved_variables ( ) const
inlineoverridevirtual

Whether the event uses anything depending on the evolved_variables. If this returns false, anything depending on the evolved variables may have an incorrect value when the event is run.

Implements Event.


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