Static Public Member Functions | List of all members
observers::Actions::RegisterWithObservers< RegisterHelper > Struct Template Reference

Register an observation ID with the observers. More...

#include <RegisterWithObservers.hpp>

Static Public Member Functions

template<typename DbTagList , typename... InboxTags, typename Metavariables , typename ArrayIndex , typename ActionList , typename ParallelComponent >
static std::tuple< db::DataBox< DbTagList > && > apply (db::DataBox< DbTagList > &box, const tuples::TaggedTuple< InboxTags... > &, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ActionList, const ParallelComponent *const) noexcept

Detailed Description

template<typename RegisterHelper>
struct observers::Actions::RegisterWithObservers< RegisterHelper >

Register an observation ID with the observers.

If registering events, you should use RegisterEventsWithObservers instead. If your event is not compatible with RegisterEventsWithObservers, please make it so.

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>

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