StepChoosers::Cfl< Frame, System > Class Template Reference

Sets a goal based on the CFL stability criterion. More...

#include <Cfl.hpp>

Classes
struct	SafetyFactor

Public Types
using	options = implementation defined
using	argument_tags = implementation defined
using	compute_tags = implementation defined

Public Member Functions
	Cfl (const double safety_factor)
TimeStepRequest	operator() (const double minimum_grid_spacing, const TimeStepper &time_stepper, const double speed, 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::Slab >
	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...
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. More...
Public Member Functions inherited from StepChooser< StepChooserUse::LtsStep >
	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...
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. More...

Static Public Attributes
static constexpr Options::String	help

Detailed Description

template<typename Frame, typename System>
class StepChoosers::Cfl< Frame, System >

Sets a goal based on the CFL stability criterion.

Member Function Documentation

can_be_delayed()

template<typename Frame , typename System >

bool StepChoosers::Cfl< Frame, System >::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::Slab >.

uses_local_data()

template<typename Frame , typename System >

bool StepChoosers::Cfl< Frame, System >::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::Slab >.

Member Data Documentation

help

template<typename Frame , typename System >

constexpr Options::String StepChoosers::Cfl< Frame, System >::help

staticconstexpr

Initial value:

{
      "Sets a goal based on the CFL stability criterion."}

---

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

• src/Time/StepChoosers/Cfl.hpp