pybamm.
Geometry
(*geometries, custom_geometry={})[source]¶A geometry class to store the details features of the cell geometry.
Geometry extends the class dictionary and uses the key words: “negative electrode”, “positive electrode”, etc to indicate the subdomain. Within each subdomain, there are “primary”, “secondary” or “tabs” dimensions. “primary” dimensions correspond to dimensions on which spatial operators will be applied (e.g. the gradient and divergence). In contrast, spatial operators do not act along “secondary” dimensions. This allows for multiple independent particles to be included into a model.
The values assigned to each domain are dictionaries containing the spatial variables in that domain, along with expression trees giving their min and maximum extents. For example, the following dictionary structure would represent a Geometry with a single domain “negative electrode”, defined using the variable x_n which has a range from 0 to the predefined parameter l_n.
{
"negative electrode": {
"primary": {x_n: {"min": pybamm.Scalar(0), "max": l_n}}
}
}
A user can create a new Geometry by combining one or more of the predefined geometries defined with the names given below.
Extends: dict
Parameters: 


pybamm.
Geometry1DMacro
(custom_geometry={})[source]¶A geometry class to store the details features of the macroscopic 1D cell geometry.
Extends: Geometry
Parameters:  custom_geometry (dict containing any extra user defined geometry) – 

pybamm.
Geometry3DMacro
(custom_geometry={})[source]¶A geometry class to store the details features of the macroscopic 3D cell geometry.
Extends: Geometry1DMacro
Parameters:  custom_geometry (dict containing any extra user defined geometry) – 

pybamm.
Geometry1DMicro
(custom_geometry={})[source]¶A geometry class to store the details features of the microscopic 1D particle geometry.
Extends: Geometry
Parameters:  custom_geometry (dict containing any extra user defined geometry) – 

pybamm.
Geometry1p1DMicro
(custom_geometry={})[source]¶A geometry class to store the details features of the 1+1D cell geometry. This is the geometry used in the standard DFN or P2D model.
Extends: Geometry
Parameters:  custom_geometry (dict containing any extra user defined geometry) – 

pybamm.
Geometryxp1DMacro
(cc_dimension=1, custom_geometry={})[source]¶A geometry class to store the details features of x+1D macroscopic cell geometry, where x is the dimension of the current collector model.
Extends: Geometry1DMacro
Parameters: 

pybamm.
Geometryxp0p1DMicro
(cc_dimension=1, custom_geometry={})[source]¶A geometry class to store the details features of x+0D macroscopic cell geometry, where x is the dimension of the current collector model, along with the microscopic 1D particle geometry.
Extends: Geometry1DMicro
Parameters: 

pybamm.
Geometryxp1p1DMicro
(cc_dimension=1, custom_geometry={})[source]¶A geometry class to store the details features of x+1D macroscopic cell geometry, where x is the dimension of the current collector model, along with the microscopic 1D particle geometry.
Extends: Geometry1DMicro
Parameters: 
