RungeKutta

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

Bases: TimeStepper

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

Methods

__init__([dt, method, max_dt, tol])
calculate_tendency(mz)
disable()	Enabling the module means that it will be executed at each time step.
enable()	Enabling the module means that it will be executed at each time step.
is_enabled()	Return whether the module is enabled or not.
reset()	Stop and start the module.
setup(mset)	Start the module
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.
max_dt	Time step size.
mset	The model settings
name
required_halo

Examples using fridom.framework.time_steppers.RungeKutta

Symmetric Instability

Symmetric Instability

name = 'Runge-Kutta'

setup(mset: ModelSettingsBase) → None

Start the module

Description

This method is called by the ModelSettings.setup() and sets the ModelSettings as well as the differentiation and interpolation modules.

calculate_tendency(mz: ModelState) → StateBase

update(mz: ModelState) → None

Update the model state to the next time level.

Parameters

mzModelState

Model state.

property max_dt: timedelta64

Time step size.