pybop.applications.base_method

Classes

BaseApplication	A base class for PyBOP's application methods.
Interpolant	A class that returns a pybamm.Interpolant to pybamm models and otherwise
InverseOCV	A class to find the stoichiometry corresponding to a given open-circuit

Module Contents

class pybop.applications.base_method.BaseApplication

A base class for PyBOP’s application methods.

check_monotonicity(voltage)

class pybop.applications.base_method.Interpolant(x, y, name=None, bounds_error=False, fill_value='extrapolate', axis=0)

A class that returns a pybamm.Interpolant to pybamm models and otherwise a numeric interpolant.

__call__(x)

interp1d

name = None

x

y

class pybop.applications.base_method.InverseOCV(ocv_function: Callable, optimiser: pybop.BaseOptimiser | None = pybop.SciPyMinimize, verbose: bool = False)

A class to find the stoichiometry corresponding to a given open-circuit voltage.

Parameters:

• ocv_function (Callable) – The open-circuit voltage as a function of stoichiometry.

• optimiser (pybop.BaseOptimiser, optional) – The optimisation algorithm to use (default: pybop.SciPyMinimize).

• verbose (bool, optional) – If True, progress messages are printed (default: False).

__call__(ocv_value: float)

Estimate and return the stoichiometry.

Parameters:

ocv_value (float) – The open-circuit voltage value [V] for which to estimate the stoichiometry.

Returns:

The stoichiometry corresponding to the open-circuit voltage value.

Return type:

float

ocv_function

optimiser

verbose = False