synthesizer.particle.blackholes¶
A module for working with arrays of black holes.
Contains the BlackHoles class for use with particle based systems. This houses all the data detailing collections of black hole particles. Each property is stored in (N_bh, ) shaped arrays for efficiency.
When instantiate a BlackHoles object a myriad of extra optional properties can be set by providing them as keyword arguments.
Example usages:
- bhs = BlackHoles(masses, metallicities,
redshift=redshift, accretion_rate=accretion_rate, …)
Classes
- class synthesizer.particle.blackholes.BlackHoles(masses, accretion_rates, epsilons=0.1, inclinations=None, spins=None, metallicities=None, redshift=None, coordinates=None, velocities=None, softening_lengths=None, smoothing_lengths=None, centre=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'), tau_v=None, fesc=None, **kwargs)[source]¶
The base BlackHoles class. This contains all data a collection of black holes could contain. It inherits from the base Particles class holding attributes and methods common to all particle types.
The BlackHoles class can be handed to methods elsewhere to pass information about the stars needed in other computations. For example a Galaxy object can be initialised with a BlackHoles object for use with any of the Galaxy helper methods.
Note that due to the many possible operations, this class has a large number ofoptional attributes which are set to None if not provided.
- nbh¶
The number of black hole particles in the object.
- Type:
int
- smoothing_lengths¶
The smoothing length describing the black holes neighbour kernel.
- Type:
array-like, float
- particle_spectra¶
A dictionary of Sed objects containing any of the generated particle spectra.
- Type:
dict