BlackHole

class dysmalpy.models.BlackHole(**kwargs)[source]

Bases: MassModel

Central black hole. Treated as a point source at r = 0.

Parameters:: BH_mass (float) – Log10 of the mass in solar units

Attributes Summary

`BH_mass`
`baryon_type`
`param_names`	Names of the parameters that describe models of this type.

Methods Summary

`circular_velocity`(r)	Circular velocity as a function of radius
`enclosed_mass`(r)	Central black hole enclosed mass (treat as step function)
`evaluate`(r, BH_mass)	Mass surface density of a BH (treat like delta function)
`light_profile`(r)	Conversion from mass to light as a function of radius
`projected_enclosed_mass`(r)

Attributes Documentation

BH_mass = DysmalParameter('BH_mass', value=1.0, bounds=(0.0, 12.0), prior=<dysmalpy.parameters.UniformPrior object>)

baryon_type = 'blackhole'

param_names = ('BH_mass',)

Names of the parameters that describe models of this type.

The parameters in this tuple are in the same order they should be passed in when initializing a model of a specific type. Some types of models, such as polynomial models, have a different number of parameters depending on some other property of the model, such as the degree.

When defining a custom model class the value of this attribute is automatically set by the Parameter attributes defined in the class body.

Methods Documentation

circular_velocity(r)[source]

Circular velocity as a function of radius

Parameters:: r (float or array) – Radii at which to calculate the enclosed mass
Returns:: vcirc – Circular velocity in km/s
Return type:: float or array

enclosed_mass(r)[source]

Central black hole enclosed mass (treat as step function)

Parameters:: r (float or array) – Radii at which to calculate the enclosed mass
Returns:: menc – Enclosed mass profile (unit: Msun)
Return type:: float or array

static evaluate(r, BH_mass)[source]: Mass surface density of a BH (treat like delta function)

light_profile(r)[source]

Conversion from mass to light as a function of radius: Assuming NO LIGHT emitted by central BH (eg, ignoring any emission in surrounding medium, eg flares)

Parameters:: r (float or array) – Radii at which to calculate the enclosed mass
Returns:: light – Relative line flux as a function of radius
Return type:: float or array

projected_enclosed_mass(r)[source]