synthesizer.components.blackhole

A module for holding blackhole emission models.

The class defined here should never be instantiated directly, there are only ever instantiated by the parametric/particle child classes. BlackholesComponent is a child class of Component.

Classes

class synthesizer.components.blackhole.BlackholesComponent(fesc, mass=None, accretion_rate=None, epsilon=0.1, accretion_rate_eddington=None, inclination=unyt_quantity(0., 'degree'), spin=None, bolometric_luminosity=None, metallicity=None, ionisation_parameter_blr=0.1, hydrogen_density_blr=unyt_quantity(1.e+09, 'cm**(-3)'), covering_fraction_blr=0.1, velocity_dispersion_blr=unyt_quantity(2000, 'km/s'), ionisation_parameter_nlr=0.01, hydrogen_density_nlr=unyt_quantity(10000., 'cm**(-3)'), covering_fraction_nlr=0.1, velocity_dispersion_nlr=unyt_quantity(500, 'km/s'), theta_torus=unyt_quantity(10, 'degree'), **kwargs)

The parent class for black hole components of a galaxy.

This class contains the attributes and spectra creation methods which are common to both parametric and particle stellar components.

This should never be instantiated directly, instead it provides the common functionality and attributes used by the child parametric and particle BlackHole/s classes.

spectra

A dictionary containing black hole spectra.

Type:

dict, Sed

mass

The mass of each blackhole.

Type:

np.ndarray of float

accretion_rate

The accretion rate of each blackhole.

Type:

np.ndarray of float

epsilon

The radiative efficiency of the blackhole.

Type:

np.ndarray of float

accretion_rate_eddington

The accretion rate expressed as a fraction of the Eddington accretion rate.

Type:

np.ndarray of float

inclination

The inclination of the blackhole disc.

Type:

np.ndarray of float

spin

The dimensionless spin of the blackhole.

Type:

np.ndarray of float

bolometric_luminosity

The bolometric luminosity of the blackhole.

Type:

np.ndarray of float

metallicity

The metallicity of the blackhole which is assumed for the line emitting regions.

Type:

np.ndarray of float

Attributes (For EmissionModels):

ionisation_parameter_blr (np.ndarray of float):

The ionisation parameter of the broad line region.

hydrogen_density_blr (np.ndarray of float):

The hydrogen density of the broad line region.

covering_fraction_blr (np.ndarray of float):

The covering fraction of the broad line region (effectively the escape fraction).

velocity_dispersion_blr (np.ndarray of float):

The velocity dispersion of the broad line region.

ionisation_parameter_nlr (np.ndarray of float):

The ionisation parameter of the narrow line region.

hydrogen_density_nlr (np.ndarray of float):

The hydrogen density of the narrow line region.

covering_fraction_nlr (np.ndarray of float):

The covering fraction of the narrow line region (effectively the escape fraction).

velocity_dispersion_nlr (np.ndarray of float):

The velocity dispersion of the narrow line region.

theta_torus (np.ndarray of float):

The angle of the torus.

torus_fraction (np.ndarray of float):

The fraction of the torus angle to 90 degrees.

disc_transmission (np.ndarray of str):

The disc transmission scenario used by UnifiedAGN. Can either be “none”, “blr”, or “nlr”.

transmission_fraction_escape (np.ndarray of float):

The fraction of the disc emission that escapes. Either 0.0 or 1.0 depending on the scenario.

transmission_fraction_nlr (np.ndarray of float):

The fraction of the disc emission that is transmitted through the NLR. Either 0.0 or 1.0 depending on the scenario.

transmission_fraction_blr (np.ndarray of float):

The fraction of the disc emission that is transmitted through the BLR. Either 0.0 or 1.0 depending on the scenario.

calculate_accretion_rate()

Calculate the black hole accretion rate from the eddington ratio.

This is used when accretion rate is provided in terms of the Eddington ratio and not the explicit accretion rate.

Returns:

The black hole accretion rate

Return type:

unyt_array

calculate_accretion_rate_eddington()

Calculate the black hole accretion in units of the Eddington rate.

Returns:

unyt_array

The black hole accretion rate in units of the Eddington rate.

calculate_bb_temperature()

Calculate the black hole big bump temperature.

This is used in the cloudy disc model.

Returns:

The black hole big bump temperature

Return type:

unyt_array

calculate_bolometric_luminosity()

Calculate the black hole bolometric luminosity.

Returns:

The black hole bolometric luminosity

Return type:

unyt_array

calculate_circular_velocity(radial_distance)

Calculate the circular velocity.

v_c(r) = \sqrt{frac{G M(<r)}{r}}.

Parameters:

radial_distance (np.ndarray of float) – The distance from the blackhole.

Returns:

The circular velocity at the radial distance.

Return type:

unyt_array

calculate_eddington_luminosity()

Calculate the eddington luminosity of the black hole.

Returns:

unyt_array

The black hole eddington luminosity in solar luminosities

calculate_eddington_ratio()

Calculate the eddington ratio of the black hole.

Returns:

The black hole eddington ratio

Return type:

unyt_array

calculate_integrated_ionising_luminosity()

Calculates the integrated ionising luminosity of the blackhole(s).

This requires that the disc_incident spectra be available.

Returns:

The ionising photon production rate (s^-1).

Return type:

unyt_array

calculate_ionisation_parameter(radial_distance, hydrogen_density)

Calculate the ionisation parameter.

Calculates the ionising parameter (U) at radial_distance for the given hydrogen_density.

U = frac{Q_{mathrm{H}}}{4pi r^{2} n_{mathrm{H}} c}

Parameters:

• radial_distance (np.ndarray of float) – The distance from the blackhole.

• hydrogen_density (np.ndarray of float) – The hydrogen density at radial_distance.

Returns:

The ionisation parameter.

Return type:

unyt_array

calculate_schwarzschild_radius()

Calculate the Schwarzschild radius of the blackhole(s).

R_{rm s} = frac{2GM}{c^2}

Returns:

The Schwarzschild radius.

Return type:

unyt_array