StepChoosers::LimitIncrease Class Reference

Limits step increase to a constant ratio. More...

#include <LimitIncrease.hpp>

Classes
struct	Factor

Public Types
using	options = tmpl::list<Factor>
using	argument_tags = tmpl::list<>

Public Member Functions
	LimitIncrease (double factor)
TimeStepRequest	operator() (double last_step) 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.
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.
Public Member Functions inherited from StepChooser< StepChooserUse::LtsStep >
	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

Limits step increase to a constant ratio.

Member Function Documentation

can_be_delayed()

bool StepChoosers::LimitIncrease::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()

bool StepChoosers::LimitIncrease::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 >.

uses_local_data()

bool StepChoosers::LimitIncrease::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

Options::String StepChoosers::LimitIncrease::help

staticconstexpr

Initial value:

{
      "Limits step increase to a constant ratio."}

---

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

• src/Time/StepChoosers/LimitIncrease.hpp