Event that will collect the size in MBs used by each DataBox item on each parallel component. More...

#include <ObserveDataBox.hpp>

Classes
struct	WriteTagNamesToFile

Public Types
using	options = implementation defined

using	compute_tags_for_observation_box = implementation defined

using	return_tags = implementation defined

using	argument_tags = implementation defined

using	is_ready_argument_tags = implementation defined

Public Member Functions
	ObserveDataBox (std::optional< std::string > file_name_for_tag_names)

template<typename DataBoxType , size_t VolumeDim, typename ParallelComponent , typename Metavariables , typename ComputeTagsList >
void	operator() (const ObservationBox< DataBoxType, ComputeTagsList > &box, Parallel::GlobalCache< Metavariables > &, const ElementId< VolumeDim > &array_index, const ParallelComponent *, 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

Event that will collect the size in MBs used by each DataBox item on each parallel component.

Details

The data will be written to disk in the reductions file under the /DataBoxSizeInMb/ group. The name of each file is the pretty_type::name of each parallel component. There will be a column for each item in the DataBox that is not a subitem or reference item.

Member Function Documentation

◆ needs_evolved_variables()

bool Events::ObserveDataBox::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::ObserveDataBox::help

staticconstexpr

Initial value:

= {
      "Observe size (in MB) of each item (except reference items) in each "
      "DataBox"}

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

src/ParallelAlgorithms/Events/ObserveDataBox.hpp

Classes

Public Types

Public Member Functions