gemseo.algos.ode.scipy_ode.scipy_ode module#

Wrappers for SciPy's ODE solvers.

ODE stands for ordinary differential equation.

class ScipyODEAlgos(algo_name)[source]#

Bases: BaseODESolverLibrary

Wrapper for SciPy's ODE solvers.

ODE stands for ordinary differential equation.

Parameters:

algo_name (str) -- The algorithm name.

Raises:

KeyError -- When the algorithm is not in the library.

ALGORITHM_INFOS: ClassVar[dict[str, ScipyODESolverDescription]] = {'BDF': ScipyODESolverDescription(algorithm_name='BDF', internal_algorithm_name='BDF', library_name='', description='Implicit multi-step variable-order (1 to 5) method based on a backward differentiation formula for the derivative approximation', website='https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.BDF.html', Settings=<class 'gemseo.algos.ode.scipy_ode.settings.bdf.BDF_Settings'>), 'DOP853': ScipyODESolverDescription(algorithm_name='DOP853', internal_algorithm_name='DOP853', library_name='', description='Explicit Runge-Kutta method of order 8', website='https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.DOP853.html', Settings=<class 'gemseo.algos.ode.scipy_ode.settings.dop853.DOP853_Settings'>), 'LSODA': ScipyODESolverDescription(algorithm_name='LSODA', internal_algorithm_name='LSODA', library_name='', description='Adams/BDF method with automatic stiffness detection/switching', website='https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.LSODA.html', Settings=<class 'gemseo.algos.ode.scipy_ode.settings.lsoda.LSODA_Settings'>), 'RK23': ScipyODESolverDescription(algorithm_name='RK23', internal_algorithm_name='RK23', library_name='', description='Explicit Runge-Kutta method of order 3(2)', website='https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.RK23.html', Settings=<class 'gemseo.algos.ode.scipy_ode.settings.rk23.RK23_Settings'>), 'RK45': ScipyODESolverDescription(algorithm_name='RK45', internal_algorithm_name='RK45', library_name='', description='Explicit Runge-Kutta method of order 5(4)', website='https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.RK45.html', Settings=<class 'gemseo.algos.ode.scipy_ode.settings.rk45.RK45_Settings'>), 'Radau': ScipyODESolverDescription(algorithm_name='Radau', internal_algorithm_name='Radau', library_name='', description='Implicit Runge-Kutta method of the Radau IIA type of order 5', website='https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.Radau.html', Settings=<class 'gemseo.algos.ode.scipy_ode.settings.radau.Radau_Settings'>)}#

The description of the algorithms contained in the library.

class ScipyODESolverDescription(algorithm_name, internal_algorithm_name, library_name='', description='', website='', Settings=<class 'gemseo.algos.base_algorithm_settings.BaseAlgorithmSettings'>)[source]#

Bases: ODESolverDescription

The description of SciPy ODE solvers.

Parameters:

  • algorithm_name (str)

  • internal_algorithm_name (str)

  • library_name (str) --

    By default it is set to "".

  • description (str) --

    By default it is set to "".

  • website (str) --

    By default it is set to "".

  • Settings (type[BaseODESolverSettings]) --

    By default it is set to <class 'gemseo.algos.base_algorithm_settings.BaseAlgorithmSettings'>.

library_name: str = 'SciPy ODE'#

The name of the wrapped library.