galpy.potential.toVerticalPotential¶
-
galpy.potential.
toVerticalPotential
(Pot, R, phi=None, t0=0.0)¶ NAME:
toVerticalPotentialPURPOSE:
convert a Potential to a vertical potential at a given R: Phi(z,phi,t) = Phi(R,z,phi,t)-Phi(R,0.,phi0,t0) where phi0 and t0 are the phi and t inputsINPUT:
Pot - Potential instance or list of such instances
R - Galactocentric radius at which to evaluate the vertical potential (can be Quantity)
phi= (None) Galactocentric azimuth at which to evaluate the vertical potential (can be Quantity); required if Pot is non-axisymmetric
t0= (0.) time at which to evaluate the vertical potential (can be Quantity)
OUTPUT:
(list of) linearPotential instance(s)HISTORY:
2018-10-07 - Written - Bovy (UofT)