gemseo.algos.ode.scipy_ode.settings.base_scipy_ode_jac_sparsity_settings module

Settings for the SciPy ODE solvers using Jacobian with jac_sparsity.

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

Bases: BaseScipyODESolverJacSettings

Settings for the SciPy ODE solvers using Jacobian and jac_sparsity.

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.

• jac_sparsity (_NDArrayPydantic[Any, dtype[float]] | None)

Return type:

None

jac_sparsity: NDArrayPydantic[float] | None = None

Sparsity structure of the Jacobian matrix.