Dark Matter Profile Concentrations

Class providing the concentration parameter \(c = r_\mathrm{vir}/r_\mathrm{s}\) of dark matter halo density profiles, where \(r_\mathrm{vir}\) is the virial radius and \(r_\mathrm{s}\) is the characteristic scale radius. The concentration encodes the inner density structure of a halo and depends on halo mass and formation history. Implementations provide both the instantaneous concentration (i.e., including any scatter around the mean) and the mean concentration–mass relation, along with definitions of the density contrast and dark matter profile used in computing the concentration.

Default implementation: darkMatterProfileConcentrationGao2008

Methods

concentration → double precision

Returns the concentration parameter for the given node.

• type(treeNode), intent(inout), target :: node

concentrationMean → double precision

Returns the mean concentration parameter for a node of the given mass.

• type(treeNode), intent(inout), target :: node

densityContrastDefinition → class(virialDensityContrastClass)

Returns a virialDensityContrast object describing the virial density contrast used to define this concentration.

darkMatterProfileDMODefinition → class(darkMatterProfileDMOClass)

Returns a darkMatterProfileDMO object describing the dark matter density profile used to define this concentration.

darkMatterProfileConcentrationBrown2021

Dark matter halo concentrations are computed using the algorithm of Brown et al. (2022).

darkMatterProfileConcentrationBullock2001

Computes dark matter halo concentrations using the mass-collapse epoch relation of Bullock et al. (2001), in which concentration scales with the ratio of the virial radius to the collapse-epoch scale factor. The two free parameters of the model are [F], which determines the collapse mass fraction, and [K], which sets the concentration normalization.

Parameters

• [F] (default 0.01d0) — The parameter \(F\) appearing in the halo concentration algorithm of Bullock et al. (2001).

• [K] (default 4.0d0) — The parameter \(K\) appearing in the halo concentration algorithm of Bullock et al. (2001).

darkMatterProfileConcentrationCorrea2015

Computes dark matter halo concentrations using the accretion-history-based fitting function of Correa et al. (2015), which relates concentration to the mass accretion history of the halo through a power-law relation in redshift. The normalization of the concentration-mass relation is calibrated by the free parameter [A].

Parameters

• [A] (default 887.0d0) — The parameter \(A\) appearing in eqn. (17) of Correa et al. (2015).

darkMatterProfileConcentrationDiemerJoyce2019

Computes dark matter halo concentrations using the fitting function of Diemer and Joyce (2019), which models concentration as a function of the effective spectral slope of the matter power spectrum. The fitting parameters controlling the normalization and slopes of the concentration-mass relation are [kappa], [a0], [a1], [b0], and [b1].

Parameters

• [kappa] (default 0.41d0) — The parameter \(\kappa\) appearing in the halo concentration algorithm of Diemer and Joyce (2019).

• [a0] (default 2.45d0) — The parameter \(a_0\) appearing in the halo concentration algorithm of Diemer and Joyce (2019).

• [a1] (default 1.82d0) — The parameter \(a_1\) appearing in the halo concentration algorithm of Diemer and Joyce (2019).

• [b0] (default 3.20d0) — The parameter \(b_0\) appearing in the halo concentration algorithm of Diemer and Joyce (2019).

• [b1] (default 2.30d0) — The parameter \(b_1\) appearing in the halo concentration algorithm of Diemer and Joyce (2019).

• [cAlpha] (default 0.21d0) — The parameter \(c_{\alpha}\) appearing in the halo concentration algorithm of Diemer and Joyce (2019).

• [scatter] (default 0.0d0) — The scatter (in dex) to assume in the halo concentration algorithm of Diemer and Joyce (2019).

• [truncateConcentration] (default .false.) — If false, solutions to equation (30) of Diemer and Joyce (2019) requiring \(x<1\) will cause a fatal error. If true, such cases are simply truncated to \(x=1\).

• [includeUpturn] (default .true.) — If true, the term modeling the upturn in the \(c(M)\) relation at high masses (i.e. \([1+\nu^2/B(n)]\) in equation (28) of Diemer and Joyce 2019) is included. Otherwise this term is set equal to \(1\) so that no upturn occurs.

• [truncateUpturn] (default .false.) — If true, the term modeling the upturn in the \(c(M)\) relation at high masses (i.e. \([1+\nu^2/B(n)]\) in equation (28) of Diemer and Joyce 2019) will be truncated at \(\nu=\sqrt{B(n)}\) where the right-hand side of equation (28) reaches the minimum, i.e. for any \(\nu>\sqrt{B(n)}\), the right-hand side of equation (28) will be truncated to \(2 A/\sqrt{B}\).

darkMatterProfileConcentrationDiemerKravtsov2014

A dark matter profile concentration class in which the concentration is computed using a fitting function from Diemer and Kravtsov (2015):

\[c = {c_\mathrm{min} \over 2} \left[ \left({\nu\over\nu_\mathrm{min}}\right)^{-\alpha} + \left({\nu\over\nu_\mathrm{min}}\right)^{\beta} \right],\]

where \(c_\mathrm{min}=\phi_0+\phi_1 n\), \(\nu_\mathrm{min}=\eta_0+\eta_1 n\), \(n\) is the logarithmic slope of the linear power spectrum at wavenumber \(k = \kappa 2 \pi / R\), \(R\) is the comoving Lagrangian radius of the halo, \(R=[3 M / 4 \pi \rho_\mathrm{M}(z=0)]^{1/3}\), and \(\nu=\delta_\mathrm{crit}(t)/\sigma(M)\) is the peak height parameter. The numerical parameters \((\kappa,\phi_0,\phi_1,\eta_0,\eta_1,\alpha,\beta)\) are set by the parameters [kappa], [phi0], [phi1], [eta0], [eta1], [alpha], [beta], respectively, and default to the values given in Table 3 of Diemer and Kravtsov (2015) for the median relation, namely \((0.69,6.58,1.37,6.82,1.42,1.12,1.69)\).

Parameters

• [kappa] (default 0.69d0) — The parameter \(\kappa\) appearing in the halo concentration algorithm of Diemer and Kravtsov (2015).

• [phi0] (default 6.58d0) — The parameter \(\phi_0\) appearing in the halo concentration algorithm of Diemer and Kravtsov (2015).

• [phi1] (default 1.37d0) — The parameter \(\phi_1\) appearing in the halo concentration algorithm of Diemer and Kravtsov (2015).

• [eta0] (default 6.82d0) — The parameter \(\eta_0\) appearing in the halo concentration algorithm of Diemer and Kravtsov (2015).

• [eta1] (default 1.42d0) — The parameter \(\eta_1\) appearing in the halo concentration algorithm of Diemer and Kravtsov (2015).

• [alpha] (default 1.12d0) — The parameter \(\alpha\) appearing in the halo concentration algorithm of Diemer and Kravtsov (2015).

• [beta] (default 1.69d0) — The parameter \(\beta\) appearing in the halo concentration algorithm of Diemer and Kravtsov (2015).

• [scatter] (default 0.0d0) — The scatter (in dex) to assume in the halo concentration algorithm of Diemer and Kravtsov (2015).

darkMatterProfileConcentrationDuttonMaccio2014

A dark matter profile concentration class in which the concentration is computed using a fitting function from Dutton and Macciò (2014):

\[\log_{10} c = A + B \log_{10} M_\mathrm{halo}.\]

The parameters are a function of redshift, \(z\). We use the following fit suggested by Dutton and Macciò (2014) results:

\[\begin{split}A & = A_1+(A_2-A_1)\exp[A_3 z^{A_4}] \nonumber \\ B & = B_1+B_2 z.\end{split}\]

The coefficients are chosen from one of the three sets given by Dutton and Macciò (2014), controlled via the [duttonMaccio2014FitType] parameter, as described in Table 3.

