StepChoosers::Maximum< StepChooserUse > Class Template Reference

Limits the step size to a constant. More...

#include <Maximum.hpp>

Public Types
using	argument_tags = tmpl::list<>

Public Member Functions
	Maximum (const double value)
std::pair< TimeStepRequest, bool >	operator() (const 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. More...
bool	can_be_delayed () const override
	Whether the result can be applied with a delay. More...
void	pup (PUP::er &p) override
Public Member Functions inherited from StepChooser< StepChooserUse >
	WRAPPED_PUPable_abstract (StepChooser)
virtual bool	uses_local_data () const =0
	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. More...
virtual bool	can_be_delayed () const =0
	Whether the result can be applied with a delay. More...
template<typename StepChoosersToUse = AllStepChoosers, typename DbTags >
std::pair< TimeStepRequest, bool >	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. More...

Static Public Attributes
static constexpr Options::String	help {"Limits the step size to a constant."}

Detailed Description

template<typename StepChooserUse>
class StepChoosers::Maximum< StepChooserUse >

Limits the step size to a constant.

Member Function Documentation

can_be_delayed()

template<typename StepChooserUse >

bool StepChoosers::Maximum< StepChooserUse >::can_be_delayed ( ) const

inlineoverridevirtual

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 >.

uses_local_data()

template<typename StepChooserUse >

bool StepChoosers::Maximum< StepChooserUse >::uses_local_data ( ) const

inlineoverridevirtual

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 >.

---

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

• src/Time/StepChoosers/Maximum.hpp