Merge pull request #655 from KulaginVladimir/main

PointValue class

docs/source/api/exports.rst

@@ -31,6 +31,10 @@ Exports
     :members:
     :show-inheritance:
 
+.. autoclass:: PointValue
+    :members:
+    :show-inheritance:
+
 .. autoclass:: AverageSurface
     :members:
     :show-inheritance:

festim/__init__.py

@@ -78,6 +78,7 @@
 from .exports.derived_quantities.total_surface import TotalSurface
 from .exports.derived_quantities.total_volume import TotalVolume
 from .exports.derived_quantities.average_surface import AverageSurface
+from .exports.derived_quantities.point_value import PointValue
 
 from .exports.derived_quantities.derived_quantities import DerivedQuantities
 

festim/exports/derived_quantities/point_value.py

@@ -0,0 +1,22 @@
+from festim import DerivedQuantity
+
+
+class PointValue(DerivedQuantity):
+    """DerivedQuantity relative to a point
+
+    Args:
+        field (str, int): the field ("solute", 0, 1, "T", "retention")
+        point (int, float, tuple, list): the point coordinates
+    """
+
+    def __init__(self, field: str or int, x: int or float or tuple or list) -> None:
+        super().__init__(field)
+        # make sure x is an iterable
+        if not hasattr(x, "__iter__"):
+            x = [x]
+        self.x = x
+        self.title = "{} value at {}".format(field, x)
+
+    def compute(self):
+        """The value at the point"""
+        return self.function(self.x)

test/unit/test_exports/test_derived_quantities/test_point_value.py

@@ -0,0 +1,25 @@
+from festim import PointValue
+import fenics as f
+import pytest
+
+
+@pytest.mark.parametrize("field", ["solute", "T"])
+def test_title(field):
+    x = 1
+    my_value = PointValue(field, x)
+    assert my_value.title == "{} value at [{}]".format(field, x)
+
+
+@pytest.mark.parametrize(
+    "mesh,x", [(f.UnitIntervalMesh(10), 1), (f.UnitCubeMesh(10, 10, 10), (1, 0, 1))]
+)
+def test_point_compute(mesh, x):
+    V = f.FunctionSpace(mesh, "P", 1)
+    c = f.interpolate(f.Expression("x[0]", degree=1), V)
+
+    my_value = PointValue("solute", x)
+    my_value.function = c
+
+    expected = c(x)
+    produced = my_value.compute()
+    assert produced == expected