gemseo.algos.ode.scipy_ode.settings.lsoda module

Settings for the LSODA ODE solver from Scipy.

Settings LSODA_Settings(*, first_step=None, max_step=inf, rtol=0.001, atol=1e-06, lband=None, uband=None, min_step=0)

Bases: BaseScipyODESolverJacSettings

Settings for the LSODA ODE solver from Scipy.

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.

• lband (int | None)

• uband (int | None)

• min_step (Annotated[int, Ge(ge=0)]) --

  By default it is set to 0.

Return type:

None

lband: int | None = None

The lower boundary of the bandwidth of the Jacobian.

The SciPy documentation does not mention what happens if None.

min_step: NonNegativeInt = 0

Minimum allowed step size.

Constraints:

• ge = 0

uband: int | None = None

The upper boundary of the bandwidth of the Jacobian.

The SciPy documentation does not mention what happens if None.

model_post_init(context, /)

We need to both initialize private attributes and call the user-defined model_post_init method.

Parameters:

• self (BaseModel)

• context (Any)

Return type:

None