The parameter values for a simulation.
Note that this class does not inherit directly from the python dictionary class as this causes issues with saving and loading simulations.
values (dict or string) – Explicit set of parameters, or reference to a file of parameters If string and matches one of the inbuilt parameter sets, returns that parameter set. If non-matching string, gets passed to read_parameters_csv to read a file.
Examples
>>> import pybamm
>>> values = {"some parameter": 1, "another parameter": 2}
>>> param = pybamm.ParameterValues(values)
>>> param["some parameter"]
1
>>> param = pybamm.ParameterValues("Marquis2019")
>>> param["Reference temperature [K]"]
298.15
A parameter values object with the parameters in the bpx file
Process and evaluate a symbol.
symbol (pybamm.Symbol) – Symbol or Expression tree to evaluate
The evaluated symbol
number or array
Print a python script that can be used to reproduce the parameter set
name (string) – The name to save the parameter set under
old_parameters_path (string, optional) – Optional path for the location where to find the old parameters.
new_parameters_path (string, optional) – Optional path for the location where to save the new parameters.
Look for parameter file in the different locations in PARAMETER_PATH
Return item correspoonding to key if it exists, otherwise return default
Print a dictionary of evaluated parameters to an output file
evaluated_parameters (defaultdict) – The evaluated parameters, for further processing if needed
output_file (string, optional) – The file to print parameters to. If None, the parameters are not printed, and this function simply acts as a test that all the parameters can be evaluated
Return dictionary of evaluated parameters, and optionally print these evaluated parameters to an output file. For dimensionless parameters that depend on the C-rate, the value is given as a function of the C-rate (either x * Crate or x / Crate depending on the dependence)
parameters (class or dict containing pybamm.Parameter objects) – Class or dictionary containing all the parameters to be evaluated
output_file (string, optional) – The file to print parameters to. If None, the parameters are not printed, and this function simply acts as a test that all the parameters can be evaluated, and returns the dictionary of evaluated parameters.
evaluated_parameters – The evaluated parameters, for further processing if needed
defaultdict
Notes
A C-rate of 1 C is the current required to fully discharge the battery in 1 hour, 2 C is current to discharge the battery in 0.5 hours, etc
Process boundary conditions for a model Boundary conditions are dictionaries {“left”: left bc, “right”: right bc} in general, but may be imposed on the tabs (or not on the tab) for a small number of variables, e.g. {“negative tab”: neg. tab bc, “positive tab”: pos. tab bc “no tab”: no tab bc}.
Assign parameter values to a geometry (inplace).
geometry (dict) – Geometry specs to assign parameter values to
Assign parameter values to a model. Currently inplace, could be changed to return a new model.
unprocessed_model (pybamm.BaseModel) – Model to assign parameter values for
inplace (bool, optional) – If True, replace the parameters in the model in place. Otherwise, return a new model with parameter values set. Default is True.
pybamm.ModelError – If an empty model is passed (model.rhs = {} and model.algebraic = {} and model.variables = {})
Walk through the symbol and replace any Parameter with a Value. If a symbol has already been processed, the stored value is returned.
symbol (pybamm.Symbol) – Symbol or Expression tree to set parameters for
symbol – Symbol with Parameter instances replaced by Value
Set the initial stoichiometry of each electrode, based on the initial SOC or voltage
Update parameter dictionary, while also performing some basic checks.
values (dict) – Dictionary of parameter values to update parameter dictionary with
check_conflict (bool, optional) – Whether to check that a parameter in values has not already been defined in the parameter class when updating it, and if so that its value does not change. This is set to True during initialisation, when parameters are combined from different sources, and is False by default otherwise
check_already_exists (bool, optional) – Whether to check that a parameter in values already exists when trying to update it. This is to avoid cases where an intended change in the parameters is ignored due a typo in the parameter name, and is True by default but can be manually overridden.
path (string, optional) – Path from which to load functions