SpECTRE
v2025.01.30
|
#include <AdamsMoultonPc.hpp>
Classes | |
struct | Order |
Public Types | |
using | options = tmpl::list< Order > |
![]() | |
using | provided_time_stepper_interfaces = tmpl::list< LtsTimeStepper, TimeStepper > |
template<typename LocalVars , typename RemoteVars , typename Coupling > | |
using | BoundaryHistoryType = TimeSteppers::BoundaryHistory< LocalVars, RemoteVars, std::invoke_result_t< const Coupling &, LocalVars, RemoteVars > > |
template<typename LocalVars , typename RemoteVars , typename Coupling > | |
using | BoundaryReturn = db::unprefix_variables< std::invoke_result_t< const Coupling &, LocalVars, RemoteVars > > |
Return type of boundary-related functions. The coupling returns the derivative of the variables, but this is multiplied by the time step so the return type should not have dt prefixes. | |
![]() | |
using | provided_time_stepper_interfaces = tmpl::list< TimeStepper > |
Public Member Functions | |
AdamsMoultonPc (size_t order) | |
AdamsMoultonPc (const AdamsMoultonPc &)=default | |
AdamsMoultonPc & | operator= (const AdamsMoultonPc &)=default |
AdamsMoultonPc (AdamsMoultonPc &&)=default | |
AdamsMoultonPc & | operator= (AdamsMoultonPc &&)=default |
size_t | order () const override |
The convergence order of the stepper. More... | |
uint64_t | number_of_substeps () const override |
Number of substeps in this TimeStepper. More... | |
uint64_t | number_of_substeps_for_error () const override |
Number of substeps in this TimeStepper when providing an error measure for adaptive time-stepping. More... | |
size_t | number_of_past_steps () const override |
Number of past time steps needed for multi-step method. More... | |
double | stable_step () const override |
Rough estimate of the maximum step size this method can take stably as a multiple of the step for Euler's method. More... | |
bool | monotonic () const override |
Whether computational and temporal orderings of operations match. More... | |
TimeStepId | next_time_id (const TimeStepId ¤t_id, const TimeDelta &time_step) const override |
The TimeStepId after the current substep. More... | |
TimeStepId | next_time_id_for_error (const TimeStepId ¤t_id, const TimeDelta &time_step) const override |
The TimeStepId after the current substep when providing an error measure for adaptive time-stepping. More... | |
bool | neighbor_data_required (const TimeStepId &next_substep_id, const TimeStepId &neighbor_data_id) const override |
Check whether a neighbor record is needed for boundary output. More... | |
bool | neighbor_data_required (double dense_output_time, const TimeStepId &neighbor_data_id) const override |
Check whether a neighbor record is needed for boundary output. More... | |
WRAPPED_PUPable_decl_template (AdamsMoultonPc) | |
AdamsMoultonPc (CkMigrateMessage *) | |
void | pup (PUP::er &p) override |
![]() | |
WRAPPED_PUPable_abstract (LtsTimeStepper) | |
template<typename LocalVars , typename RemoteVars , typename Coupling > | |
void | add_boundary_delta (const gsl::not_null< BoundaryReturn< LocalVars, RemoteVars, Coupling > * > result, const BoundaryHistoryType< LocalVars, RemoteVars, Coupling > &history, const TimeDelta &time_step, const Coupling &coupling) const |
Compute the change in a boundary quantity due to the coupling on the interface. More... | |
template<typename LocalVars , typename RemoteVars , typename CouplingResult > | |
void | clean_boundary_history (const gsl::not_null< TimeSteppers::BoundaryHistory< LocalVars, RemoteVars, CouplingResult > * > history) const |
Remove old entries from the history. More... | |
template<typename LocalVars , typename RemoteVars , typename Coupling > | |
void | boundary_dense_output (const gsl::not_null< BoundaryReturn< LocalVars, RemoteVars, Coupling > * > result, const BoundaryHistoryType< LocalVars, RemoteVars, Coupling > &history, const double time, const Coupling &coupling) const |
Derived classes must implement this as a function with signature. More... | |
![]() | |
WRAPPED_PUPable_abstract (TimeStepper) | |
template<typename Vars > | |
void | update_u (const gsl::not_null< Vars * > u, const TimeSteppers::History< Vars > &history, const TimeDelta &time_step) const |
Set u to the value at the end of the current substep. More... | |
template<typename Vars > | |
std::optional< StepperErrorEstimate > | update_u (const gsl::not_null< Vars * > u, const TimeSteppers::History< Vars > &history, const TimeDelta &time_step, const std::optional< StepperErrorTolerances > &tolerances) const |
Set u to the value at the end of the current substep; report the error measure when available. More... | |
template<typename Vars > | |
void | clean_history (const gsl::not_null< TimeSteppers::History< Vars > * > history) const |
Remove old entries from the history. More... | |
template<typename Vars > | |
bool | dense_update_u (const gsl::not_null< Vars * > u, const TimeSteppers::History< Vars > &history, const double time) const |
Compute the solution value at a time between steps. To evaluate at a time within a given step, call this method at the start of the step containing the time. The function returns true on success, otherwise the call should be retried after the next substep. More... | |
virtual size_t | order () const =0 |
The convergence order of the stepper. More... | |
virtual uint64_t | number_of_substeps () const =0 |
Number of substeps in this TimeStepper. More... | |
virtual uint64_t | number_of_substeps_for_error () const =0 |
Number of substeps in this TimeStepper when providing an error measure for adaptive time-stepping. More... | |
virtual size_t | number_of_past_steps () const =0 |
Number of past time steps needed for multi-step method. More... | |
virtual double | stable_step () const =0 |
Rough estimate of the maximum step size this method can take stably as a multiple of the step for Euler's method. More... | |
virtual bool | monotonic () const =0 |
Whether computational and temporal orderings of operations match. More... | |
virtual TimeStepId | next_time_id (const TimeStepId ¤t_id, const TimeDelta &time_step) const =0 |
The TimeStepId after the current substep. More... | |
virtual TimeStepId | next_time_id_for_error (const TimeStepId ¤t_id, const TimeDelta &time_step) const =0 |
The TimeStepId after the current substep when providing an error measure for adaptive time-stepping. More... | |
template<typename Vars > | |
bool | can_change_step_size (const TimeStepId &time_id, const TimeSteppers::History< Vars > &history) const |
Whether a change in the step size is allowed before taking a step. Step sizes can never be changed on a substep. More... | |
Static Public Member Functions | |
static std::string | name () |
Static Public Attributes | |
static constexpr size_t | minimum_order = 2 |
static constexpr size_t | maximum_order = 8 |
static constexpr Options::String | help |
![]() | |
static constexpr bool | local_time_stepping = true |
![]() | |
static constexpr bool | local_time_stepping = false |
static constexpr bool | imex = false |
An \(N\\)th order Adams-Moulton predictor-corrector method using an \f$(N - 1)$th order Adams-Bashforth predictor.
If Monotonic
is true, dense output is performed using the predictor stage, otherwise the corrector is used. The corrector results are more accurate (but still formally the same order), but require a RHS evaluation at the end of the step before dense output can be performed.
The stable step size factors for different orders are (to approximately 4-5 digits):
Order | CFL Factor |
---|---|
2 | 1 |
3 | 0.981297 |
4 | 0.794227 |
5 | 0.612340 |
6 | 0.464542 |
7 | 0.350596 |
8 | 0.264373 |
|
overridevirtual |
Whether computational and temporal orderings of operations match.
If this method returns true, then, for two time-stepper operations occurring at different simulation times, the temporally earlier operation will be performed first. These operations include RHS evaluation, dense output, and neighbor communication. In particular, dense output never requires performing a RHS evaluation later than the output time, so control systems measurements cannot cause deadlocks.
Implements TimeStepper.
|
overridevirtual |
Check whether a neighbor record is needed for boundary output.
In order to perform boundary output, all records from the neighbor with TimeStepId
s for which this method returns true should have been added to the history. Versions are provided for a substep and for dense output.
Implements LtsTimeStepper.
|
overridevirtual |
Check whether a neighbor record is needed for boundary output.
In order to perform boundary output, all records from the neighbor with TimeStepId
s for which this method returns true should have been added to the history. Versions are provided for a substep and for dense output.
Implements LtsTimeStepper.
|
overridevirtual |
The TimeStepId after the current substep.
Implements TimeStepper.
|
overridevirtual |
The TimeStepId after the current substep when providing an error measure for adaptive time-stepping.
Certain substep methods (e.g. embedded RK4(3)) require additional steps when providing an error measure of the integration.
Implements TimeStepper.
|
overridevirtual |
Number of past time steps needed for multi-step method.
Implements TimeStepper.
|
overridevirtual |
Number of substeps in this TimeStepper.
Implements TimeStepper.
|
overridevirtual |
Number of substeps in this TimeStepper when providing an error measure for adaptive time-stepping.
Certain substep methods (e.g. embedded RK4(3)) require additional steps when providing an error measure of the integration.
Implements TimeStepper.
|
overridevirtual |
The convergence order of the stepper.
Implements TimeStepper.
|
overridevirtual |
Rough estimate of the maximum step size this method can take stably as a multiple of the step for Euler's method.
Implements TimeStepper.
|
staticconstexpr |