SpECTRE  v2025.01.30
StepChoosers::Maximum Class Reference

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

#include <Maximum.hpp>

Public Types

using argument_tags = tmpl::list<>
 

Public Member Functions

 Maximum (double value)
 
std::pair< TimeStepRequest, bool > 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. 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...
 
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...
 
- 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...
 
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

Limits the step size to a constant.

Member Function Documentation

◆ can_be_delayed()

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

◆ uses_local_data()

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


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