Events::Completion Class Reference

Sets the termination flag for the code to exit. More...

#include <Completion.hpp>

Public Types
using	compute_tags_for_observation_box = tmpl::list<>
using	options = tmpl::list<>
using	argument_tags = tmpl::list<>
using	is_ready_argument_tags = tmpl::list<>

Public Member Functions
template<typename Metavariables , typename ArrayIndex , typename Component >
void	operator() (Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *const) const
template<typename Metavariables , typename ArrayIndex , typename Component >
bool	is_ready (Parallel::GlobalCache< Metavariables > &, const ArrayIndex &, const Component *const) 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 Options::String	help

Detailed Description

Sets the termination flag for the code to exit.

Member Function Documentation

needs_evolved_variables()

bool Events::Completion::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.

Member Data Documentation

help

constexpr Options::String Events::Completion::help

staticconstexpr

Initial value:

= {
      "Sets the termination flag for the code to exit."}

---

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

• src/ParallelAlgorithms/EventsAndTriggers/Completion.hpp