galpy.potential.toVerticalPotential¶

galpy.potential.toVerticalPotential(Pot, R, phi=None, t0=0.0)[source]¶

Convert a 3D azisymmetric potential to a vertical potential at a given R.

Parameters:

Pot (Potential instance or CompositePotential or a combined potential formed using addition (pot1+pot2+…)) – The 3D potential to convert.
R (float or Quantity) – Galactocentric radius at which to evaluate the vertical potential.
phi (float, optional) – Azimuth at which to evaluate the vertical potential. Default is None.
t0 (float, optional) – Time at which to evaluate the vertical potential. Default is 0.0.

Returns:

The vertical potential at (R, z, phi, t). Returns a linearCompositePotential when input is a list or CompositePotential with multiple components.

Return type:

verticalPotential or linearCompositePotential

Notes