pybamm-team · valentinsulzer · Dec 19, 2023 · Dec 19, 2023
@@ -0,0 +1,15 @@
+Discretisation
+==============
+
+The ``Discretisation`` class is used to discretise a model onto a mesh. Various spatial
+methods, geometries, and meshes are available.
+
+.. autoclass:: pybamm.Discretisation
+  :members:
+
+.. toctree::
+  :maxdepth: 2
+
+  geometry/index
+  meshes/index
+  spatial_methods/index
@@ -19,9 +19,7 @@ For a high-level introduction to PyBaMM, see the :ref:`user guide <user_guide>`
    expression_tree/index
    models/index
    parameters/index
-   geometry/index
-   meshes/index
-   spatial_methods/index
+   discretisation/index
    solvers/index
    experiment/index
    simulation

@@ -142,11 +142,11 @@
 #
 # Geometry
 #
-from .geometry.geometry import Geometry
-from .geometry.battery_geometry import battery_geometry
+from .discretisation.geometry.geometry import Geometry
+from .discretisation.geometry.battery_geometry import battery_geometry
 
 from .expression_tree.independent_variable import KNOWN_COORD_SYS
-from .geometry import standard_spatial_vars
+from .discretisation.geometry import standard_spatial_vars
 
 #
 # Parameter classes and methods
@@ -169,19 +169,18 @@
 #
 # Mesh and Discretisation classes
 #
