galpy.orbit.Orbit.zmax

Orbit.zmax(analytic=False, pot=None, **kwargs)[source]

NAME:

zmax

PURPOSE:

calculate the maximum vertical height, either numerically from the numerical orbit integration or using analytical means

INPUT:

analytic(= False) compute this analytically

pot - potential to use for analytical calculation

For 3D orbits different approximations for analytic=True are available (see the EccZmaxRperiRap method of actionAngle modules):

type= (‘staeckel’) type of actionAngle module to use

  1. ‘adiabatic’: assuming motion splits into R and z
  2. ‘staeckel’: assuming motion splits into u and v of prolate spheroidal coordinate system, exact for Staeckel potentials (incl. all spherical potentials)
  3. ‘spherical’: for spherical potentials, exact

+actionAngle module setup kwargs for the corresponding actionAngle modules (actionAngleAdiabatic, actionAngleStaeckel, and actionAngleSpherical)

ro= (Object-wide default) physical scale for distances to use to convert (can be Quantity)

use_physical= use to override Object-wide default for using a physical scale for output

OUTPUT:

Z_max [*input_shape]

HISTORY:

2019-02-25 - Written - Bovy (UofT)