Atomic Recombination Cooling¶
Class providing recombination cooling rate coefficients (in cm\(^3\) s\(^{-1}\)) for ions of given atomic number and ionization state at a specified electron temperature. When a free electron recombines radiatively with an ion it releases energy both in the emitted photon and in the kinetic energy difference; the cooling rate coefficient quantifies this energy loss from the gas per recombination event. Case A (all recombinations) and case B (excluding direct recombinations to the ground state) coefficients are supported, consistent with the corresponding radiative recombination rate classes.
Default implementation: atomicRecombinationRateRadiativeCoolingHummer
Methods¶
rate→double precisionReturns the recombination cooling rate coefficient in units of cm\(^3\) s\(^{-1}\).
integer , intent(in ) :: atomicNumber, ionizationStatedouble precision , intent(in ) :: temperaturetype (enumerationRecombinationCaseType), intent(in ), optional :: level
atomicRecombinationRateRadiativeCoolingComputed¶
Atomic radiative cooling rates computed from the corresponding photoionization cross section using detailed balance (i.e. the Milne relation—see for example “Astrophysics of the Diffuse Universe” by Dopita & Sutherland, 2004, Springer Science & Business Media, section 5.3.3).
atomicRecombinationRateRadiativeCoolingFixed¶
Atomic radiative cooling rates which are a fixed multiple of the recombination rate, \(\beta = \gamma \alpha\) where \(\alpha\) is the corresponding radiative recombination coefficient and \(\gamma\) is a parameter.
Parameters
[mass](default100.0d0) — The fixed mass (in \(\mathrm{M}_\odot\)) assigned to all newly-formed seed black holes in this implementation, representing the initial black hole mass when a halo first forms a central black hole.[spin](default0.0d0) — The dimensionless spin parameter (between \(-1\) and \(+1\)) assigned to all newly-formed seed black holes, where \(0\) corresponds to a non-rotating Schwarzschild black hole and \(\pm 1\) to a maximally rotating Kerr black hole.[fraction](default0.01d0) — The fixed fraction \(f_\mathrm{outflow}\) of the stellar energy input rate (normalized to a canonical \(1\,\mathrm{M}_\odot\) population) that drives gas outflows, setting the mass loading factor for stellar feedback in the galaxy.[escapeFraction](default0.006d0) — Escape fraction of ionizing photons from young HII regions.[ageLimit](default0.03d0) — The age beyond which all ionizing photons are assumed to escape from HII regions.[timescale](default1.0d0) — The timescale for star formation in the fixed timescale model.[rateStarFormation](default1.0d9) — The rate of star formation in units of \(\mathrm{M}_\odot \hbox{Gyr}^{-1}\).[proposalSize]— The fixed value of the proposal scaling parameter \(\gamma\) used to scale the vector difference between two randomly selected chain states when forming differential evolution proposals.[exponentValue]— The fixed value of the temperature-scaling exponent \(\alpha\) by which the proposal size \(\gamma\) is scaled as \(\gamma \propto T^{\alpha}\) in tempered differential evolution runs.[massResolution](default5.0d9) — The mass resolution to use when building merger trees.[rootVariance]— The root variance of the random error distribution.[velocityRadial](default-0.90d0) — The radial velocity (in units of the host virial velocity) to used for the fixed virial orbits distribution. Default value matches approximate peak in the distribution of Benson (2005).[velocityTangential](default0.75d0) — The tangential velocity (in units of the host virial velocity) to used for the fixed virial orbits distribution. Default value matches approximate peak in the distribution of Benson (2005).[rateCoefficient]— The rate coefficient (in units of cm\(^3\) s\(^{-1}\)) for radiative recombination.[gamma](default0.67d0) — The multiplicative factor, \(\gamma\), used to compute the cooling coefficient.[fractionLossAngularMomentum](default0.3d0) — Specifies the fraction of angular momentum that is lost from cooling/infalling gas.[concentration]— The fixed NFW concentration parameter \(c = r_\mathrm{virial}/r_\mathrm{scale}\) assigned to all halos regardless of mass or redshift, representing the ratio of the virial radius to the scale radius of the dark matter density profile.[metallicity]— The metallicity (relative to Solar) of the IGM.[factor](defaultsqrt(0.5d0)) — The ratio of galaxy radius to \(\lambda r_\mathrm{vir}\) in the “fixed” galactic structure radius solver algorithm. This will be applied to any component for which no component-specific value is provided.[factorDisk](defaultsqrt(0.5d0)) — The ratio of galaxy radius to \(\lambda r_\mathrm{vir}\) in the “fixed” galactic structure radius solver algorithm for disks. This will override the generic value supplied by[factor]for disks.[factorSpheroid](defaultsqrt(0.5d0)) — The ratio of galaxy radius to \(\lambda r_\mathrm{vir}\) in the “fixed” galactic structure radius solver algorithm for spheroids. This will override the generic value supplied by[factor]for spheroids.[radiusFixed](defaultvar_str('virial')) — The radius to use in the “fixed” galactic structure radius solver algorithm. Allowed options are “virial” and “turnaround”.[overdensity]— The fixed linear overdensity \(\delta\) of the large-scale environment assigned uniformly to all halos; a positive value places halos in an overdense region, while negative values simulate voids.[radiusEnvironment](default0.0d0) — The radius of the sphere used to determine the variance in the environmental density.[massEnvironment](default1.0d15) — The mass within the sphere sphere used to determine the variance in the environmental density.[densityContrastValue](default200.0d0) — The virial density contrast to use in the fixed value model.[densityType](defaultvar_str('critical')) — The reference density to use in the fixed value virial density contrast model. Either ofcriticalandmeanare allowed.[turnAroundOverVirialRadius](default2.0d0) — The ratio of the turnaround to virial radii in the fixed value model.[criticalOverdensity](default(3.0d0/20.0d0)*(12.0d0*Pi)**(2.0d0/3.0d0)) — The value to use for the critical overdensity for collapse of dark matter halos when using a fixed value.
atomicRecombinationRateRadiativeCoolingHummer¶
Atomic radiative cooling rates based on the tabulated results of Hummer (1994) and Hummer and Storey (1998). For non-hydrogenic or helium-like ions an optional default of \(\beta = \gamma \alpha\) can be returned where \(\alpha\) is the corresponding radiative recombination coefficient and \(\gamma\) is a parameter.
(Default implementation)
Parameters
[gamma](default0.67d0) — The multiplicative factor, \(\gamma\), used to compute the cooling coefficient in cases of non-hydrogenic or helium-like ions.