Summary Variables#
- class pybamm.SummaryVariables(solution: Solution, cycle_summary_variables: list[SummaryVariables] | None = None, esoh_solver: ElectrodeSOHSolver | None = None, user_inputs: dict[str, Any] | None = None)[source]#
Class for managing and calculating summary variables from a PyBaMM solution. Summary variables are only calculated when simulations are run with PyBaMM Experiments.
- Parameters:
solution (
pybamm.Solution
) – The solution object to be used for creating the processed variables.cycle_summary_variables (list[pybamm.SummaryVariables], optional) – A list of cycle summary variables.
esoh_solver (
pybamm.lithium_ion.ElectrodeSOHSolver
, optional) – Solver for electrode state-of-health (eSOH) calculations.user_inputs (dict, optional) – Additional user inputs for calculations.
- cycle_number#
Stores the cycle number for each saved cycle, for use when plotting. Length is equal to the number of cycles in a solution.
- Type:
array[int]