-from .discretisations.discretisation import Discretisation
-from .discretisations.discretisation import has_bc_of_form
-from .meshes.meshes import Mesh, SubMesh, MeshGenerator
-from .meshes.zero_dimensional_submesh import SubMesh0D
-from .meshes.one_dimensional_submeshes import (
+from .discretisation.discretisation import Discretisation, has_bc_of_form
+from .discretisation.meshes.meshes import Mesh, SubMesh, MeshGenerator
+from .discretisation.meshes.zero_dimensional_submesh import SubMesh0D
+from .discretisation.meshes.one_dimensional_submeshes import (
     SubMesh1D,
     Uniform1DSubMesh,
     Exponential1DSubMesh,
     Chebyshev1DSubMesh,
     UserSupplied1DSubMesh,
     SpectralVolume1DSubMesh,
 )
-from .meshes.scikit_fem_submeshes import (
+from .discretisation.meshes.scikit_fem_submeshes import (
     ScikitSubMesh2D,
     ScikitUniform2DSubMesh,
     ScikitExponential2DSubMesh,
@@ -197,11 +196,13 @@
 #
 # Spatial Methods
 #
-from .spatial_methods.spatial_method import SpatialMethod
-from .spatial_methods.zero_dimensional_method import ZeroDimensionalSpatialMethod
-from .spatial_methods.finite_volume import FiniteVolume
-from .spatial_methods.spectral_volume import SpectralVolume
-from .spatial_methods.scikit_finite_element import ScikitFiniteElement
+from .discretisation.spatial_methods.spatial_method import SpatialMethod
+from .discretisation.spatial_methods.zero_dimensional_method import (
+    ZeroDimensionalSpatialMethod,
+)
+from .discretisation.spatial_methods.finite_volume import FiniteVolume
+from .discretisation.spatial_methods.spectral_volume import SpectralVolume
+from .discretisation.spatial_methods.scikit_finite_element import ScikitFiniteElement
 
 #
 # Solver classes

diff --git a/pybamm/discretisations/__init__.py → pybamm/discretisation/__init__.py b/pybamm/discretisations/__init__.py → pybamm/discretisation/__init__.py
diff --git a/pybamm/discretisations/discretisation.py → pybamm/discretisation/discretisation.py b/pybamm/discretisations/discretisation.py → pybamm/discretisation/discretisation.py
diff --git a/pybamm/geometry/__init__.py → pybamm/discretisation/geometry/__init__.py b/pybamm/geometry/__init__.py → pybamm/discretisation/geometry/__init__.py
diff --git a/pybamm/geometry/battery_geometry.py → ...scretisation/geometry/battery_geometry.py b/pybamm/geometry/battery_geometry.py → ...scretisation/geometry/battery_geometry.py
diff --git a/pybamm/geometry/geometry.py → pybamm/discretisation/geometry/geometry.py b/pybamm/geometry/geometry.py → pybamm/discretisation/geometry/geometry.py
diff --git a/pybamm/geometry/standard_spatial_vars.py → ...isation/geometry/standard_spatial_vars.py b/pybamm/geometry/standard_spatial_vars.py → ...isation/geometry/standard_spatial_vars.py
diff --git a/pybamm/meshes/__init__.py → pybamm/discretisation/meshes/__init__.py b/pybamm/meshes/__init__.py → pybamm/discretisation/meshes/__init__.py
diff --git a/pybamm/meshes/meshes.py → pybamm/discretisation/meshes/meshes.py b/pybamm/meshes/meshes.py → pybamm/discretisation/meshes/meshes.py
diff --git a/pybamm/meshes/one_dimensional_submeshes.py → ...ation/meshes/one_dimensional_submeshes.py b/pybamm/meshes/one_dimensional_submeshes.py → ...ation/meshes/one_dimensional_submeshes.py
diff --git a/pybamm/meshes/scikit_fem_submeshes.py → ...retisation/meshes/scikit_fem_submeshes.py b/pybamm/meshes/scikit_fem_submeshes.py → ...retisation/meshes/scikit_fem_submeshes.py
diff --git a/pybamm/meshes/zero_dimensional_submesh.py → ...sation/meshes/zero_dimensional_submesh.py b/pybamm/meshes/zero_dimensional_submesh.py → ...sation/meshes/zero_dimensional_submesh.py
diff --git a/pybamm/spatial_methods/__init__.py → ...iscretisation/spatial_methods/__init__.py b/pybamm/spatial_methods/__init__.py → ...iscretisation/spatial_methods/__init__.py
diff --git a/pybamm/spatial_methods/finite_volume.py → ...tisation/spatial_methods/finite_volume.py b/pybamm/spatial_methods/finite_volume.py → ...tisation/spatial_methods/finite_volume.py
diff --git a/.../spatial_methods/scikit_finite_element.py → .../spatial_methods/scikit_finite_element.py b/.../spatial_methods/scikit_finite_element.py → .../spatial_methods/scikit_finite_element.py
diff --git a/pybamm/spatial_methods/spatial_method.py → ...isation/spatial_methods/spatial_method.py b/pybamm/spatial_methods/spatial_method.py → ...isation/spatial_methods/spatial_method.py
diff --git a/pybamm/spatial_methods/spectral_volume.py → ...sation/spatial_methods/spectral_volume.py b/pybamm/spatial_methods/spectral_volume.py → ...sation/spatial_methods/spectral_volume.py
diff --git a/...patial_methods/zero_dimensional_method.py → ...patial_methods/zero_dimensional_method.py b/...patial_methods/zero_dimensional_method.py → ...patial_methods/zero_dimensional_method.py
diff --git a/...egration/test_spatial_methods/__init__.py → ...egration/test_discretisations/__init__.py b/...egration/test_spatial_methods/__init__.py → ...egration/test_discretisations/__init__.py
diff --git a/tests/unit/test_geometry/__init__.py → ...isations/test_spatial_methods/__init__.py b/tests/unit/test_geometry/__init__.py → ...isations/test_spatial_methods/__init__.py
diff --git a/...est_spatial_methods/test_finite_volume.py → ...est_spatial_methods/test_finite_volume.py b/...est_spatial_methods/test_finite_volume.py → ...est_spatial_methods/test_finite_volume.py
diff --git a/...t_spatial_methods/test_spectral_volume.py → ...t_spatial_methods/test_spectral_volume.py b/...t_spatial_methods/test_spectral_volume.py → ...t_spatial_methods/test_spectral_volume.py
diff --git a/tests/unit/test_meshes/__init__.py → ...discretisations/test_geometry/__init__.py b/tests/unit/test_meshes/__init__.py → ...discretisations/test_geometry/__init__.py
diff --git a/...it/test_geometry/test_battery_geometry.py → ...ns/test_geometry/test_battery_geometry.py b/...it/test_geometry/test_battery_geometry.py → ...ns/test_geometry/test_battery_geometry.py
diff --git a/tests/unit/test_spatial_methods/__init__.py → ...t_discretisations/test_meshes/__init__.py b/tests/unit/test_spatial_methods/__init__.py → ...t_discretisations/test_meshes/__init__.py
diff --git a/tests/unit/test_meshes/test_meshes.py → ...iscretisations/test_meshes/test_meshes.py b/tests/unit/test_meshes/test_meshes.py → ...iscretisations/test_meshes/test_meshes.py
diff --git a/...st_meshes/test_one_dimensional_submesh.py → ...st_meshes/test_one_dimensional_submesh.py b/...st_meshes/test_one_dimensional_submesh.py → ...st_meshes/test_one_dimensional_submesh.py
diff --git a/...it/test_meshes/test_scikit_fem_submesh.py → ...ns/test_meshes/test_scikit_fem_submesh.py b/...it/test_meshes/test_scikit_fem_submesh.py → ...ns/test_meshes/test_scikit_fem_submesh.py
diff --git a/...t_meshes/test_zero_dimensional_submesh.py → ...t_meshes/test_zero_dimensional_submesh.py b/...t_meshes/test_zero_dimensional_submesh.py → ...t_meshes/test_zero_dimensional_submesh.py
diff --git a/...al_methods/test_finite_volume/__init__.py → ...isations/test_spatial_methods/__init__.py b/...al_methods/test_finite_volume/__init__.py → ...isations/test_spatial_methods/__init__.py
diff --git a/...atial_methods/test_base_spatial_method.py → ...atial_methods/test_base_spatial_method.py b/...atial_methods/test_base_spatial_method.py → ...atial_methods/test_base_spatial_method.py
diff --git a/tests/unit/test_discretisations/test_spatial_methods/test_finite_volume/__init__.py b/tests/unit/test_discretisations/test_spatial_methods/test_finite_volume/__init__.py
diff --git a/.../test_finite_volume/test_extrapolation.py → .../test_finite_volume/test_extrapolation.py b/.../test_finite_volume/test_extrapolation.py → .../test_finite_volume/test_extrapolation.py
diff --git a/.../test_finite_volume/test_finite_volume.py → .../test_finite_volume/test_finite_volume.py b/.../test_finite_volume/test_finite_volume.py → .../test_finite_volume/test_finite_volume.py
diff --git a/...te_volume/test_ghost_nodes_and_neumann.py → ...te_volume/test_ghost_nodes_and_neumann.py b/...te_volume/test_ghost_nodes_and_neumann.py → ...te_volume/test_ghost_nodes_and_neumann.py
diff --git a/...est_finite_volume/test_grad_div_shapes.py → ...est_finite_volume/test_grad_div_shapes.py b/...est_finite_volume/test_grad_div_shapes.py → ...est_finite_volume/test_grad_div_shapes.py
diff --git a/...ds/test_finite_volume/test_integration.py → ...ds/test_finite_volume/test_integration.py b/...ds/test_finite_volume/test_integration.py → ...ds/test_finite_volume/test_integration.py
diff --git a/...ial_methods/test_scikit_finite_element.py → ...ial_methods/test_scikit_finite_element.py b/...ial_methods/test_scikit_finite_element.py → ...ial_methods/test_scikit_finite_element.py
diff --git a/...t_spatial_methods/test_spectral_volume.py → ...t_spatial_methods/test_spectral_volume.py b/...t_spatial_methods/test_spectral_volume.py → ...t_spatial_methods/test_spectral_volume.py
diff --git a/...l_methods/test_zero_dimensional_method.py → ...l_methods/test_zero_dimensional_method.py b/...l_methods/test_zero_dimensional_method.py → ...l_methods/test_zero_dimensional_method.py
diff --git a/tests/unit/test_serialisation/test_serialisation.py b/tests/unit/test_serialisation/test_serialisation.py
@@ -47,13 +47,13 @@ def mesh_var_dict():
     mesh = pybamm.Mesh(geometry, submesh_types, var_pts)
 
     mesh_json = {
-        "py/object": "pybamm.meshes.meshes.Mesh",
+        "py/object": "pybamm.discretisation.meshes.meshes.Mesh",
         "py/id": mock.ANY,
         "submesh_pts": {"negative particle": {"r": 20}},
         "base_domains": ["negative particle"],
         "sub_meshes": {
             "negative particle": {
-                "py/object": "pybamm.meshes.one_dimensional_submeshes.Uniform1DSubMesh",
+                "py/object": "pybamm.discretisation.meshes.one_dimensional_submeshes.Uniform1DSubMesh",
                 "py/id": mock.ANY,
                 "edges": [
                     0.0,