holodeck.accretion

Massive Black Hole Binary (MBHB) accretion models to evolve individual Massive Black Hole (MBH) masses using the illustris accretion rates.

Authors

Magdalena Siwek

class holodeck.accretion.Accretion(accmod='Basic', f_edd=0.01, mdot_ext=None, eccen=0.0, subpc=True, **kwargs)[source]

Preferential Accretion prescription

accmod

Type:: {‘Basic’, ‘Proportional’, ‘Primary’, ‘Secondary’, ‘Siwek22’, ‘Duffell’}, optional

f_edd

Type:: double, optional

mdot_ext

Type:: Any, optional

eccen

Type:: float, optional

subpc

Type:: boolean, optional

:meth:`mdot_eddington(mass)`: Calculate the total accretion rate based on masses and a fraction of the Eddington limit.

:meth:`pref_acc(mdot, evol, step)`: Contains a variety of accretion models to choose from to calculate primary vs secondary accretion rates.

mdot_eddington(mass, eps=0.1)[source]

Calculate the total accretion rate based on masses and a fraction of the Eddington limit.

mass : float eps : float, optional

Radiative efficiency epsilon. Defaults to 0.1.

medd : float

holodeck.constants : constants used for calculation of the accretion rate.

The limiting Eddington accretion rate is defined as: .. math:: `dot{M}_{mathsf{Edd}} =

rac{4 pi GM m_p}{epsilon c sigma_{mathsf{T}}`

>>> acc = Accretion()
>>> mass =
>>> print(acc.mdot_eddington(mass))

pref_acc(mdot, evol, step)[source]

Contains a variety of accretion models to choose from to calculate primary vs secondary accretion rates.

The accretion models are as follows: * Basic * Primary * Secondary * Proportional * Siwek22 * Duffell

Parameters:

mdot – Gas inflow rate in solar masses. Units of [M/year]
evol – evolution class instance which contains the eccentricities of the current evolution
step (int) – current timestep

Returns:

mdot_arr – Array of accretion rates for each binary in the timestep.

Return type:

ndarray