galpy.potential.Potential.toVertical

Potential.toVertical(R, phi=None, t0=0.0)[source]

Convert a 3D potential into a linear (vertical) potential at R.

Parameters:
  • R (float or Quantity) – Galactocentric radius at which to create the vertical potential.

  • phi (float or Quantity, optional) – Galactocentric azimuth at which to create the vertical potential; required for non-axisymmetric potential.

  • t0 (float or Quantity, optional) – Time at which to create the vertical potential (default: 0.0)

Returns:

linear (vertical) potential – Phi(z,phi,t) = Phi(R,z,phi,t)-Phi(R,0.,phi0,t0) where phi0 and t0 are the phi and t inputs.

Return type:

function