galpy.potential.Potential.toVertical

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

NAME:

toVertical

PURPOSE:

convert a 3D potential into a linear (vertical) potential at R

INPUT:

R - Galactocentric radius at which to create the vertical potential (can be Quantity)

phi= (None) Galactocentric azimuth at which to create the vertical potential (can be Quantity); required for non-axisymmetric potential

t0= (0.) time at which to create the vertical potential (can be Quantity)

OUTPUT:

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

HISTORY

unknown