mcfacts.external.DiskModelsPAGN

Interface with pAGN

Classes

AGNGasDiskModel([disk_type])

mcfacts.external.DiskModelsPAGN.CI_jm17_iso(dSigmadR, dTdR)

Method to calculate the locally isothermal torque coefficient for the Jiménez and Masset 2017 values.

Parameters:

  • dSigmadR (float/array) – Discrete array representing the log surface density gradient in the disk.

  • dTdR (float/array) – Discrete array representing the log thermal gradient in the disk.

Returns:

cI – Jiménez and Masset 2017 migration locally isothermal torque coefficient

Return type:

float/array

mcfacts.external.DiskModelsPAGN.CI_jm17_tot(dSigmadR, dTdR, gamma, obj)

Method to calculate torque coefficient for the Jiménez and Masset 2017 values.

Parameters:

  • dSigmadR (float/array) – Discrete array representing the log surface density gradient in the disk.

  • dTdR (float/array) – Discrete array representing the log thermal gradient in the disk.

  • gamma (float) – Adiabatic index

  • obj (object) – Either a SirkoAGN or ThompsonAGN object representing the AGN disk being considered.

Returns:

cI – Jiménez and Masset 2017 migration torque coefficient

Return type:

float/array

mcfacts.external.DiskModelsPAGN.CI_p10(dSigmadR, dTdR)

Method to calculate torque coefficient for the Paardekooper et al. 2010 values.

Parameters:

  • dSigmadR (float/array) – Discrete array representing the log surface density gradient in the disk.

  • dTdR (float/array) – Discrete array representing the log thermal gradient in the disk.

Returns:

cI – Paardekooper et al. 2010 migration torque coefficient

Return type:

float/array

mcfacts.external.DiskModelsPAGN.CL(dSigmadR, dTdR, gamma, obj)

Method to calculate the Lindlblad torque for the Jiménez and Masset 2017 values.

Parameters:

  • dSigmadR (float/array) – Discrete array representing the log surface density gradient in the disk.

  • dTdR (float/array) – Discrete array representing the log thermal gradient in the disk.

  • gamma (float) – Adiabatic index

  • obj (object) – Either a SirkoAGN or ThompsonAGN object representing the AGN disk being considered.

Returns:

cL – Jiménez and Masset 2017 Lindblad torque coefficient

Return type:

float/array

mcfacts.external.DiskModelsPAGN.dPdR(obj)

Method that interpolates the total pressure gradient of an AGN disk object.

Parameters:

obj (object) – Either a SirkoAGN or ThompsonAGN object representing the AGN disk being considered.

Returns:

dPdR – Discrete array of the log total pressure gradient.

Return type:

float/array

mcfacts.external.DiskModelsPAGN.dSigmadR(obj)

Method that interpolates the surface density gradient of an AGN disk object.

Parameters:

obj (object) – Either a SirkoAGN or ThompsonAGN object representing the AGN disk being considered.

Returns:

dSigmadR – Discrete array of the log surface density gradient.

Return type:

float/array

mcfacts.external.DiskModelsPAGN.dTdR(obj)

Method that interpolates the thermal gradient of an AGN disk object.

Parameters:

obj (object) – Either a SirkoAGN or ThompsonAGN object representing the AGN disk being considered.

Returns:

dTdR – Discrete array of the log thermal gradient.

Return type:

float/array

mcfacts.external.DiskModelsPAGN.gamma_0(q, hr, Sigma, r, Omega)

Method to find the normalization torque

Parameters:

  • q (float/array) – Float or array representing the mass ratio between the migrator and the central BH.

  • hr (float/array) – Float or array representing the disk height to distance from central BH ratio.

  • Sigma (float/array) – Float or array representing the disk surface density in kg/m^2

  • r (float/array) – Float or array representing the distance from the central BH in m

  • Omega (float/array) – Float or array representing the angular velocity at the migrator position in SI units.

Returns:

gamma_0 – Float or array representing the single-arm migration torque on the migrator in kg m^2/ s^2.

Return type:

float/array

mcfacts.external.DiskModelsPAGN.gamma_ad(dSigmadR, dTdR)

Method to find the adiabatic torque.

Parameters:

  • dSigmadR (float/array) – Discrete array representing the log surface density gradient in the disk.

  • dTdR (float/array) – Discrete array representing the log thermal gradient in the disk.

Returns:

gamma_ad – Float or array representing the adabiatic torque on the migrator in kg m^2/ s^2.

Return type:

float/array

mcfacts.external.DiskModelsPAGN.gamma_iso(dSigmadR, dTdR)

Method to find the locally isothermal torque.

Parameters:

  • dSigmadR (float/array) – Discrete array representing the log surface density gradient in the disk.

  • dTdR (float/array) – Discrete array representing the log thermal gradient in the disk.

Returns:

gamma_iso – Float or array representing the locally isothermal torque on the migrator in kg m^2/ s^2.

Return type:

float/array

mcfacts.external.DiskModelsPAGN.gamma_thermal(gamma, obj, q)

Method to calculate the thermal torque from the Masset 2017 equations, with decay and torque saturation.

Parameters:

  • gamma (float) – Adiabatic index

  • obj (object) – Either a SirkoAGN or ThompsonAGN object representing the AGN disk being considered.

  • q (float/array) – Float or array representing the mass ratio between the migrator and the central BH.

Returns:

g_thermal – Masset 2017 migration total thermal torque.

Return type:

float/array