shamrock.utils.SimulationRunner.callback

shamrock.utils.SimulationRunner.callback(*, tsim_interval=None, iter_count_interval=None, walltime_interval=None)

Decorator to mark a function as a simulation callback.

Example:

@callback(tsim_interval=1.0) def analysis(self, icallback):

print(“analysis”, icallback)

Args:

tsim_interval: The time step of the callback. iter_count_interval: The iteration count interval of the callback. walltime_interval: The walltime interval of the callback.

Returns:

The decorated function.