Add callback hooks to the simulation stepper

doc/support/tools.rst

@@ -1,6 +1,6 @@
 Random Pile'o'Tools
 ===================
 
+.. automodule:: mirgecom.exceptions
 .. automodule:: mirgecom.simutil
-
 .. automodule:: mirgecom.utils

examples/autoignition-mpi.py

@@ -41,9 +41,9 @@
     inviscid_sim_timestep,
     sim_checkpoint,
     check_step,
-    generate_and_distribute_mesh,
-    ExactSolutionMismatch
+    generate_and_distribute_mesh
 )
+from mirgecom.fluid import split_conserved
 from mirgecom.io import make_init_message
 from mirgecom.mpi import mpi_entry_point
 
@@ -52,7 +52,7 @@
 from mirgecom.boundary import AdiabaticSlipBoundary
 from mirgecom.initializers import MixtureInitializer
 from mirgecom.eos import PyrometheusMixture
-from mirgecom.euler import split_conserved
+
 import cantera
 import pyrometheus as pyro
 
@@ -92,7 +92,6 @@ def main(ctx_factory=cl.create_some_context, use_leap=False):
         timestepper = rk4_step
     box_ll = -0.005
     box_ur = 0.005
-    error_state = False
     debug = False
 
     from mpi4py import MPI
@@ -233,23 +232,19 @@ def my_checkpoint(step, t, dt, state):
         cv = split_conserved(dim, state)
         reaction_rates = eos.get_production_rates(cv)
         viz_fields = [("reaction_rates", reaction_rates)]
-        return sim_checkpoint(discr, visualizer, eos, q=state,
-                              vizname=casename, step=step,
-                              t=t, dt=dt, nstatus=nstatus, nviz=nviz,
-                              constant_cfl=constant_cfl, comm=comm,
-                              viz_fields=viz_fields)
-
-    try:
-        (current_step, current_t, current_state) = \
-            advance_state(rhs=my_rhs, timestepper=timestepper,
-                checkpoint=my_checkpoint,
-                get_timestep=get_timestep, state=current_state,
-                t=current_t, t_final=t_final)
-    except ExactSolutionMismatch as ex:
-        error_state = True
-        current_step = ex.step
-        current_t = ex.t
-        current_state = ex.state
+        # Perform status checkpointing
+        sim_checkpoint(discr, visualizer, eos, q=state,
+                       vizname=casename, step=step,
+                       t=t, dt=dt, nstatus=nstatus, nviz=nviz,
+                       constant_cfl=constant_cfl,
+                       viz_fields=viz_fields)
+        return state
+
+    current_step, current_t, current_state = \
+        advance_state(rhs=my_rhs, timestepper=timestepper,
+                      pre_step_callback=my_checkpoint,
+                      get_timestep=get_timestep, state=current_state,
+                      t=current_t, t_final=t_final, eos=eos, dim=dim)
 
     if not check_step(current_step, nviz):  # If final step not an output step
         if rank == 0:
@@ -258,12 +253,6 @@ def my_checkpoint(step, t, dt, state):
                       dt=(current_t - checkpoint_t),
                       state=current_state)
 
-    if current_t - t_final < 0:
-        error_state = True
-
-    if error_state:
-        raise ValueError("Simulation did not complete successfully.")
-
 
 if __name__ == "__main__":
     logging.basicConfig(level=logging.INFO)

examples/lump-mpi.py

@@ -40,8 +40,7 @@
 from mirgecom.simutil import (
     inviscid_sim_timestep,
     sim_checkpoint,
-    generate_and_distribute_mesh,
-    ExactSolutionMismatch
+    generate_and_distribute_mesh
 )
 from mirgecom.io import make_init_message
 from mirgecom.mpi import mpi_entry_point
@@ -131,21 +130,17 @@ def my_rhs(t, state):
                               boundaries=boundaries, eos=eos)
 
     def my_checkpoint(step, t, dt, state):
-        return sim_checkpoint(discr, visualizer, eos, q=state,
-                              exact_soln=initializer, vizname=casename, step=step,
-                              t=t, dt=dt, nstatus=nstatus, nviz=nviz,
-                              exittol=exittol, constant_cfl=constant_cfl, comm=comm)
-
-    try:
-        (current_step, current_t, current_state) = \
-            advance_state(rhs=my_rhs, timestepper=timestepper,
-                checkpoint=my_checkpoint,
-                get_timestep=get_timestep, state=current_state,
-                t=current_t, t_final=t_final)
-    except ExactSolutionMismatch as ex:
-        current_step = ex.step
-        current_t = ex.t
-        current_state = ex.state
+        sim_checkpoint(discr, visualizer, eos, q=state,
+                       exact_soln=initializer, vizname=casename, step=step,
+                       t=t, dt=dt, nstatus=nstatus, nviz=nviz,
+                       exittol=exittol, constant_cfl=constant_cfl)
+        return state
+
+    current_step, current_t, current_state = \
+        advance_state(rhs=my_rhs, timestepper=timestepper,
+                      pre_step_callback=my_checkpoint,
+                      get_timestep=get_timestep, state=current_state,
+                      t=current_t, t_final=t_final, eos=eos, dim=dim)
 
     #    if current_t != checkpoint_t:
     if rank == 0:
