Cce::Events::ObserveTimeStep Class Reference
Observe the size of the time steps on the characteristic evolution. More...
#include <ObserveTimeStep.hpp>
Classes | |
| struct | PrintTimeToTerminal |
| struct | SubfileName |
| The name of the subfile inside the HDF5 file. More... | |
Public Types | |
| using | options = tmpl::list< SubfileName, PrintTimeToTerminal > |
| using | observed_reduction_data_tags = tmpl::list<> |
| using | compute_tags_for_observation_box = tmpl::list<> |
| using | return_tags = tmpl::list<> |
| using | argument_tags = tmpl::list<::Tags::TimeStep > |
| using | is_ready_argument_tags = tmpl::list<> |
Public Member Functions | |
| ObserveTimeStep (const std::string &subfile_name, const bool output_time) | |
| template<typename ArrayIndex , typename ParallelComponent , typename Metavariables > | |
| void | operator() (const TimeDelta &time_step, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &, const ParallelComponent *const, const ObservationValue &observation_value) 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... | |
| void | pup (PUP::er &p) override |
 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 gsl::not_null< ObservationBox< ComputeTagsList, DataBoxType > * > box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ComponentPointer, const ObservationValue &observation_value) 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
Observe the size of the time steps on the characteristic evolution.
Writes reduction quantities:
TimeTime Step
The subfile will be written into the /Cce subgroup.
Member Function Documentation
◆ needs_evolved_variables()
|
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
|
staticconstexpr |
Initial value:
=
"Observe the size of the time step for the characteristic evolution.\n"
"\n"
"Writes quantities:\n"
"- Time\n"
"- Time Step\n"
"\n"
"The subfile will be written into the subgroup '/Cce'."
The documentation for this class was generated from the following file:
- src/Evolution/Systems/Cce/Events/ObserveTimeStep.hpp