pybop.problems.design_problem#

Classes#

DesignProblem

Problem class for design optimization problems.

Module Contents#

class pybop.problems.design_problem.DesignProblem(model, parameters, experiment, check_model=True, signal=['Voltage [V]'], additional_variables=[], init_soc=None)[source]#

Bases: pybop.BaseProblem

Problem class for design optimization problems.

Extends BaseProblem with specifics for applying a model to an experimental design.

Parameters:

model (object) – The model to apply the design to.
parameters (pybop.Parameter or pybop.Parameters) – An object or list of the parameters for the problem.
experiment (object) – The experimental setup to apply the model to.
check_model (bool, optional) – Flag to indicate if the model parameters should be checked for feasibility each iteration (default: True).
signal (str, optional) – The signal to fit (default: “Voltage [V]”).
additional_variables (List[str], optional) – Additional variables to observe and store in the solution (default additions are: [“Time [s]”, “Current [A]”]).
init_soc (float, optional) – Initial state of charge (default: None).

evaluate(inputs: pybop.parameters.parameter.Inputs)[source]#

Evaluate the model with the given parameters and return the signal.

Parameters:: inputs (Inputs) – Parameters for evaluation of the model.
Returns:: y – The model output y(t) simulated with inputs.
Return type:: np.ndarray