pybop.models.lithium_ion.base_echem#

Classes#

EChemBaseModel

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, eis=False, **model_kwargs)[source]#

Bases: pybop.models.base_model.BaseModel

Overwrites 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.

  • eis (bool, optional) – A flag to build the forward model for EIS predictions. Defaults to False.

  • **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, parameter_set: pybop.parameters.parameter_set.ParameterSet, allow_infeasible_solutions: bool = True)[source]#

Check compatibility of the model parameters.

Parameters:

  • inputs (Inputs) – The input parameters for the simulation.

  • parameter_set (pybop.ParameterSet) – A PyBOP parameter set object or a dictionary containing the parameter values.

  • 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

_set_initial_state(initial_state: dict, inputs: pybop.models.base_model.Inputs | None = None)[source]#

Set the initial state of charge or concentrations for the battery model.

Parameters:

  • initial_state (dict) – A valid initial state, e.g. the initial state of charge or open-circuit voltage.

  • inputs (Inputs) – The input parameters to be used when building the model.

approximate_capacity(parameter_set: pybop.parameters.parameter_set.ParameterSet | None = None)[source]#

Calculate an estimate for the nominal cell capacity. The estimate is computed by estimating the capacity of the positive electrode that lies between the stoichiometric limits corresponding to the upper and lower voltage limits.

Parameters:

parameter_set (dict, optional) – A dictionary containing the parameter values necessary for the calculation.

Returns:

The estimate of the nominal cell capacity [A.h].

Return type:

float

cell_mass(parameter_set: pybop.parameters.parameter_set.ParameterSet | None = 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 calculation.

Returns:

The total mass of the cell in kilograms.

Return type:

float

cell_volume(parameter_set: pybop.parameters.parameter_set.ParameterSet | None = 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 calculation.

Returns:

The total volume of the cell in m3.

Return type:

float

set_geometric_parameters()[source]#

Sets the parameters that can be changed when rebuilding the model.

Returns:

A dictionary of parameters that can be changed when rebuilding the model.

Return type:

dict

_built_initial_soc = None[source]#
_built_model = None[source]#
_disc = None[source]#
_electrode_soh[source]#
_electrode_soh_half_cell[source]#
_geometry[source]#
_mesh = None[source]#
_model_with_set_params = None[source]#
_parameter_set[source]#
_spatial_methods[source]#
_submesh_types[source]#
_unprocessed_model[source]#
_unprocessed_parameter_set[source]#
_var_pts[source]#
default_parameter_values[source]#
geometric_parameters[source]#
pybamm_model[source]#