utils.solver.validate_initial_state

utils.solver.validate_initial_state(
    y0,
    integrated_state_vars,
    state_variables_names,
)

Validate and normalize the initial state vector.

Parameters

y0 : array - like

Proposed initial state.

integrated_state_vars : list

Names of integrated (ODE) state variables.

state_variables_names : list

All declared state variable names.

Returns

y0_arr : ndarray

Validated, flattened float array.

Raises

: ValueError

If the length of y0 is inconsistent with the declared state variable counts.