Event Class Reference

Base class for something that can happen during a simulation (such as an observation). More...

#include <Event.hpp>

Public Member Functions
	Event (CkMigrateMessage *msg) noexcept
	WRAPPED_PUPable_abstract (Event)
template<typename DbTags , typename Metavariables , typename ArrayIndex , typename ComponentPointer >
void	run (const db::DataBox< DbTags > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ComponentPointer) const noexcept
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 noexcept
virtual bool	needs_evolved_variables () const noexcept=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...

Detailed Description

Base class for something that can happen during a simulation (such as an observation).

Member Function Documentation

needs_evolved_variables()

virtual bool Event::needs_evolved_variables ( ) const

pure virtualnoexcept

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.

Implemented in dg::Events::ObserveErrorNorms< ObservationValueTag, tmpl::list< Tensors... > >, dg::Events::ObserveFields< VolumeDim, ObservationValueTag, tmpl::list< Tensors... >, tmpl::list< AnalyticSolutionTensors... >, tmpl::list< NonSolutionTensors... > >, Events::ObserveNorms< tmpl::list< ObservableTensorTags... > >, Events::ObserveTimeStep< System >, dg::Events::ObserveVolumeIntegrals< VolumeDim, ObservationValueTag, tmpl::list< Tensors... > >, Events::Completion, and Events::ChangeSlabSize.