Battery Geometry

pybamm.battery_geometry(include_particles=True, options=None, current_collector_dimension=0, form_factor='pouch')

A convenience function to create battery geometries.

Parameters:

• include_particles (bool, optional) – Whether to include particle domains. Can be True (default) or False.

• options (dict, optional) – Dictionary of model options. Necessary for “particle-size geometry”, relevant for lithium-ion chemistries.

• current_collector_dimensions (int, optional) – The dimensions of the current collector. Can be 0 (default), 1 or 2. For a “cylindrical” form factor the current collector dimension must be 0 or 1.

• form_factor (str, optional) – The form factor of the cell. Can be “pouch” (default) or “cylindrical”.

Returns:

A geometry class for the battery

Return type:

pybamm.Geometry