galpy.orbit.Orbit.plotBruteSOS

Orbit.plotBruteSOS(t, pot, *args, surface=None, method='dop853_c', progressbar=True, **kwargs)[source]

Calculate and plot a surface of section of the orbit computed using bruteSOS.

Parameters:

  • t (numeric, numpy.ndarray or Quantity, optional) – Time at which to get the position. Default is the initial time.

  • pot (Potential, DissipativeForce or list of such instances) – Gravitational field to integrate the orbit in.

  • surface (str, optional) – Surface to punch through (this has no effect in 3D, where the surface is always z=0, but in 2D it can be ‘x’ or ‘y’ for x=0 or y=0), by default None.

  • method (str, optional) – Integration method to use. Default is ‘dop853_c’. See Notes for more information.

  • progressbar (bool, optional) – If True, display a tqdm progress bar when integrating multiple orbits (requires tqdm to be installed!) (default is True).

  • *args (optional) – Additional arguments to pass to galpy.util.plot.plot.

  • **kwargs (dict) – Additional keyword arguments to pass to galpy.util.plot.plot.

  • inputs (matplotlib.plot inputs+galpy.util.plot.plot)

Returns:

A list of the plotted line objects.

Return type:

list

Notes

  • Possible integration methods are:

    • ‘odeint’ for scipy’s odeint

    • ‘leapfrog’ for a simple leapfrog implementation

    • ‘leapfrog_c’ for a simple leapfrog implementation in C

    • ‘symplec4_c’ for a 4th order symplectic integrator in C

    • ‘symplec6_c’ for a 6th order symplectic integrator in C

    • ‘rk4_c’ for a 4th-order Runge-Kutta integrator in C

    • ‘rk6_c’ for a 6-th order Runge-Kutta integrator in C

    • ‘dopr54_c’ for a 5-4 Dormand-Prince integrator in C

    • ‘dop853’ for a 8-5-3 Dormand-Prince integrator in Python

    • ‘dop853_c’ for a 8-5-3 Dormand-Prince integrator in C

  • 2023-05-31 - Written - Bovy (UofT)