StepChoosers::StepToTimes Class Reference
Suggests step sizes to place steps at specific times. More...
#include <StepToTimes.hpp>
Classes | |
| struct | Times |
Public Types | |
| using | options = tmpl::list< Times > |
| using | argument_tags = tmpl::list<::Tags::TimeStepId > |
| using | return_tags = tmpl::list<> |
Public Member Functions | |
| StepToTimes (std::unique_ptr< TimeSequence< double > > times) noexcept | |
| template<typename Metavariables > | |
| std::pair< double, bool > | operator() (const TimeStepId &time_step_id, const double last_step_magnitude, const Parallel::GlobalCache< Metavariables > &) const noexcept |
| void | pup (PUP::er &p) noexcept override |
 Public Member Functions inherited from StepChooser< StepChooserUse::Slab > | |
| WRAPPED_PUPable_abstract (StepChooser) | |
| template<typename Metavariables , typename DbTags > | |
| double | desired_slab (const double last_step_magnitude, const db::DataBox< DbTags > &box, const Parallel::GlobalCache< Metavariables > &cache) const noexcept |
The last_step_magnitude parameter describes the slab size to be adjusted; It may be infinite if the appropriate size cannot be determined. More... | |
Static Public Attributes | |
| static constexpr Options::String | help |
Detailed Description
Suggests step sizes to place steps at specific times.
The suggestion provided depends on the current time, so it should be applied immediately, rather than delayed several slabs. As changing immediately is inefficient, it may be best to use triggers to only activate this check near (within a few slabs of) the desired time.
Member Data Documentation
◆ help
|
staticconstexpr |
Initial value:
=
"Suggests step sizes to place steps at specific times.\n"
"\n"
"The suggestion provided depends on the current time, so it should\n"
"be applied immediately, rather than delayed several slabs. As\n"
"changing immediately is inefficient, it may be best to use\n"
"triggers to only activate this check near (within a few slabs of)\n"
"the desired time.\n"