gemseo / algos / ode

Hide inherited members

ode_result module

Result of an ODE problem.

class gemseo.algos.ode.ode_result.ODEResult(time_vector, state_vector, n_func_evaluations, n_jac_evaluations, solver_message, is_converged, solver_options, solver_name)[source]

Bases: object

The result of an ODE problem.

Parameters:

  • time_vector (NDArray[float]) –

  • state_vector (NDArray[float]) –

  • n_func_evaluations (int) –

  • n_jac_evaluations (int) –

  • solver_message (str) –

  • is_converged (bool) –

  • solver_options (dict[str, Any]) –

  • solver_name (str) –

is_converged: bool

Whether the algorithm has converged.

n_func_evaluations: int

The number of evaluations of the right-hand side.

n_jac_evaluations: int

The number of evaluations of the Jacobian of the right-hand side.

solver_message: str

The solver’s termination message.

solver_name: str

The name of the solver.

solver_options: dict[str, Any]

The options passed to the solver.

state_vector: NDArray[float]

The vector of states for the solution.

This array contains one state for each time. As such, it has one line per dimension to the state of the problem, and one column per time contained in the time vector.

time_vector: NDArray[float]

The vector of times for the solution.