allowed_meshes property for derived quantities

festim/exports/derived_quantities/average_surface.py

@@ -28,6 +28,10 @@ class AverageSurface(SurfaceQuantity):
     def __init__(self, field, surface) -> None:
         super().__init__(field=field, surface=surface)
 
+    @property
+    def allowed_meshes(self):
+        return ["cartesian"]
+
     @property
     def title(self):
         quantity_title = f"Average {self.field} surface {self.surface}"

festim/exports/derived_quantities/average_volume.py

@@ -27,6 +27,10 @@ class AverageVolume(VolumeQuantity):
     def __init__(self, field, volume: int) -> None:
         super().__init__(field=field, volume=volume)
 
+    @property
+    def allowed_meshes(self):
+        return ["cartesian"]
+
     @property
     def title(self):
         quantity_title = f"Average {self.field} volume {self.volume}"

festim/exports/derived_quantities/derived_quantity.py

@@ -7,6 +7,24 @@ class DerivedQuantity(Export):
 
     Args:
         field (str, int):  the field ("solute", 0, 1, "T", "retention")
+
+    Attributes:
+        field (str, int):  the field ("solute", 0, 1, "T", "retention")
+        title (str): the title of the derived quantity
+        show_units (bool): show the units in the title in the derived quantities
+            file
+        function (fenics.Function): the solution function of
+            the field
+        dx (fenics.Measure): the measure of the volume
+        ds (fenics.Measure): the measure of the surface
+        n (fenics.Function): the normal vector
+        D (fenics.Function): the diffusion coefficient
+        S (fenics.Function): the source term
+        thermal_cond (fenics.Function): the thermal conductivity
+        Q (fenics.Function): the heat source term
+        data (list): the data of the derived quantity
+        t (list): the time values of the data
+        allowed_meshes (list): the allowed meshes for the derived quantity
     """
 
     def __init__(self, field) -> None:
@@ -18,10 +36,17 @@ def __init__(self, field) -> None:
         self.S = None
         self.thermal_cond = None
         self.Q = None
+        self.T = None
         self.data = []
         self.t = []
         self.show_units = False
 
+    @property
+    def allowed_meshes(self):
+        # by default, all meshes are allowed
+        # override this method if that's not the case
+        return ["cartesian", "cylindrical", "spherical"]
+
 
 class VolumeQuantity(DerivedQuantity):
     """DerivedQuantity relative to a volume

festim/exports/derived_quantities/surface_flux.py

@@ -36,6 +36,10 @@ class SurfaceFlux(SurfaceQuantity):
     def __init__(self, field, surface) -> None:
         super().__init__(field=field, surface=surface)
 
+    @property
+    def allowed_meshes(self):
+        return ["cartesian"]
+
     @property
     def export_unit(self):
         # obtain domain dimension
@@ -111,6 +115,10 @@ def __init__(self, field, surface, azimuth_range=(0, 2 * np.pi)) -> None:
         self.r = None
         self.azimuth_range = azimuth_range
 
+    @property
+    def allowed_meshes(self):
+        return ["cylindrical"]
+
     @property
     def title(self):
         if self.field == "T":
@@ -199,6 +207,10 @@ def __init__(
         self.polar_range = polar_range
         self.azimuth_range = azimuth_range
 
+    @property
+    def allowed_meshes(self):
+        return ["spherical"]
+
     @property
     def title(self):
         if self.field == "T":

festim/exports/derived_quantities/total_surface.py

@@ -30,6 +30,10 @@ class TotalSurface(SurfaceQuantity):
     def __init__(self, field, surface) -> None:
         super().__init__(field=field, surface=surface)
 
+    @property
+    def allowed_meshes(self):
+        return ["cartesian"]
+
     @property
     def export_unit(self):
         # obtain domain dimension

festim/exports/derived_quantities/total_volume.py

@@ -30,6 +30,10 @@ class TotalVolume(VolumeQuantity):
     def __init__(self, field, volume) -> None:
         super().__init__(field=field, volume=volume)
 
+    @property
+    def allowed_meshes(self):
+        return ["cartesian"]
+
     @property
     def export_unit(self):
         # obtain domain dimension

festim/generic_simulation.py

@@ -359,29 +359,10 @@ def initialise(self):
 
         # raise warning if the derived quantities don't match the type of mesh
         # eg. SurfaceFlux is used with cylindrical mesh
-        all_types_quantities = [
-            festim.MaximumSurface,
-            festim.MinimumSurface,
-            festim.MaximumVolume,
-            festim.MinimumVolume,
-            festim.PointValue,
-        ]  # these quantities can be used with any mesh
-        allowed_quantities = {
-            "cartesian": [
-                festim.SurfaceFlux,
-                festim.AverageSurface,
-                festim.AverageVolume,
-                festim.TotalVolume,
-            ]
-            + all_types_quantities,
-            "cylindrical": [festim.SurfaceFluxCylindrical] + all_types_quantities,
-            "spherical": [festim.SurfaceFluxSpherical] + all_types_quantities,
-        }
-
         for export in self.exports:
             if isinstance(export, festim.DerivedQuantities):
                 for q in export:
-                    if not isinstance(q, tuple(allowed_quantities[self.mesh.type])):
+                    if self.mesh.type not in q.allowed_meshes:
                         warnings.warn(
                             f"{type(q)} may not work as intended for {self.mesh.type} meshes"
                         )

test/system/test_cylindrical_coordinates.py

@@ -40,13 +40,18 @@ def test_run_MMS():
         transient=False,
     )
 
+    exports = [
+        festim.DerivedQuantities([festim.SurfaceFluxCylindrical(field=0, surface=2)])
+    ]
+
     my_sim = festim.Simulation(
         mesh=my_mesh,
         materials=my_materials,
         boundary_conditions=my_bcs,
         temperature=my_temp,
         sources=my_sources,
         settings=my_settings,
+        exports=exports,
     )
 
     my_sim.initialise()

test/system/test_spherical_coordinates.py

@@ -40,13 +40,18 @@ def test_run_MMS():
         transient=False,
     )
 
+    exports = [
+        festim.DerivedQuantities([festim.SurfaceFluxSpherical(field=0, surface=2)])
+    ]
+
     my_sim = festim.Simulation(
         mesh=my_mesh,
         materials=my_materials,
         boundary_conditions=my_bcs,
         temperature=my_temp,
         sources=my_sources,
         settings=my_settings,
+        exports=exports,
     )
 
     my_sim.initialise()