SpECTRE  v2024.09.29
dg::Events::ObserveTimeStepVolume< VolumeDim > Class Template Reference

Observe the time step in the volume. More...

#include <ObserveTimeStepVolume.hpp>

Classes

struct  CoordinatesFloatingPointType
 The floating point type/precision with which to write the coordinates to disk. More...
 
struct  FloatingPointType
 The floating point type/precision with which to write the data to disk. More...
 
struct  SubfileName
 The name of the subfile inside the HDF5 file. More...
 

Public Types

using options = tmpl::list< SubfileName, CoordinatesFloatingPointType, FloatingPointType >
 
using compute_tags_for_observation_box = tmpl::list<>
 
using return_tags = tmpl::list<>
 
using argument_tags = tmpl::list<::Tags::Time, ::domain::Tags::FunctionsOfTime, ::domain::Tags::Domain< VolumeDim >, ::Tags::TimeStep, domain::Tags::MinimumGridSpacing< VolumeDim, Frame::Inertial > >
 
using observation_registration_tags = tmpl::list<>
 
using is_ready_argument_tags = tmpl::list<>
 

Public Member Functions

 ObserveTimeStepVolume (const std::string &subfile_name, ::FloatingPointType coordinates_floating_point_type, ::FloatingPointType floating_point_type)
 
template<typename Metavariables , typename ParallelComponent >
void operator() (const double time, const domain::FunctionsOfTimeMap &functions_of_time, const Domain< VolumeDim > &domain, const TimeDelta &time_step, const double minimum_grid_spacing, Parallel::GlobalCache< Metavariables > &cache, const ElementId< VolumeDim > &element_id, const ParallelComponent *const, const ObservationValue &observation_value) const
 
std::optional< 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. 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

template<size_t VolumeDim>
class dg::Events::ObserveTimeStepVolume< VolumeDim >

Observe the time step in the volume.

Observe the time step size in each element. Each element is output as a single cell with two points per dimension and the observation constant on all those points.

Writes volume quantities:

  • InertialCoordinates (only element corners)
  • Time step
  • Slab fraction

Member Function Documentation

◆ needs_evolved_variables()

template<size_t VolumeDim>
bool dg::Events::ObserveTimeStepVolume< VolumeDim >::needs_evolved_variables ( ) const
overridevirtual

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

template<size_t VolumeDim>
constexpr Options::String dg::Events::ObserveTimeStepVolume< VolumeDim >::help
staticconstexpr
Initial value:
=
"Observe the time step in the volume."

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