SpECTRE  v2024.04.12
StepChoosers::Increase< StepChooserUse > Class Template Reference

Suggests increasing the step size by a constant ratio. More...

#include <Increase.hpp>

Classes

struct  Factor
 

Public Types

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

Public Member Functions

 Increase (const double factor)
 
std::pair< double, bool > operator() (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 {"Suggests a constant factor increase."}
 

Detailed Description

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

Suggests increasing the step size by a constant ratio.

Member Function Documentation

◆ uses_local_data()

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

Implements StepChooser< StepChooserUse >.


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