Table 3 Coefficients appearing in the dark matter halo profile concentration fitting functions of Dutton and Macciò (2014). The “fit type” is specified by the [duttonMaccio2014FitType] parameter.

Fit type	Profile	\(\Delta_\mathrm{vir}\)	\(A_1\)	\(A_2\)	\(A_3\)	\(A_4\)	\(B_1\)	\(B_2\)
nfwVirial	NFW	Top-hat	\(+0.537\)	\(+1.025\)	\(-0.718\)	\(+1.080\)	\(-0.097\)	\(+0.024\)
nfw200	NFW	200	\(+0.520\)	\(+0.905\)	\(-0.617\)	\(+1.210\)	\(-0.101\)	\(+0.026\)
einasto200	Einasto	200	\(+0.459\)	\(+0.977\)	\(-0.490\)	\(+1.303\)	\(-0.130\)	\(+0.029\)

Methods

• definitions — Establish definitions for virial density contrast and dark matter halo profile.

Parameters

• [fitType] (default var_str('nfwVirial')) — The type of halo definition for which the concentration-mass relation should be computed. Allowed values are nfwVirial, nfwCritical200, einastoCritical200, and userDefined.

• [a1] — Parameter \(a_1\) in the Dutton and Macciò (2014) halo concentration–mass relation.

• [a2] — Parameter \(a_2\) in the Dutton and Macciò (2014) halo concentration–mass relation.

• [a3] — Parameter \(a_3\) in the Dutton and Macciò (2014) halo concentration–mass relation.

• [a4] — Parameter \(a_4\) in the Dutton and Macciò (2014) halo concentration–mass relation.

• [b1] — Parameter \(b_1\) in the Dutton and Macciò (2014) halo concentration–mass relation.

• [b2] — Parameter \(b_2\) in the Dutton and Macciò (2014) halo concentration–mass relation.

darkMatterProfileConcentrationFixed

Dark matter halo concentrations are computed using a fixed value for concentration.

Parameters

• [mass] (default 100.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] (default 0.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] (default 0.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] (default 0.006d0) — Escape fraction of ionizing photons from young HII regions.

• [ageLimit] (default 0.03d0) — The age beyond which all ionizing photons are assumed to escape from HII regions.

• [timescale] (default 1.0d0) — The timescale for star formation in the fixed timescale model.

• [rateStarFormation] (default 1.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] (default 5.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] (default 0.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] (default 0.67d0) — The multiplicative factor, \(\gamma\), used to compute the cooling coefficient.

