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 >

Public Member Functions
	StepToTimes (std::unique_ptr< TimeSequence< double > > times)
std::pair< double, bool >	operator() (const TimeStepId &time_step_id, 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::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...
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

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.

Member Function Documentation

uses_local_data()

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

Implements StepChooser< StepChooserUse::Slab >.

Member Data Documentation

help

constexpr Options::String StepChoosers::StepToTimes::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."

---

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

• src/Time/StepChoosers/StepToTimes.hpp