swiftest.Simulation.set_distance_range

swiftest.Simulation.set_distance_range#

Simulation.set_distance_range(rmin=None, rmax=None, qmin_coord=None, **kwargs)[source]#

Sets the minimum and maximum distances of the simulation.

Parameters:

  • rmin (float) – Minimum distance of the simulation (CHK_QMIN, CHK_RMIN, CHK_QMIN_RANGE[0])

  • rmax (float) – Maximum distance of the simulation (CHK_RMAX, CHK_QMIN_RANGE[1])

  • qmin_coord (str, {“HELIO”, “BARY”}) – coordinate frame to use for CHK_QMIN

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

Returns:

range_dict (dict) – A dictionary containing the requested parameters.

Contents