@@ -154,9 +149,6 @@ def my_checkpoint(step, t, dt, state):
                   dt=(current_t - checkpoint_t),
                   state=current_state)
 
-    if current_t - t_final < 0:
-        raise ValueError("Simulation exited abnormally")
-
 
 if __name__ == "__main__":
     logging.basicConfig(format="%(message)s", level=logging.INFO)

examples/mixture-mpi.py

@@ -40,8 +40,7 @@
 from mirgecom.simutil import (
     inviscid_sim_timestep,
     sim_checkpoint,
-    generate_and_distribute_mesh,
-    ExactSolutionMismatch
+    generate_and_distribute_mesh
 )
 from mirgecom.io import make_init_message
 from mirgecom.mpi import mpi_entry_point
@@ -89,7 +88,6 @@ def main(ctx_factory=cl.create_some_context, use_leap=False):
         timestepper = rk4_step
     box_ll = -5.0
     box_ur = 5.0
-    error_state = 0
 
     from mpi4py import MPI
     comm = MPI.COMM_WORLD
@@ -152,24 +150,17 @@ def my_rhs(t, state):
                               boundaries=boundaries, eos=eos)
 
     def my_checkpoint(step, t, dt, state):
-        global checkpoint_t
-        checkpoint_t = t
-        return sim_checkpoint(discr, visualizer, eos, q=state,
-                              exact_soln=initializer, vizname=casename, step=step,
-                              t=t, dt=dt, nstatus=nstatus, nviz=nviz,
-                              exittol=exittol, constant_cfl=constant_cfl, comm=comm)
-
-    try:
-        (current_step, current_t, current_state) = \
-            advance_state(rhs=my_rhs, timestepper=timestepper,
-                checkpoint=my_checkpoint,
-                get_timestep=get_timestep, state=current_state,
-                t=current_t, t_final=t_final)
-    except ExactSolutionMismatch as ex:
-        error_state = 1
-        current_step = ex.step
-        current_t = ex.t
-        current_state = ex.state
+        sim_checkpoint(discr, visualizer, eos, q=state,
+                       exact_soln=initializer, vizname=casename, step=step,
+                       t=t, dt=dt, nstatus=nstatus, nviz=nviz,
+                       exittol=exittol, constant_cfl=constant_cfl)
+        return state
+
+    current_step, current_t, current_state = \
+        advance_state(rhs=my_rhs, timestepper=timestepper,
+                      pre_step_callback=my_checkpoint,
+                      get_timestep=get_timestep, state=current_state,
+                      t=current_t, t_final=t_final, eos=eos, dim=dim)
 
     if current_t != checkpoint_t:  # This check because !overwrite
         if rank == 0:
@@ -178,12 +169,6 @@ def my_checkpoint(step, t, dt, state):
                       dt=(current_t - checkpoint_t),
                       state=current_state)
 
-    if current_t - t_final < 0:
-        error_state = 1
-
-    if error_state:
-        raise ValueError("Simulation did not complete successfully.")
-
 
 if __name__ == "__main__":
     logging.basicConfig(format="%(message)s", level=logging.INFO)

examples/pulse-mpi.py

@@ -40,11 +40,9 @@
 from mirgecom.euler import euler_operator
 from mirgecom.simutil import (
     inviscid_sim_timestep,
-    generate_and_distribute_mesh,
     sim_checkpoint,
-    ExactSolutionMismatch,
+    generate_and_distribute_mesh
 )
-
 from mirgecom.io import make_init_message
 
 from mirgecom.integrators import rk4_step
@@ -154,21 +152,17 @@ def my_rhs(t, state):
                               boundaries=boundaries, eos=eos)
 
     def my_checkpoint(step, t, dt, state):
-        return sim_checkpoint(discr, visualizer, eos, q=state,
-                              vizname=casename, step=step,
-                              t=t, dt=dt, nstatus=nstatus, nviz=nviz,
-                              exittol=exittol, constant_cfl=constant_cfl, comm=comm)
-
-    try:
-        (current_step, current_t, current_state) = \
-            advance_state(rhs=my_rhs, timestepper=timestepper,
-                checkpoint=my_checkpoint,
-                get_timestep=get_timestep, state=current_state,
-                t=current_t, t_final=t_final)
-    except ExactSolutionMismatch as ex:
-        current_step = ex.step
-        current_t = ex.t
-        current_state = ex.state
+        sim_checkpoint(discr, visualizer, eos, q=state,
+                       exact_soln=initializer, vizname=casename, step=step,
+                       t=t, dt=dt, nstatus=nstatus, nviz=nviz,
+                       exittol=exittol, constant_cfl=constant_cfl)
+        return state
+
+    current_step, current_t, current_state = \
+        advance_state(rhs=my_rhs, timestepper=timestepper,
+                      pre_step_callback=my_checkpoint,
+                      get_timestep=get_timestep, state=current_state,
+                      t=current_t, t_final=t_final, eos=eos, dim=dim)
 
     #    if current_t != checkpoint_t:
     if rank == 0:
