get_eddington_rate#

cogsworth.classify.get_eddington_rate(mass, radiative_efficiency=None, radius=None)[source]#

Get the eddington accretion rate

One of either radiative efficiency or radius must be provided.

Parameters:

massQuantity [mass]: Mass
radiative_efficiencyndarray, optional: Fraction of radiated mass that is accreted, by default None
radiusQuantity [length], optional: Radius, by default None

Returns:

eddington_rateQuantity [mass / time]: Eddington accretion rate

Raises:

ValueError: If neither radiative efficiency or radius are provided