• [fractionLossAngularMomentum] (default 0.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] (default sqrt(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] (default sqrt(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] (default sqrt(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] (default var_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] (default 0.0d0) — The radius of the sphere used to determine the variance in the environmental density.

• [massEnvironment] (default 1.0d15) — The mass within the sphere sphere used to determine the variance in the environmental density.

• [densityContrastValue] (default 200.0d0) — The virial density contrast to use in the fixed value model.

• [densityType] (default var_str('critical')) — The reference density to use in the fixed value virial density contrast model. Either of critical and mean are allowed.

• [turnAroundOverVirialRadius] (default 2.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.

darkMatterProfileConcentrationGao2008

A dark matter profile concentration class in which the concentration is computed using a fitting function from Gao et al. (2008):

\[\log_{10} c = A \log_{10} M_\mathrm{halo} + B.\]

The parameters are a function of expansion factor, \(a\). We use the following fits to the Gao et al. (2008) results:

\[\begin{split}A & = -0.140 \exp\left[-\left(\left\{\log_{10}a+0.05\right\}/0.35\right)^2\right], \\ B & = 2.646 \exp\left[-\left(\log_{10}a/0.50\right)^2\right].\end{split}\]

(Default implementation)

Parameters

• [scatter] (default 0.0d0) — The scatter (in dex) to assume in the halo concentration distribution at fixed mass.

darkMatterProfileConcentrationKlypin2015

Computes dark matter halo concentrations using the fitting functions calibrated from the MultiDark simulations by Klypin et al. (2016). The specific fitting function applied depends on the halo sample selected via [sample], which controls the density contrast definition and the simulation suite used for calibration.

Parameters

• [sample] (default var_str('all')) — The sample to use for the halo shape parameter algorithm of Klypin et al. (2016).

• [sample] (default var_str('planck200CritRelaxedMass')) — The sample to use for the halo concentration algorithm of Klypin et al. (2016).

darkMatterProfileConcentrationLudlow2016Fit

Dark matter halo concentrations are computed using the fitting function of Ludlow et al. (2016).

darkMatterProfileConcentrationMunozCuartas2011

A dark matter profile concentration class in which the concentration is computed using a fitting function from Muñoz-Cuartas et al. (2011):

\[\log_{10} c = a \log_{10} \left( {M_\mathrm{halo} \over h^{-1}\mathrm{M}_\odot} \right) + b.\]

The parameters are a function of redshift, \(z\), given by

\[\begin{split}a & = wz-m, \\ b & = {\alpha \over (z+\gamma)} + {\beta \over (z+\gamma)^2},\end{split}\]

where \(w=0.029\), \(m=0.097\), \(\alpha=-110.001\), \(\beta=2469.720\), \(\gamma=16.885\).

darkMatterProfileConcentrationNFW1996

A dark matter profile concentration class in which the concentration is computed using the algorithm from Navarro et al. (1996). In this algorithm, for a given halo of mass \(M\) at time \(t_0\), a formation time is defined as the epoch at which there is a 50% probability (according to extended Press-Schechter theory) for a progenitor halo to have a mass greater than \(fM\), where \(f=\)[f] is a parameter of the algorithm. This implies formation when the critical overdensity for collapse is

\[\delta_\mathrm{crit}(t_\mathrm{form}) = \left[ 2 \nu_{1/2}^2 \left\{\sigma(fM)^22-\sigma(M)^2\right\} \right]^{1/2}+\delta_\mathrm{crit}(t_0),\]

where \(\nu_{1/2} = [\hbox{erfc}^{-1}(1/2)]^{1/2}\). Navarro et al. (1996) then assume an overdensity at collapse of

\[\Delta(t_\mathrm{form}) = C \left[ {a(t_0) \over a(t_\mathrm{form})} \right]^3\]

where \(C=\)[C] is a parameter of the algorithm. The concentration is then determined by solving

\[{\Delta(t_\mathrm{form}) \over \Delta_\mathrm{virial}(t_0)} = {c^3 \over 3 [\ln(1+c)-c/(1+c)]}.\]

Methods

• radiusEnclosingDensityTabulate — Tabulate the radius enclosing a given density as a function of density and core radius.

• radiusEnclosingMassTabulate — Tabulate the radius enclosing a given mass as a function of density and core radius.

• energyTabulate — Tabulate the energy as a function of concentration and core radius.

• densityScaleFree — The density of the profile in units where the mass and scale length are both 1.

• massEnclosedScaleFree — The mass enclosed of the profile in units where the mass and scale length are both 1.

• storeDensityTable — Store the tabulated radius-enclosing-density to file.

• restoreDensityTable — Attempt to restore the tabulated radius-enclosing-density from file, returning true if successful.

• storeMassTable — Store the tabulated radius-enclosing-mass to file.

• restoreMassTable — Attempt to restore the tabulated radius-enclosing-mass from file, returning true if successful.

• storeEnergyTable — Store the tabulated energy to file.

• restoreEnergyTable — Attempt to restore the tabulated energy from file, returning true if successful.

• suffix — Return a file name suffix (containing a source code digest.

Parameters

• [useSeriesApproximation] (default .true.) — If true, use a fast series approximation to the velocity dispersion profile in an NFW mass distribution. The approximation matches the exact (dilogarithm-based) form to better than \(5\times 10^{-6}\) in relative terms across \(r/r_\mathrm{s} \in [10^{-4},10^4]\) (see tests.kinematic_distributions.NFW).

• [velocityDispersionUseSeriesExpansion] (default .true.) — If true, radial velocity dispersion is computed using series expansion.

• [lengthResolution] — The gravitational softening length \(\Delta x\) (in Mpc) of the N-body simulation used to smooth the NFW profile at small radii, preventing artificial divergence below the resolution scale.

• [massResolution] — The mass resolution \(\Delta M\) (in \(\mathrm{M}_\odot\)) of the N-body simulation, used to determine the finite-resolution softening of the NFW profile for halos near the resolution limit.

• [resolutionIsComoving] — If true, the resolution length is assumed to be fixed in comoving coordinates, otherwise in physical coordinates.

• [nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.

• [f] (default 0.01d0) — The parameter \(f\) appearing in the halo concentration algorithm of Navarro et al. (1996).

• [C] (default 2000.0d0) — The parameter \(C\) appearing in the halo concentration algorithm of Navarro et al. (1996).

• [densityNormalization] (default 1.0d0/2.0d0/Pi/(log(4.0d0)-1.0d0)) — The density normalization of the NFW profile.

• [scaleLength] (default 1.0d0) — The NFW scale radius (in Mpc) \(r_\mathrm{s}\) at which the density profile transitions from the inner \(\rho \propto r^{-1}\) to the outer \(\rho \propto r^{-3}\) slope.

• [mass] (default 1.0d0) — The total mass (in \(\mathrm{M}_\odot\)) of the NFW profile, used to set the density normalization when the concentration and virial radius are provided.

• [concentration] (default 1.0d0) — The halo concentration parameter \(c = r_\mathrm{vir}/r_\mathrm{s}\) of the NFW profile, controlling how centrally concentrated the dark matter density profile is.

• [virialRadius] (default 1.0d0) — The virial radius (in Mpc) \(r_\mathrm{vir}\) of the NFW halo, which defines the outer boundary of the profile at which the mean enclosed density equals the virial overdensity threshold.

• [dimensionless] (default .true.) — If true the NFW profile is considered to be dimensionless.

• [componentType] (default var_str('unknown')) — The component type that this mass distribution represents.

• [massType] (default var_str('unknown')) — The mass type that this mass distribution represents.

• [lengthResolution] — The spatial resolution length scale (in Mpc) of the N-body simulation being modeled; sets the minimum effective radius below which the NFW density profile is softened.

• [radiusScale] — The NFW scale radius (in Mpc) at which the density profile transitions from the inner \(\rho \propto r^{-1}\) slope to the outer \(\rho \propto r^{-3}\) slope.

• [radiusVirial] — The virial radius (in Mpc) of the halo, defining the outer boundary of the NFW profile at which the mean enclosed density equals the virial overdensity threshold.

• [mass] — The total mass (in \(\mathrm{M}_\odot\)) enclosed within the virial radius, used together with radiusScale and radiusVirial to normalize the NFW density profile.

• [componentType] (default var_str('unknown')) — The component type that this mass distribution represents.

• [massType] (default var_str('unknown')) — The mass type that this mass distribution represents.

darkMatterProfileConcentrationPrada2011

A dark matter profile concentration class in which the concentration is computed using a fitting function from Prada et al. (2012):

\[c(M,t) = B_0(x) \mathcal{C}(\sigma^\prime),\]

where

\[\begin{split}\sigma^\prime(M,t) & = B_1(x) \sigma(M,t), \\ B_0(x) & = c_\mathrm{min}(x)/c_\mathrm{min}(1.393), \\ B_1(x) & = \sigma^{-1}_\mathrm{min}(x)/\sigma^{-1}_\mathrm{min}(1.393), \\ c_\mathrm{min}(x) & = c_0 + (c_1-c_0) [\tan^{-1}\{\alpha (x-x_0)\}/\Pi+1/2], \\ \sigma^{-1}_\mathrm{min}(x) & = \sigma^{-1}_0 + (\sigma^{-1}_1-\sigma^{-1}_0) [\tan^{-1}\{\beta(x-x_1)\}/\Pi+1/2], \\ \mathcal{C}(\sigma^\prime) & = A [(\sigma^\prime)/b)^c+1] \exp(d/\sigma^{\prime 2}), \\ x & = (\Omega_\Lambda/\Omega_\mathrm{M})^{1/3} a(t),\end{split}\]

with the following parameters (default values taken from Prada et al. (2012) given in []): \(A=\)[A]\(=2.881\), \(b=\)[B]\(=1.257\), \(c=\)[C]\(=1.022\), \(d=\)[D]\(=0.060\), \(c_0=\)[C0]\(=3.681\), \(c_1=\)[C1]\(=5.033\), \(x_0=\)[X0]\(=0.424\), \(x_1=\)[X1]\(=0.526\), \(\sigma^{-1}_0=\)[sigma0]\(=1.047\), \(\sigma^{-1}_1=\)[sigma1]\(=1.646\), \(\alpha=\)[alpha]\(=6.948\), and \(\beta=\)[beta]\(=7.386\).

Parameters

• [A] (default 2.881d0) — The parameter \(A\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [B] (default 1.257d0) — The parameter \(b\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [C] (default 1.022d0) — The parameter \(c\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [D] (default 0.060d0) — The parameter \(d\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [C0] (default 3.681d0) — The parameter \(c_0\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [C1] (default 5.033d0) — The parameter \(c_1\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [X0] (default 0.424d0) — The parameter \(x_0\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [X1] (default 0.526d0) — The parameter \(x_1\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [inverseSigma0] (default 1.047d0) — The parameter \(\sigma^{-1}_0\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [inverseSigma1] (default 1.646d0) — The parameter \(\sigma^{-1}_1\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [alpha] (default 6.948d0) — The parameter \(\alpha\) appearing in the halo concentration algorithm of Prada et al. (2012).

• [beta] (default 7.386d0) — The parameter \(\beta\) appearing in the halo concentration algorithm of Prada et al. (2012).

darkMatterProfileConcentrationScatterShift

A dark matter profile concentration class in which the concentration is computed by shifting the results of another concentration class up/down by a specified number of \(\sigma\).

Parameters

• [scatter] — The scatter (in dex) to assume in the halo concentration distribution at fixed mass.

• [sigmaShift] — The number of standard deviations \(\sigma\) by which to shift the halo concentration from its mean value, allowing selection of halos with systematically higher or lower concentrations than average at fixed mass.

darkMatterProfileConcentrationSchneider2015

A dark matter profile concentration class in which the concentration using the algorithm of Schneider (2015). Specifically, a reference model for concentrations in defined in a specific cosmological model. The concentration for a halo of given mass, \(M\), and redshift, \(z_0\), is then found by finding the redshift of collapse, \(z_\mathrm{c}\) for the halo by solving:

\[\delta_\mathrm{c}(z_\mathrm{c}) = \left( {\pi \over 2} \left[ \sigma^2(f M) - \sigma^2(M) \right] \right)^{1/2}+\delta_\mathrm{c})(z_0),\]

where \(\delta_\mathrm{c}(z)\) is the critical overdensity for collapse at redshift \(z\), and \(f\) is the fraction of a halo’s mass assembled at formation time (given by the [massFractionFormation] parameter. From this, the mass of a halo in the reference model with the same redshift of collapse is found, and the reference model is used to compute the concentration of a halo of that mass.

Methods

• concentrationCompute — Compute the concentration for the given node

Parameters

• [massFractionFormation] (default 0.05d0) — The fraction of a halo’s mass assembled at “formation” in the halo concentration algorithm of Schneider (2015).

darkMatterProfileConcentrationWDM

A dark matter profile concentration class in which the concentration is computed by applying the correction factor of Schneider et al. (2012):

\[c_\mathrm{WDM} = c_\mathrm{CDM} \left[ 1 + \gamma_1 {M_\mathrm{1/2} \over M_\mathrm{halo}}\right]^{-\gamma_2},\]

where \(\gamma_1=15\), \(\gamma_2=0.3\), \(M_\mathrm{1/2}\) is the mass corresponding to the wavenumber at which the WDM transfer function is suppressed below the CDM transfer function by a factor of 2, and \(M_\mathrm{halo}\) is the mass of the dark matter halo, to a CDM concentration algorithm as specified by [cdmConcentration].

Methods

• tabulate — Tabulate the virial density contrast as a function of mass and time.

• restoreTable — Restore a tabulated solution from file.

• storeTable — Store a tabulated solution to file.

Parameters

• [velocityCharacteristic] (default 250.0d0) — The velocity scale at which the SNe-driven outflow rate equals the star formation rate in disks.

• [exponent] (default 3.5d0) — The velocity scaling of the SNe-driven outflow rate in disks.

• [fraction] (default 0.01d0) — The normalization \(f\) of the outflow rate relative to the star formation rate at a reference halo velocity of 200 km/s and expansion factor of 1, setting the overall mass-loading amplitude of the halo-scaling feedback model.

• [exponentVelocity] (default -2.0d0) — The exponent of virial velocity in the outflow rate in disks.

• [exponentRedshift] (default 0.0d0) — The power-law exponent of the cosmological expansion factor \((1+z)\) in the halo-scaling outflow rate, allowing the mass-loading factor to evolve with redshift; a value of zero gives no redshift evolution.

• [toleranceRelativeVelocityDispersion] (default 1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.

• [toleranceRelativeVelocityDispersionMaximum] (default 1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.

• [radiusNormalization] (default 3.3d-6) — The initial value appearing in the radius-mass relation

• [toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the nuclear star cluster is physically plausible.

• [toleranceRelativeMetallicity] (default 1.0d-4) — The metallicity tolerance for ODE solution.

• [inactiveLuminositiesStellar] (default .false.) — Specifies whether or not nuclear star cluster stellar luminosities are inactive properties (i.e. do not appear in any ODE being solved).

• [scaleRelativeMass] (default 1.0d-2) — The mass scale, relative to the total mass of the node, below which calculations in the delayed very simple hot halo component are allowed to become inaccurate.

• [starveSatellites] (default .false.) — Specifies whether or not the hot halo should be removed (“starved”) when a node becomes a satellite.

• [starveSatellitesOutflowed] (default .false.) — Specifies whether or not the outflowed hot halo should be removed (“starved”) when a node becomes a satellite.

• [outflowReturnOnFormation] (default .false.) — Specifies whether or not outflowed gas should be returned to the hot reservoir on halo formation events.

• [angularMomentumAlwaysGrows] (default .false.) — Specifies whether or not negative rates of accretion of angular momentum into the hot halo will be treated as positive for the purposes of computing the hot halo angular momentum.

• [fractionBaryonLimitInNodeMerger] (default .false.) — Controls whether the hot gas content of nodes should be limited to not exceed the universal baryon fraction at node merger events. If set to true, hot gas (and angular momentum, abundances, and chemicals proportionally) will be removed from the merged halo to the unaccreted gas reservoir to limit the baryonic mass to the universal baryon fraction where possible.

• [scaleAbsoluteMass] (default 100.0d0) — The absolute mass scale below which calculations in the very simple disk component are allowed to become inaccurate.

• [toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the disk is physically plausible.

• [toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the disk is physically plausible.

• [toleranceRelativeMetallicity] (default 1.0d-4) — The metallicity tolerance for ODE solution.

• [radiusStructureSolver] (default 1.0d0) — The radius (in units of the standard scale length) to use in solving for the size of the disk.

• [structureSolverUseCole2000Method] (default .false.) — If true, use the method described in Cole et al. (2000) to correct for difference between thin disk and spherical mass distributions when solving for disk radii.

• [diskNegativeAngularMomentumAllowed] (default .true.) — Specifies whether or not negative angular momentum is allowed for the disk.

• [inactiveLuminositiesStellar] (default .false.) — Specifies whether or not disk stellar luminosities are inactive properties (i.e. do not appear in any ODE being solved).

• [postStepZeroNegativeMasses] (default .true.) — If true, negative masses will be zeroed after each ODE step. Note that this can lead to non-conservation of mass.

• [ratioAngularMomentumSolverRadius] (default ratioAngularMomentumSolverRadiusDefault) — The assumed ratio of the specific angular momentum at the structure solver radius to the mean specific angular momentum of the standard disk component.

• [scaleAbsoluteMass] (default 100.0d0) — The absolute mass scale below which calculations in the very simple spheroid component are allowed to become inaccurate.

• [toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the spheroid is physically plausible.

• [efficiencyEnergeticOutflow] (default 1.0d-2) — The proportionality factor relating mass outflow rate from the spheroid to the energy input rate divided by \(V_\mathrm{spheroid}^2\).

• [toleranceRelativeMetallicity] (default 1.0d-4) — The metallicity tolerance for ODE solution.

• [toleranceAbsoluteMass] (default 1.0d-6) — The mass tolerance used to judge whether the spheroid is physically plausible.

• [inactiveLuminositiesStellar] (default .false.) — Specifies whether or not spheroid stellar luminosities are inactive properties (i.e. do not appear in any ODE being solved).

• [postStepZeroNegativeMasses] (default .true.) — If true, negative masses will be zeroed after each ODE step. Note that this can lead to non-conservation of mass.

• [ratioAngularMomentumScaleRadius] (default ratioAngularMomentumScaleRadiusDefault) — The assumed ratio of the specific angular momentum at the scale radius to the mean specific angular momentum of the standard spheroid component.

• [outputMergers] (default .false.) — Determines whether or not properties of black hole mergers will be output.

• [fileNames] — The name of the file(s) from which merger tree data should be read when using the [mergerTreeConstruct]\(=\)read tree construction method.

• [forestSizeMaximum] (default 0_c_size_t) — The maximum number of nodes allowed in a forest before it will be broken up into trees and processed individually. A value of 0 implies that forests should never be split.

• [presetMergerTimes] (default .true.) — Specifies whether merging times for subhalos should be preset when reading merger trees from a file.

• [presetMergerNodes] (default .true.) — Specifies whether the target nodes for mergers should be preset (i.e. determined from descendant nodes). If they are not, merging will be with each satellite’s host node.

• [presetSubhaloMasses] (default .true.) — Specifies whether subhalo mass should be preset when reading merger trees from a file.

• [subhaloAngularMomentaMethod] (default var_str('summation')) — Specifies how to account for subhalo angular momentum when adding subhalo mass to host halo mass.

• [presetSubhaloIndices] (default .true.) — Specifies whether subhalo indices should be preset when reading merger trees from a file.

• [presetPositions] (default .true.) — Specifies whether node positions should be preset when reading merger trees from a file.

• [presetScaleRadii] (default .true.) — Specifies whether node scale radii should be preset when reading merger trees from a file.

• [scaleRadiiFailureIsFatal] (default .true.) — Specifies whether failure to set a node scale radii should be regarded as a fatal error. (If not, a fallback method to set scale radius is used in such cases.)

• [presetScaleRadiiConcentrationMinimum] (default 3.0d0) — The lowest concentration (\(c=r_\mathrm{vir}/r_\mathrm{s}\)) allowed when setting scale radii, \(r_\mathrm{s}\).

• [presetScaleRadiiConcentrationMaximum] (default 60.0d0) — The largest concentration (\(c=r_\mathrm{vir}/r_\mathrm{s}\)) allowed when setting scale radii, \(r_\mathrm{s}\).

• [presetScaleRadiiMinimumMass] (default 0.0d0) — The minimum halo mass for which scale radii should be preset (if [presetScaleRadii]\(=\)true).

• [presetUnphysicalAngularMomenta] (default .false.) — When reading merger trees from file and presetting halo angular momenta, detect unphysical (<=0) angular momenta and preset them using the selected halo spin method.

• [presetAngularMomenta] (default .true.) — Specifies whether node angular momenta should be preset when reading merger trees from a file.

• [presetAngularMomenta3D] (default .false.) — Specifies whether node 3-D angular momenta vectors should be preset when reading merger trees from a file.

• [presetOrbits] (default .true.) — Specifies whether node orbits should be preset when reading merger trees from a file.

• [presetOrbitsSetAll] (default .true.) — Forces all orbits to be set. If the computed orbit does not cross the virial radius, then select one at random instead.

• [presetOrbitsAssertAllSet] (default .true.) — Asserts that all virial orbits must be preset. If any can not be set, Galacticus will stop.

• [presetOrbitsBoundOnly] (default .true.) — Specifies whether only bound node orbits should be set.

• [beginAt] (default -1_kind_int8) — Specifies the index of the tree to begin at. (Use -1 to always begin with the first tree.)

• [outputTimeSnapTolerance] (default 0.0d0) — The relative tolerance required to “snap” a node time to the closest output time.

• [missingHostsAreFatal] (default .true.) — Specifies whether nodes with missing host nodes should be considered to be fatal—see the discussion of missing host nodes in the class description above.

• [treeIndexToRootNodeIndex] (default .false.) — Specifies whether tree indices should always be set to the index of their root node.

• [allowBranchJumps] (default .true.) — Specifies whether nodes are allowed to jump between branches.

• [allowSubhaloPromotions] (default .true.) — Specifies whether subhalos are permitted to be promoted to being isolated halos.

• [alwaysPromoteMostMassive] (default .false.) — If true, the most massive progenitor is always promoted to be the primary progenitor even if it is a subhalo. Otherwise, isolated progenitors are given priority over subhalo progenitors, even if they are less massive.

• [presetNamedReals] — Names of real datasets to be additionally read and stored in the nodes of the merger tree when using the [mergerTreeConstruct]\(=\)read tree construction method.

• [presetNamedIntegers] — Names of integer datasets to be additionally read and stored in the nodes of the merger tree when using the [mergerTreeConstruct]\(=\)read tree construction method.

• [fatalMismatches] (default .true.) — Specifies whether mismatches in cosmological parameter values between Galacticus and “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree files should be considered fatal.

• [fatalNonTreeNode] (default .true.) — Specifies whether nodes in snapshot files but not in the merger tree file should be considered fatal when importing from the “Sussing Merger Trees” format (Srisawat et al., 2013).

• [subvolumeCount] (default 1) — Specifies the number of subvolumes along each axis into which a “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree files should be split for processing through Galacticus.

• [subvolumeBuffer] (default 0.0d0) — Specifies the buffer region (in units of Mpc\(/h\) to follow the format convention) around subvolumes of a “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree file which should be read in to ensure that no halos are missed from trees.

• [subvolumeIndex] (default [0,0,0]) — Specifies the index (in each dimension) of the subvolume of a “Sussing Merger Trees” format (Srisawat et al., 2013) merger tree file to process. Indices range from 0 to [subvolumeCount]\(-1\).

• [badValue] (default -0.5d0) — Use for bad value detection in “Sussing” merger trees. Values for scale radius and halo spin which exceed this threshold are assumed to be bad.

• [badValueTest] (default var_str('lessThan')) — Use for bad value detection in “Sussing” merger trees. Values which exceed the threshold in ths specified direction are assumed to be bad.

• [treeSampleRate] (default 1.0d0) — Specify the probability that any given tree should processed (to permit subsampling).

• [massOptions] (default var_str('default')) — Mass option for Sussing merger trees.

• [mergeProbability] (default 0.1d0) — The largest probability of branching allowed in a timestep in merger trees built by the Cole et al. (2000) method.

• [accretionLimit] (default 0.1d0) — The largest fractional mass change due to subresolution accretion allowed in a timestep in merger trees built by the Cole et al. (2000) method.

• [redshiftMaximum] (default 1.0d5) — The highest redshift to which merger trees will be built in the Cole et al. (2000) method.

• [toleranceTimeEarliest] (default 2.0d-6) — The fractional tolerance used to judge if a branch is at the earliest allowed time in the tree.

• [branchIntervalStep] (default .true.) — If false use the original Cole et al. (2000) method to determine whether branching occurs in a timestep. If true draw branching intervals from a negative exponential distribution.

• [toleranceResolutionSelf] (default 1.0d-6) — The fractional tolerance in node mass at the resolution limit below which branch mis-orderings will be ignored.

• [toleranceResolutionParent] (default 1.0d-3) — The fractional tolerance in parent node mass at the resolution limit below which branch mis-orderings will be ignored.

• [ignoreNoProgress] (default .false.) — If true, failure to make progress on a branch will be ignored (and the branch terminated).

• [ignoreWellOrdering] (default .false.) — If true, non-well-ordered tree branches are pruned away instead of causing errors..

• [redshiftBase] (default 0.0d0) — The redshift at which to plant the base node when building merger trees.

• [timeSnapTolerance] (default 1.0d-6) — The fractional tolerance within which the tree base time will be snapped to a nearby output time.

• [treeBeginAt] (default 0) — The index (in order of increasing base halo mass) of the tree at which to begin when building merger trees. A value of “0” means to begin with tree number 1 (if processing trees in ascending order), or equal to the number of trees (otherwise).

• [processDescending] (default .true.) — If true, causes merger trees to be processed in order of decreasing mass.

• [splitTrees] (default .false.) — If true, prune away any nodes of the tree that are not needed to determine evolution up to the latest time at which a node is present inside the lightcone. This typically leads to a tree splitting into a forest of trees.

• [label] — A label for the mass function.

• [comment] — A descriptive comment for the mass function.

• [starFormationRates] — The star formation rates corresponding to bin centers.

• [covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of star formation rate to use when constructing star formation rate function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMinimum] (default 1.0d10) — The star formation rate to consider when constructing star formation rate function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMaximum] (default 1.0d12) — The maximum star formation rate to consider when constructing star formation rate function covariance matrices for main branch galaxies.

• [targetLabel] — Label for the target dataset.

• [functionValueTarget] — The target function for likelihood calculations.

• [functionCovarianceTarget] — The target function covariance for likelihood calculations.

• [likelihoodBins] — Controls which bins in the stellar mass–halo mass relation will be used in computing the likelihood: * not present: all bins are included in the likelihood calculation; * list of integers: use only the mass bin(s) given in this list in the likelihood calculation; * auto: use only bins which have a non-zero number of halos contributing to them in the likelihood calculation.

• [fileNameTarget] — The name of the file containing the target data.

• [redshiftInterval] (default 1) — The redshift interval to use.

• [likelihoodNormalize] (default .false.) — If true, then normalize the likelihood to make it a probability density.

• [computeScatter] (default .false.) — If true, the scatter in log10(stellar mass) is computed. Otherwise, the mean is computed.

• [systematicErrorPolynomialCoefficient] (default [0.0d0]) — The coefficients of the systematic error polynomial for stellar mass in the stellar vs halo mass relation.

• [systematicErrorMassHaloPolynomialCoefficient] (default [0.0d0]) — The coefficients of the systematic error polynomial for halo mass in the stellar vs halo mass relation.

• [errorTolerant] (default .false.) — Error tolerance for the N-body spin distribution operator.

• [logNormalRange] (default 100.0d0) — The multiplicative range of the log-normal distribution used to model the distribution of the mass and energy terms in the spin parameter. Specifically, the lognormal distribution is truncated outside the range \((\lambda_\mathrm{m}/R,\lambda_\mathrm{m} R\), where \(\lambda_\mathrm{m}\) is the measured spin, and \(R=\)[logNormalRange]

• [fileName] — The name of the file from which to read spin distribution function parameters.

• [comment] — A comment describing this analysis.

• [label] — A label for this analysis.

• [label] — A label for the spin distribution function.

• [comment] — A descriptive comment for the spin distribution function.

• [redshift] — The redshift at which to compute the spin distribution function.

• [massMinimum] — Minimum halo mass for the spin distribution function.

• [massMaximum] — Maximum halo mass for the spin distribution function.

• [spinMinimum] — Minimum spin for the spin distribution function.

• [spinMaximum] — Maximum spin for the spin distribution function.

• [countSpinsPerDecade] — Number of spins per decade at which to compute the spin distribution function.

• [timeRecent] — Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent] of the analysis time will be excluded from the analysis.

• [particleCountMinimum] — The minimum particle count to assume when computing N-body errors on spins.

• [massParticle] — The mass of the particle used in the N-body simulation from which spins were measured.

• [energyEstimateParticleCountMaximum] — The maximum number of particles used in estimating halo energies when measuring spins from the N-body simulation.

• [targetLabel] — Label for the target dataset.

• [functionValueTarget] — The target function for likelihood calculations.

• [functionCovarianceTarget] — The target function covariance for likelihood calculations.

• [label] — A label for the mass function.

• [comment] — A descriptive comment for the mass function.

• [masses] — The masses corresponding to bin centers.

• [covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing HI mass function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing HI mass function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing HI mass function covariance matrices for main branch galaxies.

• [targetLabel] — Label for the target dataset.

• [functionValueTarget] — The target function for likelihood calculations.

• [functionCovarianceTarget] — The target function covariance for likelihood calculations.

• [label] — A label for the luminosity function.

• [comment] — A descriptive comment for the luminosity function.

• [magnitudesAbsolute] — The absolute magnitudes corresponding to bin centers.

• [covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing luminosity function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.

• [targetLabel] — Label for the target dataset.

• [functionValueTarget] — The target function for likelihood calculations.

• [functionCovarianceTarget] — The target function covariance for likelihood calculations.

• [label] — A label for the luminosity function.

• [comment] — A descriptive comment for the luminosity function.

• [luminosities] — The luminosities corresponding to bin centers.

• [covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing luminosity function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing luminosity function covariance matrices for main branch galaxies.

• [includeNitrogenII] (default .false.) — If true, include contamination by the [NII] (6548AA \(+\) 6584AA) doublet.

• [depthOpticalISMCoefficient] (default 1.0d0) — Multiplicative coefficient for optical depth in the ISM.

• [targetLabel] — Label for the target dataset.

• [functionValueTarget] — The target function for likelihood calculations.

• [functionCovarianceTarget] — The target function covariance for likelihood calculations.

• [label] — A label for the mass function.

• [comment] — A descriptive comment for the mass function.

• [masses] — The masses corresponding to bin centers.

• [covarianceBinomialBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing stellar mass function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.

• [covarianceBinomialMassHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing stellar mass function covariance matrices for main branch galaxies.

• [targetLabel] — Label for the target dataset.

• [functionValueTarget] — The target function for likelihood calculations.

• [functionCovarianceTarget] — The target function covariance for likelihood calculations.

• [rootVarianceFractionalMinimum] (default 0.0d0) — The minimum fractional root variance (relative to the target dataset).

• [fileName] — The name of the file from which to read concentration distribution function parameters.

• [comment] — A comment describing this analysis.

• [label] — A label for this analysis.

• [label] — A label for the concentration distribution function.

• [comment] — A descriptive comment for the concentration distribution function.

• [redshift] — The redshift at which to compute the concentration distribution function.

• [massMinimum] — Minimum halo mass for the concentration distribution function.

• [massMaximum] — Maximum halo mass for the concentration distribution function.

• [concentrationMinimum] — Minimum concentration for the concentration distribution function.

• [concentrationMaximum] — Maximum concentration for the concentration distribution function.

• [countConcentrationsPerDecade] — Number of concentrations per decade at which to compute the concentration distribution function.

• [timeRecent] — Halos which experienced a major node merger within a time \(\Delta t=\)[timeRecent] of the analysis time will be excluded from the analysis.

• [massParticle] — The particle mass in the source N-body simulation.

• [targetLabel] — Label for the target dataset.

• [functionValueTarget] — The target function for likelihood calculations.

• [functionCovarianceTarget] — The target function covariance for likelihood calculations.

• [fileName] — The name of the file from which to read star forming main sequence function parameters.

• [comment] — A comment describing this analysis.

• [label] — A label for this analysis.

• [label] — A label for the star forming main sequence function.

• [comment] — A descriptive comment for the star forming main sequence function.

• [massMinimum] — Minimum stellar mass for the star forming main sequence function.

• [massMaximum] — Maximum stellar mass for the star forming main sequence function.

• [countMassesPerDecade] — Number of masses per decade at which to compute the star forming main sequence function.

• [targetLabel] — Label for the target dataset.

• [meanValueTarget] — The target function for likelihood calculations.

• [meanCovarianceTarget] — The target function covariance for likelihood calculations.

• [label] — A label for the mass function.

• [comment] — A descriptive comment for the mass function.

• [separations] — The separations corresponding to bin centers.

• [massMinima] — The minimum mass of each mass sample.

• [massMaxima] — The maximum mass of each mass sample.

• [massHaloBinsPerDecade] (default 10) — The number of bins per decade of halo mass to use when constructing the mass function covariance matrix for main branch galaxies.

• [massHaloMinimum] (default 1.0d8) — The minimum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.

• [massHaloMaximum] (default 1.0d16) — The maximum halo mass to consider when constructing the mass function covariance matrix for main branch galaxies.

• [wavenumberCount] (default 60_c_size_t) — The number of bins in wavenumber to use in computing the correlation function.

• [wavenumberMinimum] (default 1.0d-3) — The minimum wavenumber to use when computing the correlation function.

• [wavenumberMaximum] (default 1.0d4) — The maximum wavenumber to use when computing the correlation function.

• [integralConstraint] — The integral constraint for these correlation functions.

• [depthLineOfSight] — The line-of-sight depth over which the correlation function was projected.

• [halfIntegral] — Set to true if the projection integrand should be over line-of-sight depths greater than zero.

• [binnedProjectedCorrelationTarget] — The target function for likelihood calculations.

• [binnedProjectedCorrelationCovarianceTarget] — The target function covariance for likelihood calculations.

• [targetLabel] (default var_str('')) — A label for the target dataset in a plot of this analysis.

• [starFormationRateSpecificQuiescentLogarithmic] — The base-10 logarithm specific star formation rate (in units of Gyr\(^{-1}\)) separating quiescent and star-forming galaxies.

• [starFormationRateSpecificLogarithmicError] — The observational fractional error in specific star formation rate (in units of dex) of galaxies.

• [fileName] — The name of the file from which to read quiescent fraction function parameters.

• [comment] — A comment describing this analysis.

• [label] — A label for this analysis.

• [label] — A label for the star forming main sequence function.

• [comment] — A descriptive comment for the star forming main sequence function.

• [massMinimum] — Minimum stellar mass for the star forming main sequence function.

• [massMaximum] — Maximum stellar mass for the star forming main sequence function.

• [countMassesPerDecade] — Number of masses per decade at which to compute the star forming main sequence function.

• [targetLabel] — Label for the target dataset.

• [meanValueTarget] — The target function for likelihood calculations.

• [meanCovarianceTarget] — The target function covariance for likelihood calculations.

• [nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.

• [radiusFractionalTruncateMinimum] (default 2.0d0) — The minimum radius (in units of the virial radius) to begin truncating the density profile.

• [radiusFractionalTruncateMaximum] (default 4.0d0) — The maximum radius (in units of the virial radius) to finish truncating the density profile.

• [nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.

• [velocityDispersionApproximate] (default .true.) — If true, radial velocity dispersion is computed using an approximate method in which we assume that \(\sigma_\mathrm{r}^2(r) \rightarrow \sigma_\mathrm{r}^2(r) - (2/3) \epsilon(r)\), where \(\epsilon(r)\) is the specific heating energy. If false then radial velocity dispersion is computed by numerically solving the Jeans equation.

• [tolerateEnclosedMassIntegrationFailure] (default .false.) — If true, tolerate failures to find the mass enclosed as a function of radius.

• [tolerateVelocityDispersionFailure] (default .false.) — If true, tolerate failures to compute the velocity dispersion.

• [tolerateVelocityMaximumFailure] (default .false.) — If true, tolerate failures to find the radius of the maximum circular velocity.

• [toleratePotentialIntegrationFailure] (default .false.) — If true, tolerate numerical failures when computing the gravitational potential of a heated dark matter profile, allowing the calculation to continue with a fallback result rather than aborting.

• [toleranceRelativeVelocityDispersion] (default 1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.

• [toleranceRelativeVelocityDispersionMaximum] (default 1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion in dark-matter-only density profiles.

• [fractionRadiusFinalSmall] (default 1.0d-3) — The initial radius is limited to be no smaller than this fraction of the final radius. This can help avoid problems in profiles that are extremely close to being disrupted.

• [toleranceRelativePotential] (default 1.0d-3) — The maximum allowed relative tolerance to use in numerical solutions for the gravitational potential in dark-matter-only density profiles before aborting.

• [tolerateVelocityMaximumFailure] (default .true.) — If true, tolerate failures to find the radius of the peak in the rotation curve.

• [lengthResolution] — The gravitational softening length \(\Delta x\) (in Mpc) of the N-body simulation, which sets the minimum spatial scale below which the dark matter profile is smoothed to avoid artificial two-body effects.

• [massResolution] — The mass resolution \(\Delta M\) (in \(\mathrm{M}_\odot\)) of the N-body simulation, representing the minimum halo mass that can be resolved; profiles of halos near this limit are softened to account for particle discreteness effects.

• [resolutionIsComoving] — If true, the resolution length is assumed to be fixed in comoving coordinates, otherwise in physical coordinates.

• [nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.

• [C] (default 400.0d0) — The parameter \(C\) appearing in the halo concentration algorithm of Ludlow et al. (2016).

• [f] (default 0.02d0) — The parameter \(f\) appearing in the halo concentration algorithm of Ludlow et al. (2016).

• [timeFormationSeekDelta] (default 0.0d0) — The parameter \(\Delta \log t\) by which the logarithm of the trial formation time is incremented when stepping through the formation history of a node to find the formation time. If set to zero (or a negative value) the cumulative mass histories of nodes are assumed to be monotonic functions of time, and the formation time is instead found by a root finding algorithm,

• [massBoundIsInactive] (default .false.) — Specifies whether or not the bound mass of the satellite component is inactive (i.e. does not appear in any ODE being solved).

• [useLastIsolatedTime] (default .false.) — If true, evaluate the halo virial radius using a the virial density definition at the last isolated time of the halo.

• [filterName] — The filter to select.

• [filterType] — The filter type (rest or observed) to select.

• [redshiftBand] — The redshift of the band (if not the output redshift).

• [postprocessChain] — The postprocessing chain to use.

• [cloudyTableFileName] (default var_str('%DATASTATICPATH%/hiiRegions/emissionLineLuminosities_BC2003_highResolution_imfChabrier.hdf5')) — The file of emission line luminosities to use.

• [lineNames] — The emission lines to extract.

• [component] — The component from which to extract star formation rate.

• [toleranceRelative] (default 1.0d-3) — The relative tolerance used in integration over stellar population spectra.

• [component] — The component from which to extract star formation rate.

• [radiusCore] — The soliton core radius (in Mpc) characterizing the size of the quantum pressure-supported central core of the fuzzy dark matter halo; the density profile flattens inside this scale.

• [densitySolitonCentral] — The central density (in \(\mathrm{M}_\odot\)/Mpc\(^3\)) of the solitonic core at \(r=0\), which sets the overall normalization of the density profile \(\rho(r) = \rho_\mathrm{c} [1+(r/r_c)^2]^{-8}\).

• [toleranceRelativePotential] (default 1.0d-3) — The relative tolerance used in numerical ODE solutions for the gravitational potential of the solitonic core profile.

• [dimensionless] (default .true.) — If true the soliton profile is treated as dimensionless (scale-free), allowing its radial and density quantities to be specified in arbitrary units.

• [componentType] (default var_str('unknown')) — The galactic structure component type (e.g.dark matter halo, disk, spheroid) represented by this mass distribution, used for component-specific queries.

• [massType] (default var_str('unknown')) — The mass type (e.g.dark matter, baryonic, total) represented by this mass distribution, used for mass-type-specific queries.

• [radiusTransition] — The transition radius (in Mpc) at which the density profile smoothly switches from the halo profile to the accretion flow, controlled by the fourth-order transition function \(f_\mathrm{trans}(r)\).

• [nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.

• [componentType] (default var_str('unknown')) — The component type that this mass distribution represents.

• [massType] (default var_str('unknown')) — The mass type that this mass distribution represents.

• [timeAge] — The age of the halo (in Gyr) since its formation, determining the total time available for SIDM self-interactions to thermalize the inner halo and produce an isothermal core.

• [velocityRelativeMean] — Mean relative velocity to calculate self interaction cross section.

• [nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.

• [componentType] (default var_str('unknown')) — The component type that this mass distribution represents.

• [massType] (default var_str('unknown')) — The mass type that this mass distribution represents.

• [nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.

• [componentType] (default var_str('unknown')) — The component type that this mass distribution represents.

• [massType] (default var_str('unknown')) — The mass type that this mass distribution represents.

• [tolerateVelocityMaximumFailure] (default .false.) — If true, tolerate failures to find the radius of the peak in the rotation curve.

• [tolerateEnclosedMassIntegrationFailure] (default .false.) — If true, tolerate failures to find the mass enclosed as a function of radius.

• [toleratePotentialIntegrationFailure] (default .false.) — If true, tolerate failures to compute the potential.

• [fractionRadiusFinalSmall] (default 1.0d-3) — The initial radius is limited to be no smaller than this fraction of the final radius. This can help avoid problems in profiles that are extremely close to being disrupted.

• [toleranceRelativePotential] (default 1.0d-3) — The maximum allowed relative tolerance to use in numerical solutions for the gravitational potential in dark-matter-only density profiles before aborting.

• [lengthResolution] — The spatial resolution length scale (in Mpc) below which the underlying density profile is softened to a flat core, mimicking the finite force resolution of an N-body simulation.

• [nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available. If set to “fallThrough” then the solution ignoring heating is used, while if set to “numerical” then numerical solvers are used to find solutions.

• [componentType] (default var_str('unknown')) — The component type that this mass distribution represents.

• [massType] (default var_str('unknown')) — The mass type that this mass distribution represents.

• [massMinimum] — The minimum halo mass (in \(\mathrm{M}_\odot\)) below which halos are excluded from the mass function histogram.

• [massMaximum] — The maximum halo mass (in \(\mathrm{M}_\odot\)) above which halos are excluded from the mass function histogram.

• [massCountPerDecade] — The number of logarithmic bins per decade of halo mass used when constructing the halo mass function.

• [description] — A human-readable description of this mass function dataset, stored as metadata in the output file.

• [simulationReference] — A bibliographic reference for the N-body simulation from which this mass function is derived, stored as metadata.

• [simulationURL] — A URL pointing to the publicly accessible dataset or documentation for the N-body simulation, stored as metadata.

• [bootstrapSampleCount] (default 30_c_size_t) — The number of bootstrap resamples of the particles that should be used.

• [representativeMinimumCount] (default 10_c_size_t) — Minimum number of representative particles used to compute the center of a halo.

• [tolerance] (default 1.0d-2) — The tolerance in the summed weight of bound particles which must be attained to declare convergence.

• [bootstrapSampleRate] (default 1.0d0) — The sampling rate for particles.

• [representativeFraction] (default 0.05d0) — Fraction of bound particles used to compute the center of a halo.

• [analyzeAllParticles] (default .true.) — If true, all particles are assumed to be self-bound at the beginning of the analysis. Unbound particles at previous times are allowed to become bound in the current snapshot. If false and the self-bound information from the previous snapshot is available, only the particles that are self-bound at the previous snapshot are assumed to be bound at the beginning of the analysis.

• [useVelocityMostBound] (default .false.) — If true, the velocity of the most bound particle in velocity space is used as the representative velocity of the satellite. If false, use the mass weighted mean velocity (center-of-mass velocity) of self-bound particles instead.

• [orderRotation] (default var_str('none')) — The order in which evaluation of likelihoods should be rotated as a function of process number.

• [logLikelihoodAccept] (default huge(0.0d0)) — The log-likelihood which should be “accepted”—once the log-likelihood reaches this value (or larger) no further updates to the chain will be made.

• [report] (default .false.) — If true, report on the log-likelihood obtained.

• [means] — The mean of the multivariate normal distribution.

• [covariance] — The covariance matrix for the of the multivariate normal distribution.

• [countForestsMaximum] (default -1_c_size_t) — If set to a positive number, this is the maximum number of forests that will be evolved.

• [walltimeMaximum] (default -1_kind_int8) — If set to a positive number, this is the maximum wall time for which forest evolution is allowed to proceed before the task gives up.

• [tolerateFailures] (default .false.) — If true then failures to evolve a forest are tolerated. The forest is evolved no further, but evolution of other forests continues.

• [evolveForestsInParallel] (default .true.) — If true then each forest is evolved by a separate OpenMP thread. Otherwise, a single thread evolves all forests.

• [suspendToRAM] (default .true.) — Specifies whether trees should be suspended to RAM (otherwise they are suspend to file).

• [suspendPath] — The path to which tree suspension files will be stored.

• [timeIntervalCheckpoint] (default -1_kind_int8) — If positive, gives the time in seconds between storing of checkpoint files. If zero or negative, no checkpointing is performed..

• [fileNameCheckpoint] — The path to which checkpoint data will be stored.

• [logM0] (default 10.0d0) — The parameter \(\log_{10} M_0\) (with \(M_0\) in units of \(\mathrm{M}_\odot\)) appearing in the star formation rate threshold expression for the star formation rate galactic filter class.

• [logSFR0] (default 9.0d0) — The parameter \(\alpha_0\) appearing in the star formation rate threshold expression for the star formation rate galactic filter class.

• [logSFR1] (default 0.0d0) — The parameter \(\alpha_1\) appearing in the star formation rate threshold expression for the star formation rate galactic filter class.

• [cW] (default 3.78062835d0) — The parameter \(c_\mathrm{W}\) in the Bohr et al. (2021) power spectrum window function.

• [beta] (default 3.4638743d0) — The parameter \(\beta\) in the Bohr et al. (2021) power spectrum window function.

• [transferFunctionType] (default var_str('darkMatter')) — Specifies whether to use the darkMatter or total transfer function.

• [fileName] — The name of the file from which to read a tabulated transfer function.

• [redshift] (default 0.0d0) — The redshift of the transfer function to read.

• [factorWavenumberSmoothExtrapolation] (default 0.0d0) — If positive, and extrapolation is used at high wavenumbers, the slope for extrapolation will be set by averaging over wavenumbers from \(k_\mathrm{max}/f\) to \(k_\mathrm{max}\), where \(f=\)[factorWavenumberSmoothExtrapolation] and \(k_\mathrm{max}\) is the highest wavenumber tabulated. This avoids spurious extrapolation for highly oscillatory transfer functions.

• [acceptNegativeValues] (default .false.) — If true, negative values in the transfer function are allowed (and the absolute value is taken prior to interpolation). Otherwise, negative values result in an error.

• [fractionalTimeStep] (default 0.01d0) — The fractional time step used when computing barrier crossing rates (i.e. the step used in finite difference calculations).

• [fileName] (default var_str('none')) — The name of the file to/from which tabulations of barrier first crossing probabilities should be written/read. If set to “none” tables will not be stored.

• [fractionalTimeStep] (default 0.01d0) — The fractional time step used when computing barrier crossing rates (i.e. the step used in finite difference calculations).

• [varianceNumberPerUnitProbability] (default 1000) — The number of points to tabulate per unit variance for first crossing probabilities.

• [varianceNumberPerUnit] (default 40) — The number of tabulation points per unit of \(\sigma^2\) used when building the rate look-up table for the Farahi excursion-set first-crossing distribution; higher values improve interpolation accuracy at the cost of memory and initialization time.

• [varianceNumberPerDecade] (default 400) — The number of points to tabulate per decade of progenitor variance for first crossing rates.

• [varianceNumberPerDecadeNonCrossing] (default 40) — The number of points to tabulate per decade of progenitor variance for non-crossing rates.

• [timeNumberPerDecade] (default 10) — The number of tabulation points per decade of cosmic time used when building the first-crossing rate look-up table as a function of time; higher values improve temporal interpolation accuracy for rapidly evolving cosmologies.

• [varianceIsUnlimited] (default .false.) — If true, the variance is assumed to have no upper limit (e.g. as in the case of CDM). This allows the tabulated solutions to be extended arbitrarily. Otherwise, tables are extended to encompass just the range of variance requested.

• [linkingLength] (default 0.2d0) — The friends-of-friends linking length to use in computing virial density contrasts with the percolation analysis of More et al. (2011).

darkMatterProfileConcentrationWDMBose2016

A dark matter profile concentration class in which the concentration is computed by applying the correction factor of Bose et al. (2016):

\[c_\mathrm{WDM} = c_\mathrm{CDM} \left( 1 + \gamma_1 {M_\mathrm{1/2} \over M_\mathrm{halo}} \right)^{-\gamma_2} (1+z)^{\beta(z)},\]

where \(\gamma_1=60\), \(\gamma_2=0.17\), \(M_\mathrm{1/2}\) is the mass corresponding to the wavenumber at which the WDM transfer function is suppressed below the CDM transfer function by a factor of 2, \(M_\mathrm{halo}\) is the mass of the dark matter halo, and \(\beta(z)=0.026 z-0.04\), to a CDM concentration algorithm as specified by [cdmConcentration].

darkMatterProfileConcentrationZhao2009

A dark matter profile concentration class in which the concentration is computed using a fitting function from Zhao et al. (2009):

\[c = 4 \left(1 + \left[ {t \over 3.75 t_\mathrm{form}}\right]^{8.4}\right)^{1/8},\]

where \(t\) is the time for the halo and \(t_\mathrm{form}\) is a formation time defined by Zhao et al. (2009) as the time at which the main branch progenitor of the halo had a mass equal to \(0.04\) of the current halo mass. This formation time is computed directly from the merger tree branch associated with each halo. If the no branch exists or does not extend to the formation time then the formation time is computed by extrapolating the mass of the earliest resolved main branch progenitor to earlier times using the selected darkMatterHaloMassAccretionHistoryClass.