dg::Events::ChangeFixedLtsRatio< Dim, StepChoosersToUse > Class Template Reference

Classes
struct	DelayChange
struct	Regions
struct	StepChoosers

Public Types
using	options = tmpl::list<StepChoosers, DelayChange, Regions>
using	compute_tags_for_observation_box = tmpl::list<>
using	return_tags = tmpl::list<::Tags::DataBox>
using	argument_tags = tmpl::list<>
using	is_ready_argument_tags = tmpl::list<>

Public Member Functions
	ChangeFixedLtsRatio (std::vector< std::unique_ptr< StepChooser< StepChooserUse::LtsStep > > > step_choosers, const uint64_t delay_change, std::optional< std::vector< std::string > > regions, const Options::Context &context={})
template<typename DbTags, typename Metavariables, typename ArrayIndex, typename ParallelComponent>
void	operator() (const gsl::not_null< db::DataBox< DbTags > * > box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ParallelComponent *const, const ObservationValue &) 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
std::unordered_map< std::type_index, StepperErrorTolerances >	tolerances () const override
	A map from the type of a variables tag to the tolerances for that variable.
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

Member Function Documentation

needs_evolved_variables()

template<size_t Dim, typename StepChoosersToUse = AllStepChoosers>

bool dg::Events::ChangeFixedLtsRatio< Dim, StepChoosersToUse >::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.

tolerances()

template<size_t Dim, typename StepChoosersToUse = AllStepChoosers>

std::unordered_map< std::type_index, StepperErrorTolerances > dg::Events::ChangeFixedLtsRatio< Dim, StepChoosersToUse >::tolerances ( ) const

inlineoverridevirtual

A map from the type of a variables tag to the tolerances for that variable.

Note

The use of std::type_index is stable in this situation because while name(), before(), and hash() are implementation defined or unspecified, the C++ standard guarantees that two std::type_index are equal only if the underlying types are equal and they are not equal if the types are different. This means we can use this safely in a std::unordered_map.

Implements RequestsStepperErrorTolerances.

Member Data Documentation

help

template<size_t Dim, typename StepChoosersToUse = AllStepChoosers>

Options::String dg::Events::ChangeFixedLtsRatio< Dim, StepChoosersToUse >::help

staticconstexpr

Initial value:

=
      "Change the number of steps per slab in regions with synchronized steps."

---

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

• src/ParallelAlgorithms/Events/ChangeFixedLtsRatio.hpp