@@ -177,9 +171,6 @@ def my_checkpoint(step, t, dt, state):
                   dt=(current_t - checkpoint_t),
                   state=current_state)
 
-    if current_t - t_final < 0:
-        raise ValueError("Simulation exited abnormally")
-
 
 if __name__ == "__main__":
     logging.basicConfig(format="%(message)s", level=logging.INFO)

examples/scalar-lump-mpi.py

@@ -41,8 +41,7 @@
 from mirgecom.simutil import (
     inviscid_sim_timestep,
     sim_checkpoint,
-    generate_and_distribute_mesh,
-    ExactSolutionMismatch
+    generate_and_distribute_mesh
 )
 from mirgecom.io import make_init_message
 from mirgecom.mpi import mpi_entry_point
@@ -141,21 +140,17 @@ def my_rhs(t, state):
                               boundaries=boundaries, eos=eos)
 
     def my_checkpoint(step, t, dt, state):
-        return sim_checkpoint(discr, visualizer, eos, q=state,
-                              exact_soln=initializer, vizname=casename, step=step,
-                              t=t, dt=dt, nstatus=nstatus, nviz=nviz,
-                              exittol=exittol, constant_cfl=constant_cfl, comm=comm)
-
-    try:
-        (current_step, current_t, current_state) = \
-            advance_state(rhs=my_rhs, timestepper=timestepper,
-                checkpoint=my_checkpoint,
-                get_timestep=get_timestep, state=current_state,
-                t=current_t, t_final=t_final)
-    except ExactSolutionMismatch as ex:
-        current_step = ex.step
-        current_t = ex.t
-        current_state = ex.state
+        sim_checkpoint(discr, visualizer, eos, q=state,
+                       exact_soln=initializer, vizname=casename, step=step,
+                       t=t, dt=dt, nstatus=nstatus, nviz=nviz,
+                       exittol=exittol, constant_cfl=constant_cfl)
+        return state
+
+    current_step, current_t, current_state = \
+        advance_state(rhs=my_rhs, timestepper=timestepper,
+                      pre_step_callback=my_checkpoint,
+                      get_timestep=get_timestep, state=current_state,
+                      t=current_t, t_final=t_final, eos=eos, dim=dim)
 
     #    if current_t != checkpoint_t:
     if rank == 0:
@@ -164,9 +159,6 @@ def my_checkpoint(step, t, dt, state):
                   dt=(current_t - checkpoint_t),
                   state=current_state)
 
-    if current_t - t_final < 0:
-        raise ValueError("Simulation exited abnormally")
-
 
 if __name__ == "__main__":
     logging.basicConfig(format="%(message)s", level=logging.INFO)

examples/sod-mpi.py

@@ -39,8 +39,7 @@
 from mirgecom.simutil import (
     inviscid_sim_timestep,
     sim_checkpoint,
-    generate_and_distribute_mesh,
-    ExactSolutionMismatch,
+    generate_and_distribute_mesh
 )
 from mirgecom.io import make_init_message
 from mirgecom.mpi import mpi_entry_point
@@ -130,21 +129,17 @@ def my_rhs(t, state):
                               boundaries=boundaries, eos=eos)
 
     def my_checkpoint(step, t, dt, state):
-        return sim_checkpoint(discr, visualizer, eos, q=state,
-                              exact_soln=initializer, vizname=casename, step=step,
-                              t=t, dt=dt, nstatus=nstatus, nviz=nviz,
-                              exittol=exittol, constant_cfl=constant_cfl, comm=comm)
-
-    try:
-        (current_step, current_t, current_state) = \
-            advance_state(rhs=my_rhs, timestepper=timestepper,
-                checkpoint=my_checkpoint,
-                get_timestep=get_timestep, state=current_state,
-                t=current_t, t_final=t_final)
-    except ExactSolutionMismatch as ex:
-        current_step = ex.step
-        current_t = ex.t
-        current_state = ex.state
+        sim_checkpoint(discr, visualizer, eos, q=state,
+                       exact_soln=initializer, vizname=casename, step=step,
+                       t=t, dt=dt, nstatus=nstatus, nviz=nviz,
+                       exittol=exittol, constant_cfl=constant_cfl)
+        return state
+
+    current_step, current_t, current_state = \
+        advance_state(rhs=my_rhs, timestepper=timestepper,
+                      pre_step_callback=my_checkpoint,
+                      get_timestep=get_timestep, state=current_state,
+                      t=current_t, t_final=t_final, eos=eos, dim=dim)
 
     #    if current_t != checkpoint_t:
     if rank == 0:
@@ -153,9 +148,6 @@ def my_checkpoint(step, t, dt, state):
                   dt=(current_t - checkpoint_t),
                   state=current_state)
 
-    if current_t - t_final < 0:
-        raise ValueError("Simulation exited abnormally")
-
 
 if __name__ == "__main__":
     logging.basicConfig(format="%(message)s", level=logging.INFO)