galpy.potential.Potential.mvir

Potential.mvir(H=70.0, Om=0.3, t=0.0, overdens=200.0, wrtcrit=False, forceint=False, ro=None, vo=None, use_physical=False)[source]

Calculate the virial mass.

Parameters:

  • H (float, optional) – Hubble constant in km/s/Mpc (default: 70).

  • Om (float, optional) – Omega matter (default: 0.3).

  • overdens (float, optional) – Overdensity which defines the virial radius (default: 200).

  • wrtcrit (bool, optional) – If True, the overdensity is wrt the critical density rather than the mean matter density (default: False).

  • ro (float or Quantity, optional) – Distance scale in kpc (default: object-wide, which if not set is 8 kpc).

  • vo (float or Quantity, optional) – Velocity scale in km/s (default: object-wide, which if not set is 220 km/s).

  • forceint (bool, optional) – If True, calculate the mass through integration of the density, even if an explicit expression for the mass exists.

Returns:

M(<rvir).

Return type:

float or Quantity

Notes

  • 2014-09-12 - Written - Bovy (IAS)