evolution::dg::StepChoosers::FixedLtsRatio< Dim > Class Template Reference

Requests a slab size based on the desired step in regions with a fixed slab fraction. More...

#include <FixedLtsRatio.hpp>

Classes
struct	Regions
struct	StepChoosers

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

Public Member Functions
	FixedLtsRatio (std::vector< std::unique_ptr<::StepChooser< StepChooserUse::LtsStep > > > step_choosers, std::optional< std::vector< std::string > > regions)
template<typename DbTags>
TimeStepRequest	operator() (const db::DataBox< DbTags > &box, const double) const
bool	uses_local_data () const override
	Whether the result can differ on different elements, so requiring communication to synchronize the result across the domain. This is ignored for LTS step changing.
bool	can_be_delayed () const override
	Whether the result can be applied with a delay.
bool	must_set_step_size () const override
	Whether the StepChooser's output only makes sense for setting the step size, as opposed to using it to set the slab size in an LTS evolution.
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.
void	pup (PUP::er &p) override
Public Member Functions inherited from StepChooser< StepChooserUse::Slab >
	WRAPPED_PUPable_abstract (StepChooser)
TimeStepRequest	desired_step (const double last_step, const db::DataBox< DbTags > &box) const
	The last_step parameter describes the step size to be adjusted. It may be the step size or the slab size, or may be infinite if the appropriate size cannot be determined.

Static Public Attributes
static constexpr Options::String	help

Detailed Description

template<size_t Dim>
class evolution::dg::StepChoosers::FixedLtsRatio< Dim >

Requests a slab size based on the desired step in regions with a fixed slab fraction.

Note

This StepChooser is not included in the standard_step_choosers list. Executables using the feature must include it explicitly in the factory_creation struct and add the Tags::FixedLtsRatio tag to the element DataBox.

Member Function Documentation

can_be_delayed()

template<size_t Dim>

bool evolution::dg::StepChoosers::FixedLtsRatio< Dim >::can_be_delayed ( ) const

overridevirtual

Whether the result can be applied with a delay.

StepChoosers setting the .end or .end_hard_limit fields of TimeStepRequest must return false here.

Implements StepChooser< StepChooserUse::Slab >.

must_set_step_size()

template<size_t Dim>

bool evolution::dg::StepChoosers::FixedLtsRatio< Dim >::must_set_step_size ( ) const

overridevirtual

Whether the StepChooser's output only makes sense for setting the step size, as opposed to using it to set the slab size in an LTS evolution.

This is generally true for StepChoosers that explicitly use past step sizes to compute their suggestion and false for others.

Implements StepChooser< StepChooserUse::Slab >.

tolerances()

template<size_t Dim>

std::unordered_map< std::type_index, StepperErrorTolerances > evolution::dg::StepChoosers::FixedLtsRatio< Dim >::tolerances ( ) const

overridevirtual

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.

uses_local_data()

template<size_t Dim>

bool evolution::dg::StepChoosers::FixedLtsRatio< Dim >::uses_local_data ( ) const

overridevirtual

Whether the result can differ on different elements, so requiring communication to synchronize the result across the domain. This is ignored for LTS step changing.

Note

As this is only used for slab-size changing, the last_step passed to the call operator is not considered local data.

Implements StepChooser< StepChooserUse::Slab >.

Member Data Documentation

help

template<size_t Dim>

Options::String evolution::dg::StepChoosers::FixedLtsRatio< Dim >::help

staticconstexpr

Initial value:

{
      "Requests a slab size based on the desired step in regions with a fixed "
      "slab fraction."}

---

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

• src/Evolution/DiscontinuousGalerkin/EqualRateLts/FixedLtsRatio.hpp