RungeKutta

class fridom.framework.time_steppers.RungeKutta(dt: timedelta64 | float = 1, method: RKMethods = RKMethods.RK4, max_dt: timedelta64 | float | None = None, tol: float = 1e-06)

Bases: TimeStepper

__init__(dt: timedelta64 | float = 1, method: RKMethods = RKMethods.RK4, max_dt: timedelta64 | float | None = None, tol: float = 1e-06) → None

Methods

__init__([dt, method, max_dt, tol])
disable()	Disable the module.
enable()	Enable the module.
is_enabled()	Whether the module is enabled or not.
reset()	Stop and start the module.
setup(mset[, setup_mode])	Set the module up.
start()	Start the module.
stop()	Stop the module.
time_discretization_effect(omega)	Compute the time discretization effect on a frequency.
update(mz)	Update the model state to the next time level.

Attributes

diff_module	The differentiation module to be used by this module.
dt	Time step size.
grid	The grid of the model settings.
info	Return a dictionary with information about the time stepper.
interp_module	The interpolation module to be used by this module.
is_setup	Whether the module is set up.
max_dt	Time step size.
mset	The model settings.
name
required_halo	The required halo points for this module.

name = 'Runge-Kutta'

update(mz: ModelState) → ModelState

Update the model state to the next time level.

Parameters

mzModelState

Model state.

property max_dt: timedelta64

Time step size.