add logmgr_verify_steptime

Author: matthiasdiener

examples/pulse.py

@@ -244,14 +244,13 @@ def my_health_check(pressure):
         return health_error
 
     def my_pre_step(step, t, dt, state):
+        if logmgr:
+            logmgr.tick_before()
+
         fluid_state = make_fluid_state(state, gas_model)
         dv = fluid_state.dv
 
         try:
-
-            if logmgr:
-                logmgr.tick_before()
-
             from mirgecom.simutil import check_step
             do_viz = check_step(step=step, interval=nviz)
             do_restart = check_step(step=step, interval=nrestart)
@@ -288,6 +287,10 @@ def my_post_step(step, t, dt, state):
             set_dt(logmgr, dt)
             set_sim_state(logmgr, dim, state, eos)
             logmgr.tick_after()
+
+            from mirgecom.logging_quantities import logmgr_verify_steptime
+            logmgr_verify_steptime(logmgr)
+
         return state, dt
 
     def my_rhs(t, state):

mirgecom/logging_quantities.py

@@ -37,6 +37,7 @@
 .. autofunction:: logmgr_add_device_memory_usage
 .. autofunction:: logmgr_add_many_discretization_quantities
 .. autofunction:: logmgr_add_mempool_usage
+.. autofunction:: logmgr_verify_steptime
 .. autofunction:: add_package_versions
 .. autofunction:: set_sim_state
 .. autofunction:: logmgr_set_time
@@ -170,6 +171,24 @@ def logmgr_add_many_discretization_quantities(logmgr: LogManager, dcoll, dim,
                 units_for_logging, axis=d, dd=dd))
 
 
+def logmgr_verify_steptime(logmgr: LogManager, tolerance: float = 1.1) -> None:
+    """Verify that the step time is within *tolerance* of t_2step.
+
+    Call this function after :meth:`logmgr.tick_after`.
+
+    :arg tolerance: tolerance factor for the step time.
+    """
+
+    t_step = logmgr.last_values.get("t_step", 0.0)
+    t_2step = logmgr.last_values.get("t_2step", 0.0)
+    t_log = logmgr.last_values.get("t_log", 0.0)
+
+    if (t_step + t_log) * tolerance < t_2step:
+        from warnings import warn
+        warn("warning: (t_step + t_log) * tolerance is less than t_2step: "
+            f"{t_step=}, {t_log=}, {t_2step=}", stacklevel=2)
+
+
 # {{{ Package versions
 
 def add_package_versions(mgr: LogManager, path_to_version_sh: Optional[str] = None) \