Rename mesh.points -> mesh.cells

discretisedfield/field.py

@@ -3565,7 +3565,7 @@ def _hv_key_dims(self):
         key_dims = {
             dim: hv_key_dim(coords, unit)
             for dim, unit in zip(self.mesh.region.dims, self.mesh.region.units)
-            if len(coords := getattr(self.mesh.points, dim)) > 1
+            if len(coords := getattr(self.mesh.cells, dim)) > 1
         }
         if self.nvdim > 1:
             key_dims["vdims"] = hv_key_dim(self.vdims, "")
@@ -4065,7 +4065,7 @@ def to_xarray(self, name="field", unit=None):
 
         axes = self.mesh.region.dims
 
-        data_array_coords = {axis: getattr(self.mesh.points, axis) for axis in axes}
+        data_array_coords = {axis: getattr(self.mesh.cells, axis) for axis in axes}
 
         geo_units_dict = dict(zip(axes, self.mesh.region.units))
 
@@ -4314,7 +4314,7 @@ def _(val, mesh, nvdim, dtype):
     value = (
         val.to_xarray()
         .sel(
-            **{dim: getattr(mesh.points, dim) for dim in mesh.region.dims},
+            **{dim: getattr(mesh.cells, dim) for dim in mesh.region.dims},
             method="nearest",
         )
         .data

discretisedfield/mesh.py

@@ -170,7 +170,7 @@ class Mesh(_MeshIO):
     # removed attribute: new method/property
     # implemented in __getattr__
     # to exclude methods from tap completion and documentation
-    _removed_attributes = {"midpoints": "points"}
+    _removed_attributes = {"midpoints": "cells", "points": "cells"}
 
     def __init__(
         self,
@@ -487,12 +487,12 @@ def __iter__(self):
         yield from map(self.index2point, self.indices)
 
     @property
-    def points(self):
-        """Midpoints of the cells of the mesh along the three directions.
+    def cells(self):
+        """Midpoints of the cells of the mesh along the spatial directions.
 
-        This method returns a named tuple containing three numpy arrays with
-        midpoints of the cells along the three spatial directions. Individual directions
-        can be accessed from the tuple.
+        This method returns a named tuple containing numpy arrays with midpoints of the
+        cells along the spatial directions. Individual directions can be accessed from
+        the tuple.
 
         Returns
         -------
@@ -512,13 +512,13 @@ def points(self):
         >>> cell = (2, 1, 1)
         >>> mesh = df.Mesh(region=df.Region(p1=p1, p2=p2), cell=cell)
         ...
-        >>> mesh.points.x
+        >>> mesh.cells.x
         array([1., 3., 5., 7., 9.])
 
         """
-        points = collections.namedtuple("points", self.region.dims)
+        cells = collections.namedtuple("cells", self.region.dims)
 
-        return points(
+        return cells(
             *(
                 np.linspace(pmin + cell / 2, pmax - cell / 2, n)
                 for pmin, pmax, cell, n in zip(
@@ -529,11 +529,11 @@ def points(self):
 
     @property
     def vertices(self):
-        """Vertices of the cells of the mesh along the three directions.
+        """Vertices of the cells of the mesh along the spatial directions.
 
-        This method returns a named tuple containing three numpy arrays with
-        vertices of the cells along the spatial directions. Individual directions can be
-        accessed from the tuple.
+        This method returns a named tuple containing numpy arrays with vertices of the
+        cells along the spatial directions. Individual directions can be accessed from
+        the tuple.
 
         Returns
         -------
@@ -2161,8 +2161,8 @@ def coordinate_field(self):
             vdim_mapping=dict(zip(self.region.dims, self.region.dims)),
         )
         for i, dim in enumerate(self.region.dims):
-            points = self.points  # avoid re-computing points
-            field.array[..., i] = getattr(points, dim).reshape(
+            cells = self.cells  # avoid re-computing cells
+            field.array[..., i] = getattr(cells, dim).reshape(
                 tuple(self.n[i] if i == j else 1 for j in range(self.region.ndim))
             )
 

discretisedfield/plotting/mpl_field.py

@@ -630,8 +630,8 @@ def vector(
 
         multiplier = self._setup_multiplier(multiplier)
 
-        points1 = self.field.mesh.points[0] / multiplier
-        points2 = self.field.mesh.points[1] / multiplier
+        points1 = self.field.mesh.cells[0] / multiplier
+        points2 = self.field.mesh.cells[1] / multiplier
 
         values = self.field.array.copy()
         self._filter_values(self.field._valid_as_field, values)
@@ -815,8 +815,8 @@ def contour(
 
         multiplier = self._setup_multiplier(multiplier)
 
-        points1 = self.field.mesh.points[0] / multiplier
-        points2 = self.field.mesh.points[1] / multiplier
+        points1 = self.field.mesh.cells[0] / multiplier
+        points2 = self.field.mesh.cells[1] / multiplier
 
         values = self.field.array.copy().reshape(self.field.mesh.n)
 

discretisedfield/tests/test_field.py

@@ -1854,10 +1854,10 @@ def test_diff_valid():
     f = df.Field(mesh, nvdim=1, value=lambda p: p[0] ** 2, valid=valid)
 
     assert np.allclose(f.diff("x").array[:3], 0)
-    assert np.allclose(f.diff("x").array[3:6, 0], 2 * f.mesh.points[0][3:6])
+    assert np.allclose(f.diff("x").array[3:6, 0], 2 * f.mesh.cells[0][3:6])
     assert np.allclose(f.diff("x").array[6:], 0)
     assert np.allclose(
-        f.diff("x", restrict2valid=False).array[..., 0], 2 * f.mesh.points[0]
+        f.diff("x", restrict2valid=False).array[..., 0], 2 * f.mesh.cells[0]
     )
 
     # 3d mesh
@@ -3972,7 +3972,7 @@ def test_to_xarray_valid_args_vector(valid_mesh, value, dtype):
     assert np.allclose(fxa.attrs["pmax"], f.mesh.region.pmax)
     assert np.allclose(fxa.attrs["tolerance_factor"], f.mesh.region.tolerance_factor)
     for i in f.mesh.region.dims:
-        assert np.array_equal(getattr(f.mesh.points, i), fxa[i].values)
+        assert np.array_equal(getattr(f.mesh.cells, i), fxa[i].values)
         assert fxa[i].attrs["units"] == f.mesh.region.units[f.mesh.region.dims.index(i)]
     assert all(fxa["vdims"].values == f.vdims)
     assert np.array_equal(f.array, fxa.values)
@@ -3996,7 +3996,7 @@ def test_to_xarray_valid_args_scalar(valid_mesh, value, dtype):
     assert np.allclose(fxa.attrs["pmax"], f.mesh.region.pmax)
     assert np.allclose(fxa.attrs["tolerance_factor"], f.mesh.region.tolerance_factor)
     for i in f.mesh.region.dims:
-        assert np.array_equal(getattr(f.mesh.points, i), fxa[i].values)
+        assert np.array_equal(getattr(f.mesh.cells, i), fxa[i].values)
         assert fxa[i].attrs["units"] == f.mesh.region.units[f.mesh.region.dims.index(i)]
     assert "vdims" not in fxa.dims
     assert np.array_equal(f.array.squeeze(axis=-1), fxa.values)

discretisedfield/tests/test_mesh.py

@@ -862,35 +862,35 @@ def test_region2slice():
         mesh.region2slices(df.Region(p1=(-1, 3), p2=(3, 5)))
 
 
-def test_points():
+def test_cells():
     # 1d example (ndim=1)
     p1 = 0
     p2 = 10
     cell = 2
     mesh = df.Mesh(region=df.Region(p1=p1, p2=p2), cell=cell)
 
-    assert np.allclose(mesh.points.x, [1.0, 3.0, 5.0, 7.0, 9.0], atol=0)
+    assert np.allclose(mesh.cells.x, [1.0, 3.0, 5.0, 7.0, 9.0], atol=0)
 
     # 3d example (ndim=3)
     p1 = (0, 0, 4)
     p2 = (10, 6, 0)
     cell = (2, 2, 1)
     mesh = df.Mesh(region=df.Region(p1=p1, p2=p2), cell=cell)
 
-    assert np.allclose(mesh.points.x, [1.0, 3.0, 5.0, 7.0, 9.0], atol=0)
-    assert np.allclose(mesh.points.y, [1.0, 3.0, 5.0], atol=0)
-    assert np.allclose(mesh.points.z, [0.5, 1.5, 2.5, 3.5], atol=0)
+    assert np.allclose(mesh.cells.x, [1.0, 3.0, 5.0, 7.0, 9.0], atol=0)
+    assert np.allclose(mesh.cells.y, [1.0, 3.0, 5.0], atol=0)
+    assert np.allclose(mesh.cells.z, [0.5, 1.5, 2.5, 3.5], atol=0)
 
     # 4d example (ndim=4)
     p1 = (0, 0, 4, 4)
     p2 = (10, 6, 0, 0)
     cell = (2, 2, 1, 1)
     mesh = df.Mesh(region=df.Region(p1=p1, p2=p2), cell=cell)
 
-    assert np.allclose(mesh.points.x0, [1.0, 3.0, 5.0, 7.0, 9.0], atol=0)
-    assert np.allclose(mesh.points.x1, [1.0, 3.0, 5.0], atol=0)
-    assert np.allclose(mesh.points.x2, [0.5, 1.5, 2.5, 3.5], atol=0)
-    assert np.allclose(mesh.points.x3, [0.5, 1.5, 2.5, 3.5], atol=0)
+    assert np.allclose(mesh.cells.x0, [1.0, 3.0, 5.0, 7.0, 9.0], atol=0)
+    assert np.allclose(mesh.cells.x1, [1.0, 3.0, 5.0], atol=0)
+    assert np.allclose(mesh.cells.x2, [0.5, 1.5, 2.5, 3.5], atol=0)
+    assert np.allclose(mesh.cells.x3, [0.5, 1.5, 2.5, 3.5], atol=0)
 
 
 def test_vertices():
@@ -1616,7 +1616,7 @@ def test_coordinate_field(valid_mesh):
         index[valid_mesh.region._dim2index(dim)] = slice(None)
         # extra index for vector dimension: vector component along the current direction
         index = tuple(index) + (valid_mesh.region._dim2index(dim),)
-        assert np.allclose(cfield.array[index], getattr(valid_mesh.points, dim), atol=0)
+        assert np.allclose(cfield.array[index], getattr(valid_mesh.cells, dim), atol=0)
 
 
 def test_sel_convert_intput():

docs/mesh-basics.ipynb

@@ -361,7 +361,7 @@
     {
      "data": {
       "text/plain": [
-       "<generator object Mesh.indices at 0x7f77c66fd380>"
+       "<generator object Mesh.indices at 0x7f187843d3c0>"
       ]
      },
      "execution_count": 14,
@@ -564,7 +564,7 @@
     }
    ],
    "source": [
-    "list(mesh.points.x)"
+    "list(mesh.cells.x)"
    ]
   },
   {
@@ -584,7 +584,7 @@
     }
    ],
    "source": [
-    "list(mesh.points.y)"
+    "list(mesh.cells.y)"
    ]
   },
   {
@@ -1077,7 +1077,9 @@
   {
    "cell_type": "code",
    "execution_count": 36,
-   "metadata": {},
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "data": {
@@ -1126,7 +1128,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.12"
+   "version": "3.8.17"
   },
   "widgets": {
    "application/vnd.jupyter.widget-state+json": {