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

Suggests a step size based on the CFL stability criterion. More...

#include <Cfl.hpp>

Classes
struct	SafetyFactor

Public Types
using	options = tmpl::list< SafetyFactor >
using	argument_tags = tmpl::list< domain::Tags::MinimumGridSpacing< System::volume_dim, Frame >, ::Tags::TimeStepper< TimeStepper >, typename System::compute_largest_characteristic_speed >
using	compute_tags = tmpl::list< domain::Tags::MinimumGridSpacingCompute< System::volume_dim, Frame >, typename System::compute_largest_characteristic_speed >

Public Member Functions
	Cfl (const double safety_factor)
std::pair< double, bool >	operator() (const double minimum_grid_spacing, const TimeStepper &time_stepper, const double speed, const double last_step_magnitude) 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...
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...
template<typename StepChoosersToUse = AllStepChoosers, typename DbTags >
std::pair< double, bool >	desired_step (const double last_step_magnitude, const db::DataBox< DbTags > &box) const
	The last_step_magnitude 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 StepChooserUse, typename Frame, typename System>
class StepChoosers::Cfl< StepChooserUse, Frame, System >

Suggests a step size based on the CFL stability criterion.

Member Function Documentation

uses_local_data()

template<typename StepChooserUse , typename Frame , typename System >

bool StepChoosers::Cfl< StepChooserUse, 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_magnitude passed to the call operator is not considered local data.

Implements StepChooser< StepChooserUse >.

Member Data Documentation

help

template<typename StepChooserUse , typename Frame , typename System >

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

staticconstexpr

Initial value:

{
      "Suggests a step size based on the CFL stability criterion."}

---

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

• src/Time/StepChoosers/Cfl.hpp