swiftest.Simulation.get_simulation_time

swiftest.Simulation.get_simulation_time#

Simulation.get_simulation_time(arg_list=None, **kwargs)[source]#

Returns a subset of the parameter dictionary containing the current simulation time parameters.

Parameters:
  • arg_list (str | List[str], optional) – A single string or list of strings containing the names of the simulation time parameters to extract. Default is all of: [“t0”, “tstart”, “tstop”, “dt”, “istep_out”, “tstep_out”, “dump_cadence”]

  • **kwargs (Any) – A dictionary of additional keyword argument. This allows this method to be called by the more general get_parameter method, which takes all possible Simulation parameters as arguments, so these are ignored.

Returns:

time_dict (dict) – A dictionary containing the requested parameters