pybop.models.lithium_ion.base_echem#
Classes#
Overwrites and extends BaseModel class for electrochemical PyBaMM models. |
Module Contents#
- class pybop.models.lithium_ion.base_echem.EChemBaseModel(pybamm_model, name='Electrochemical Base Model', parameter_set=None, geometry=None, submesh_types=None, var_pts=None, spatial_methods=None, solver=None, **model_kwargs)[source]#
Bases:
pybop.models.base_model.BaseModelOverwrites and extends BaseModel class for electrochemical PyBaMM models.
- Parameters:
pybamm_model (pybamm.BaseModel) – A subclass of the pybamm Base Model.
name (str, optional) – The name for the model instance, defaulting to “Electrochemical Base Model”.
parameter_set (pybamm.ParameterValues or dict, optional) – The parameters for the model. If None, default parameters provided by PyBaMM are used.
geometry (dict, optional) – The geometry definitions for the model. If None, default geometry from PyBaMM is used.
submesh_types (dict, optional) – The types of submeshes to use. If None, default submesh types from PyBaMM are used.
var_pts (dict, optional) – The discretization points for each variable in the model. If None, default points from PyBaMM are used.
spatial_methods (dict, optional) – The spatial methods used for discretization. If None, default spatial methods from PyBaMM are used.
solver (pybamm.Solver, optional) – The solver to use for simulating the model. If None, the default solver from PyBaMM is used.
**model_kwargs (optional) –
Valid PyBaMM model option keys and their values. For example, build : bool, optional
If True, the model is built upon creation (default: False).
- optionsdict, optional
A dictionary of options to customise the behaviour of the PyBaMM model.
- _check_params(inputs: pybop.models.base_model.Inputs = None, parameter_set=None, allow_infeasible_solutions=True)[source]#
Check compatibility of the model parameters.
- Parameters:
inputs (Inputs) – The input parameters for the simulation.
allow_infeasible_solutions (bool, optional) – If True, infeasible parameter values will be allowed in the optimisation (default: True).
- Returns:
A boolean which signifies whether the parameters are compatible.
- Return type:
bool
- approximate_capacity(inputs: pybop.models.base_model.Inputs)[source]#
Calculate and update an estimate for the nominal cell capacity based on the theoretical energy density and an average voltage.
The nominal capacity is computed by dividing the theoretical energy (in watt-hours) by the average open circuit potential (voltage) of the cell.
- Parameters:
inputs (Inputs) – The parameters that are the inputs of the model.
- Returns:
The nominal cell capacity is updated directly in the model’s parameter set.
- Return type:
None
- cell_mass(parameter_set=None)[source]#
Calculate the total cell mass in kilograms.
This method uses the provided parameter set to calculate the mass of different components of the cell, such as electrodes, separator, and current collectors, based on their densities, porosities, and thicknesses. It then calculates the total mass by summing the mass of each component.
- Parameters:
parameter_set (dict, optional) – A dictionary containing the parameter values necessary for the mass calculations.
- Returns:
The total mass of the cell in kilograms.
- Return type:
float
- cell_volume(parameter_set=None)[source]#
Calculate the total cell volume in m3.
This method uses the provided parameter set to calculate the total thickness of the cell including electrodes, separator, and current collectors. It then calculates the volume by multiplying by the cross-sectional area.
- Parameters:
parameter_set (dict, optional) – A dictionary containing the parameter values necessary for the volume calculation.
- Returns:
The total volume of the cell in m3.
- Return type:
float