Events::ObserveAdaptiveSteppingDiagnostics Class Reference

Observe diagnostics about adaptive time-stepping More...

#include <ObserveAdaptiveSteppingDiagnostics.hpp>

Classes
struct	SubfileName
	The name of the subfile inside the HDF5 file. More...

Public Types
using	options = tmpl::list<SubfileName>
using	observed_reduction_data_tags
using	compute_tags_for_observation_box = tmpl::list<>
using	return_tags = tmpl::list<>
using	argument_tags = tmpl::list<::Tags::AdaptiveSteppingDiagnostics>
using	observation_registration_tags = tmpl::list<>
using	is_ready_argument_tags = tmpl::list<>

Public Member Functions
	ObserveAdaptiveSteppingDiagnostics (const std::string &subfile_name)
template<typename ArrayIndex, typename ParallelComponent, typename Metavariables>
void	operator() (const AdaptiveSteppingDiagnostics &diags, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ParallelComponent *const, const ObservationValue &observation_value) const
std::pair< observers::TypeOfObservation, observers::ObservationKey >	get_observation_type_and_key_for_registration () 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.
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

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Observe diagnostics about adaptive time-stepping

Writes reduction quantities:

• Time
• Number of slabs
• Number of slab size changes
• Total steps on all elements
• Number of LTS step changes
• Number of step rejections

The slab information is the same on all elements. The step information is summed over the elements.

Member Typedef Documentation

observed_reduction_data_tags

using Events::ObserveAdaptiveSteppingDiagnostics::observed_reduction_data_tags

Initial value:

 
      observers::make_reduction_data_tags<tmpl::list<ReductionData>>

Member Function Documentation

needs_evolved_variables()

bool Events::ObserveAdaptiveSteppingDiagnostics::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

Options::String Events::ObserveAdaptiveSteppingDiagnostics::help

staticconstexpr

Initial value:

=
      "Observe diagnostics about adaptive time-stepping\n"
      "\n"
      "Writes reduction quantities:\n"
      " - Time\n"
      " - Number of slabs\n"
      " - Number of slab size changes\n"
      " - Total steps on all elements\n"
      " - Number of LTS step changes\n"
      " - Number of step rejections\n"
      "\n"
      "The slab information is the same on all elements.  The step\n"
      "information is summed over the elements."

---

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

• src/ParallelAlgorithms/Events/ObserveAdaptiveSteppingDiagnostics.hpp