gemseo.algos.ode.scipy_ode.settings.base_scipy_ode_settings module

Settings for the SciPy ODE solvers.

Settings BaseScipyODESolverSettings(*, first_step=None, max_step=inf, rtol=0.001, atol=1e-06)

Bases: BaseODESolverSettings

Settings for the SciPy ODE solvers.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

• first_step (Annotated[float, Gt(gt=0)] | None)

• max_step (Annotated[float, Gt(gt=0)]) --

  By default it is set to inf.

• rtol (Annotated[float, Gt(gt=0)] | _NDArrayPydantic[Any, dtype[Annotated[float, Gt(gt=0)]]]) --

  By default it is set to 0.001.

• atol (Annotated[float, Gt(gt=0)] | _NDArrayPydantic[Any, dtype[Annotated[float, Gt(gt=0)]]]) --

  By default it is set to 1e-06.

Return type:

None

atol: PositiveFloat | NDArrayPydantic[PositiveFloat] = 1e-06

The absolute tolerance.

first_step: PositiveFloat | None = None

The initial step size.

If None, let the algorithm choose.

max_step: PositiveFloat = inf

The maximum allowed step size.

Constraints:

• gt = 0

rtol: PositiveFloat | NDArrayPydantic[PositiveFloat] = 0.001

The relative tolerance.