Doyle-Fuller-Newman (DFN)#

class pybamm.lithium_ion.DFN(options=None, name='Doyle-Fuller-Newman model', build=True)[source]#

Doyle-Fuller-Newman (DFN) model of a lithium-ion battery, from Marquis et al.[1]. See pybamm.lithium_ion.BaseModel for more details.

Examples

>>> model = pybamm.lithium_ion.DFN()
>>> model.name
'Doyle-Fuller-Newman model'

Extends: pybamm.models.full_battery_models.lithium_ion.base_lithium_ion_model.BaseModel

class pybamm.lithium_ion.BasicDFN(name='Doyle-Fuller-Newman model')[source]#

Doyle-Fuller-Newman (DFN) model of a lithium-ion battery, from Marquis et al.[1].

This class differs from the pybamm.lithium_ion.DFN model class in that it shows the whole model in a single class. This comes at the cost of flexibility in comparing different physical effects, and in general the main DFN class should be used instead.

Parameters:: name (str, optional) – The name of the model.

Extends: pybamm.models.full_battery_models.lithium_ion.base_lithium_ion_model.BaseModel

class pybamm.lithium_ion.BasicDFNComposite(name='Composite graphite/silicon Doyle-Fuller-Newman model')[source]#

Doyle-Fuller-Newman (DFN) model of a lithium-ion battery with composite particles of graphite and silicon, from Ai et al.[2].

This class differs from the pybamm.lithium_ion.DFN model class in that it shows the whole model in a single class. This comes at the cost of flexibility in comparing different physical effects, and in general the main DFN class should be used instead.

Parameters:: name (str, optional) – The name of the model.

Extends: pybamm.models.full_battery_models.lithium_ion.base_lithium_ion_model.BaseModel

property default_parameter_values#: Returns the default parameter values for the model (an empty set of parameters by default).

class pybamm.lithium_ion.BasicDFNHalfCell(options=None, name='Doyle-Fuller-Newman half cell model')[source]#

Doyle-Fuller-Newman (DFN) model of a lithium-ion battery with lithium counter electrode, adapted from Doyle et al.[3].

This class differs from the pybamm.lithium_ion.BasicDFN model class in that it is for a cell with a lithium counter electrode (half cell). This is a feature under development (for example, it cannot be used with the Experiment class for the moment) and in the future it will be incorporated as a standard model with the full functionality.

The electrode labeled “positive electrode” is the working electrode, and the electrode labeled “negative electrode” is the counter electrode. This facilitates compatibility with the full-cell models.

Parameters:

options (dict) – A dictionary of options to be passed to the model. For the half cell it should include which is the working electrode.
name (str, optional) – The name of the model.

Extends: pybamm.models.full_battery_models.lithium_ion.base_lithium_ion_model.BaseModel

class pybamm.lithium_ion.BasicDFNUnstructured(options=None, name='Doyle-Fuller-Newman model (unstructured)')[source]#

Doyle-Fuller-Newman (DFN) model discretised with FiniteVolumeUnstructured.

The "dimensionality" option is the number of directions resolved besides the through-cell x: 1 (default) meshes (x, z) with quads and 2 meshes (x, y, z) with hexahedra. Pass submesh_types to pybamm.Simulation for triangles or tetrahedra. Tetrahedra only solve on coarse meshes: on the thin cell they form sliver elements, on which the diffusion operator is unstable at the default var_pts.

Parameters:

options (dict, optional) – A dictionary of options to be passed to the model. See pybamm.BatteryModelOptions.
name (str, optional) – The name of the model.

Extends: pybamm.models.full_battery_models.lithium_ion.base_lithium_ion_model.BaseModel

property default_geometry#: Returns a dictionary of the default geometry for the model, which is empty by default.

property default_spatial_methods#: Returns a dictionary of the default spatial methods for the model, which is empty by default.

property default_submesh_types#: Returns a dictionary of the default submesh types for the model, which is empty by default.

property default_var_pts#: Returns a dictionary of the default variable points for the model, which is empty by default.

References