galpy.potential.Potential.mass

Potential.mass(R, z=None, t=0.0, forceint=False)

NAME:

mass

PURPOSE:

evaluate the mass enclosed

INPUT:

R - Cylindrical Galactocentric radius

z= (None) vertical height

t - time (optional)

KEYWORDS:

forceint= if True, calculate the mass through integration of the density, even if an explicit expression for the mass exists

OUTPUT:

1. for spherical potentials: M(<R) [or if z is None], when the mass is implemented explicitly, the mass enclosed within r = sqrt(R^2+z^2) is returned when not z is None; forceint will integrate between -z and z, so the two are inconsistent (If you care to have this changed, raise an issue on github)
2. for axisymmetric potentials: M(<R,<|Z|)

HISTORY:

2014-01-29 - Written - Bovy (IAS)