Parameter

class ionworkspipeline.Parameter(name, initial_value=None, bounds=None, normalize=True)

Parameter object for use in data fits, stores the initial value and bounds

Inherits from pybamm.InputParameter for compatibility with PyBaMM models.

Parameters

namestr

The name of the parameter.

initial_valuefloat or int, optional

The initial value to be assigned to the parameter. If not provided and bounds are given, will be set to the mean of finite bounds. Defaults to 1 if no bounds are given.

boundstuple, optional

A tuple defining the lower and upper bounds for the parameter. Defaults to (-np.inf, np.inf).

normalizebool, optional

Whether to normalize the parameter by its initial value. Defaults to True.

Extends: pybamm.expression_tree.input_parameter.InputParameter

property bounds

Returns the parameter bounds

create_copy()

Overwrite create_copy so that the fitting scale is incorporated

evaluate(*args, **kwargs)

Returns the scaled value of the parameter

property initial_value

Returns the parameter initial value

property normalized_bounds

Returns the normalized bounds

property normalized_initial_value

Returns the normalized initial value

set_bounds(value, check_initial_value=True)

Sets the parameter bounds

set_fitting_scale(normalize=True)

Sets the fitting scale for the parameter

Parameters

normalizebool, optional

Whether to normalize the parameter by its initial value. Defaults to True.