Physics tabulation notifier

examples/pumas/dump.c

@@ -49,7 +49,8 @@ int main(int argc, char * argv[])
 
         /* Compute the material's physics data */
         struct pumas_physics * physics;
-        pumas_physics_create(&physics, PUMAS_PARTICLE_MUON, mdf, dedx, NULL);
+        pumas_physics_create(
+            &physics, PUMAS_PARTICLE_MUON, mdf, dedx, NULL, NULL);
 
         /* Dump the physics data for subsequent usage */
         FILE * stream = fopen(dump, "wb");

examples/pumas/loader.c

@@ -63,8 +63,8 @@ static enum pumas_return load_pumas_materials(struct pumas_physics ** physics,
 
         /* If no binary dump, initialise from the MDF and dump */
         enum pumas_return rc;
-        if ((rc = pumas_physics_create(physics, particle, mdf, dedx, NULL)) !=
-            PUMAS_RETURN_SUCCESS)
+        if ((rc = pumas_physics_create(
+            physics, particle, mdf, dedx, NULL, NULL)) != PUMAS_RETURN_SUCCESS)
                 return rc;
 
         /* Dump the library configuration */

examples/pumas/straight.c

@@ -96,7 +96,7 @@ int main(int narg, char * argv[])
          * can a few seconds, depending on the number of materials in the MDF.
          */
         pumas_physics_create(&physics, PUMAS_PARTICLE_MUON,
-            "examples/data/materials.xml", NULL, NULL);
+            "examples/data/materials.xml", NULL, NULL, NULL);
 
         /* Map the PUMAS material index */
         pumas_physics_material_index(physics, MATERIAL_NAME, &medium.material);

examples/pumas/tabulate.c

@@ -47,7 +47,7 @@ int main(int argc, char * argv[])
         struct pumas_physics * physics;
         struct pumas_physics_settings settings = { .dry = 1, .update = 1};
         pumas_physics_create(
-            &physics, PUMAS_PARTICLE_MUON, mdf, dedx, &settings);
+            &physics, PUMAS_PARTICLE_MUON, mdf, dedx, &settings, NULL);
 
         /* Exit to the OS */
         exit(EXIT_SUCCESS);

include/pumas.h

@@ -191,6 +191,8 @@ enum pumas_return {
         PUMAS_RETURN_UNKNOWN_PARTICLE,
         /** Some input value is not valid. */
         PUMAS_RETURN_VALUE_ERROR,
+        /** An external interrupt was caught.  */
+        PUMAS_RETURN_INTERRUPT,
         /** The number of PUMAS return codes.  */
         PUMAS_N_RETURNS
 };
@@ -814,6 +816,25 @@ struct pumas_physics_settings {
         int dry;
 };
 
+/**
+ * Notifier interface for monitoring physics tabulation.
+ *
+ * The notifier callback functions must return one of `PUMAS_RETURN_SUCCESS` or
+ * `PUMAS_RETURN_INTERRUPT` (if physics computation shall be aborted).
+ *
+ * **Note** that this object might be overloaded by users, since it only defines
+ * an interface.
+ */
+struct pumas_physics_notifier {
+    /** Configuration callback. */
+    enum pumas_return (*configure)(
+        struct pumas_physics_notifier * self, const char * title, int steps);
+
+    /** Notification callback. */
+    enum pumas_return (*notify)(
+        struct pumas_physics_notifier * self);
+};
+
 /**
  * Create physics tables.
  *
@@ -898,7 +919,8 @@ struct pumas_physics_settings {
 PUMAS_API enum pumas_return pumas_physics_create(
     struct pumas_physics ** physics, enum pumas_particle particle,
     const char * mdf_path, const char * dedx_path,
-    const struct pumas_physics_settings * settings);
+    const struct pumas_physics_settings * settings,
+    struct pumas_physics_notifier * notifier);
 
 /**
  * Destroy a physics instance.