StepChoosers::Random< VolumeDim > Class Template Reference
Changes the step size pseudo-randomly. Values are distributed uniformly in \(\log(dt)\). The current step is always accepted. More...
#include <Random.hpp>
Classes | |
| struct | Maximum |
| struct | Minimum |
| struct | Seed |
Public Types | |
| using | options = tmpl::list< Minimum, Maximum, Seed > |
| using | argument_tags = tmpl::list< domain::Tags::Element< VolumeDim >, Tags::TimeStepId > |
Public Member Functions | |
| Random (double minimum, double maximum, size_t seed, const Options::Context &context={}) | |
| TimeStepRequest | operator() (const Element< VolumeDim > &element, const TimeStepId &time_step_id, 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<size_t VolumeDim>
class StepChoosers::Random< VolumeDim >
class StepChoosers::Random< VolumeDim >
Changes the step size pseudo-randomly. Values are distributed uniformly in \(\log(dt)\). The current step is always accepted.
- Note
- This debugging StepChooser is not included in the
standard_step_chooserslist, but can be added to thefactory_creationstruct in the metavariables.
Member Function Documentation
◆ can_be_delayed()
template<size_t VolumeDim>
|
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()
template<size_t VolumeDim>
|
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_steppassed to the call operator is not considered local data.
Implements StepChooser< StepChooserUse::Slab >.
Member Data Documentation
◆ help
template<size_t VolumeDim>
|
staticconstexpr |
Initial value:
=
"Changes the step size pseudo-randomly."
The documentation for this class was generated from the following file:
- src/Time/StepChoosers/Random.hpp