galpy.orbit.Orbit.bruteSOS

Orbit.bruteSOS(t, pot, surface=None, method='dop853_c', dt=None, progressbar=True, numcores=2, force_map=False)

NAME:

bruteSOS

PURPOSE:

calculate the surface of section of the orbit using a brute-force integration approach

INPUT:

t - list of times at which to output (0 has to be in this!) (can be Quantity)

pot - Potential or list of such instances

surface= (None) 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)

integration keyword arguments:

method = ‘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

dt - if set, force the integrator to use this basic stepsize; must be an integer divisor of output stepsize (only works for the C integrators that use a fixed stepsize) (can be Quantity)

progressbar= (True) if True, display a tqdm progress bar when integrating multiple orbits (requires tqdm to be installed!)

numcores - number of cores to use for Python-based multiprocessing (pure Python or using force_map=True); default = OMP_NUM_THREADS

force_map= (False) if True, force use of Python-based multiprocessing (not recommended)

OUTPUT:

(R,vR) for 3D orbits, (y,vy) for 2D orbits when surface==’x’, (x,vx) for 2D orbits when surface==’y’

HISTORY:

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