swiftest.Simulation.get_output_files

swiftest.Simulation.get_output_files#

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

Returns a subset of the parameter dictionary containing the current output file parameters.

If the verbose option is set in the Simulation object, then it will also print the values.

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: [“output_file_type”, “output_file_name”, “output_format”]

  • **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:

output_file_dict (dict) – A dictionary containing the requested parameters