Battery Geometry

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

A convenience function to create battery geometries.

Parameters

• include_particles (bool) – Whether to include particle domains

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

• current_collector_dimensions (int, default) – The dimensions of the current collector. Should be 0 (default), 1 or 2

Returns

A geometry class for the battery

Return type

pybamm.Geometry