Register an observation ID with the observers. More...
#include <RegisterWithObservers.hpp>
Static Public Member Functions | |
| template<typename ParallelComponent , typename DbTagList , typename Metavariables , typename ArrayIndex > | |
| static void | perform_registration (db::DataBox< DbTagList > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index) |
| template<typename ParallelComponent , typename DbTagList , typename Metavariables , typename ArrayIndex > | |
| static void | perform_deregistration (db::DataBox< DbTagList > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index) |
| template<typename DbTagList , typename... InboxTags, typename Metavariables , typename ArrayIndex , typename ActionList , typename ParallelComponent > | |
| static Parallel::iterable_action_return_t | apply (db::DataBox< DbTagList > &box, const tuples::TaggedTuple< InboxTags... > &, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ActionList, const ParallelComponent *const) |
Register an observation ID with the observers.
The RegisterHelper passed as a template parameter must have a static register_info function that takes as its first template parameter the ParallelComponent and as function arguments a db::DataBox and the array component index. The function must return a std::pair<observers::TypeOfObservation, observers::ObservationId>
When this struct is used as an action, the apply function will perform the registration with observers. However, this struct also offers the static member functions perform_registriation and perform_deregistration that are needed for either registering when an element is added to a core outside of initialization or deregistering when an element is being eliminated from a core. The use of separate functions is necessary to provide an interface usable outside of iterable actions, e.g. in specialized pup functions.