pybamm.
ParameterValues
(values=None, chemistry=None)[source]¶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.
Parameters: |
|
---|
Examples
>>> import pybamm
>>> values = {"some parameter": 1, "another parameter": 2}
>>> param = pybamm.ParameterValues(values)
>>> param["some parameter"]
1
>>> file = "input/parameters/lithium-ion/cells/kokam_Marquis2019/parameters.csv"
>>> values_path = pybamm.get_parameters_filepath(file)
>>> param = pybamm.ParameterValues(values=values_path)
>>> param["Negative current collector thickness [m]"]
2.5e-05
>>> param = pybamm.ParameterValues(chemistry=pybamm.parameter_sets.Marquis2019)
>>> param["Reference temperature [K]"]
298.15
evaluate
(symbol)[source]¶Process and evaluate a symbol.
Parameters: | symbol (pybamm.Symbol ) – Symbol or Expression tree to evaluate |
---|---|
Returns: | The evaluated symbol |
Return type: | number of array |
find_parameter
(path)[source]¶Look for parameter file in the different locations in PARAMETER_PATH
get
(key, default=None)[source]¶Return item correspoonding to key if it exists, otherwise return default
print_evaluated_parameters
(evaluated_parameters, output_file)[source]¶Print a dictionary of evaluated parameters to an output file
Parameters: |
|
---|
print_parameters
(parameters, output_file=None)[source]¶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: |
|
---|---|
Returns: | evaluated_parameters – The evaluated parameters, for further processing if needed |
Return type: | 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
(model)[source]¶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}.
process_geometry
(geometry)[source]¶Assign parameter values to a geometry (inplace).
Parameters: | geometry (dict) – Geometry specs to assign parameter values to |
---|
process_model
(unprocessed_model, inplace=True)[source]¶Assign parameter values to a model. Currently inplace, could be changed to return a new model.
Parameters: |
|
---|---|
Raises: |
|
process_symbol
(symbol)[source]¶Walk through the symbol and replace any Parameter with a Value. If a symbol has already been processed, the stored value is returned.
Parameters: | symbol (pybamm.Symbol ) – Symbol or Expression tree to set parameters for |
---|---|
Returns: | symbol – Symbol with Parameter instances replaced by Value |
Return type: | pybamm.Symbol |
read_parameters_csv
(filename)[source]¶Reads parameters from csv file into dict.
Parameters: | filename (str) – The name of the csv file containing the parameters. |
---|---|
Returns: | {name: value} pairs for the parameters. |
Return type: | dict |
search
(key, print_values=True)[source]¶Search dictionary for keys containing ‘key’.
See pybamm.FuzzyDict.search()
.
update
(values, check_conflict=False, check_already_exists=True, path='')[source]¶Update parameter dictionary, while also performing some basic checks.
Parameters: |
|
---|