swiftest.Simulation.set_integrator#
- Simulation.set_integrator(codename='Swiftest', integrator=None, mtiny=None, gmtiny=None, **kwargs)[source]#
Sets the integrator to be used when running a simulation. Returns a dictionary of the parameters that were set.
- Parameters:
codename ({“swiftest”, “swifter”, “swift”}, optional) – The name of the code to use. Case-insensitive valid options are swiftest, swifter, and swift. Currently only swiftest is is supported for excuting runs with the run() method.
integrator ({“symba”,”rmvs”,”whm”,”helio”}, optional) – Name of the n-body integrator that will be used when executing a run.
mtiny (float, optional) – The minimum mass of fully interacting bodies. Bodies below this mass interact with the larger bodies, but not each other (SyMBA only). Only mtiny or gmtiny is accepted, not both.
gmtiny (float, optional) – The minimum G*mass of fully interacting bodies. Bodies below this mass interact with the larger bodies, but not each other (SyMBA only). Only mtiny or gmtiny is accepted, not both.
**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:
integrator_dict (dict) – A dictionary containing the subset of the parameter dictonary that was updated by this setter