Mass Distributions¶

Class providing mass distributions—fully general descriptions of the spatial distribution of mass (dark matter, gas, stars, or black holes) in a galaxy or halo. Implementations provide the density profile \(\rho(\mathbf{x})\), gravitational potential \(\Phi(\mathbf{x})\), enclosed mass \(M(r)\), surface density, rotation curve, and velocity dispersion via the Jeans equation. The class also tracks the component and mass type of the distribution and supports arbitrary geometries, enabling self-consistent multi-component dynamical models of galaxies and halos.

Methods¶

setKinematicsDistribution → void

Set the kinematics distribution for this mass distribution.

class(kinematicsDistributionClass), intent(in ) :: kinematicsDistribution_

kinematicsDistribution → class(kinematicsDistributionClass)

Get a pointer to the kinematics distribution for this mass distribution.

setTypes → void

Set the component and mass types of the mass distribution.

type(enumerationComponentTypeType), intent(in ), optional :: componentType
type(enumerationMassTypeType ), intent(in ), optional :: massType

subset → class(massDistributionClass)

Return the subset of the mass distribution matching the given componentType and massType.

type(enumerationComponentTypeType), intent(in ), optional :: componentType
type(enumerationMassTypeType ), intent(in ), optional :: massType

describe → void

Display a description of the mass distribution.

matches → logical

Return true if this mass distribution matches the specified component and mass type.

type(enumerationComponentTypeType), intent(in ), optional :: componentType
type(enumerationMassTypeType ), intent(in ), optional :: massType

symmetry → type(enumerationMassDistributionSymmetryType)

Return the symmetry of the distribution.

isSphericallySymmetric → logical

Return true if the distribution is spherically symmetric.

assumeMonotonicDecreasingSurfaceDensity → logical

Return true if the distribution can be assumed to have a monotonically decreasing surface density.

isDimensionless → logical

Return true if the distribution is dimensionless.

massTotal → double precision

Return the total mass of the distribution.

acceleration → double precision, dimension(3)

Return the gravitational acceleration due to the distribution at the given coordinates.

class(coordinate), intent(in ) :: coordinates

tidalTensor → type(tensorRank2Dimension3Symmetric)

Return the gravitational tidal tensor due to the distribution at the given coordinates.

class(coordinate), intent(in ) :: coordinates

density → double precision

Return the density of the distribution at the given coordinates.

class(coordinate), intent(in ) :: coordinates

densitySphericalAverage → double precision

Return the average density on a spherical shell of the given radius.

double precision, intent(in ) :: radius

densityGradientRadial → double precision

Return the radial gradient of density of the distribution at the given coordinates.

class (coordinate), intent(in ) :: coordinates
logical , intent(in ), optional :: logarithmic

potential → double precision

Return the gravitational potential of the distribution at the given coordinates.

class(coordinate ), intent(in ) :: coordinates
type (enumerationStructureErrorCodeType), intent( out), optional :: status

potentialIsAnalytic → logical

Return true if the gravitational potential for this distribution has an analytic form.

potentialDifference → double precision

Return the difference in that gravitational potential of the distribution between the given coordinates.

class(coordinate ), intent(in ) :: coordinates1, coordinates2
type (enumerationStructureErrorCodeType), intent( out), optional :: status

potentialDifferenceNumerical → double precision

Return the difference in that gravitational potential of the distribution between the given coordinates using a numerical calculation.

class(coordinate ), intent(in ) :: coordinates1, coordinates2
type (enumerationStructureErrorCodeType), intent( out), optional :: status

massEnclosedBySphere → double precision

Return the mass enclosed in the distribution by a sphere of given radius.

double precision, intent(in ) :: radius

massEnclosedByCylinder → double precision

Return the mass enclosed in the distribution by a cylinder of given radius.

double precision, intent(in ) :: radius

radiusEnclosingMass → double precision

Return the radius enclosing a specified mass.

double precision, intent(in ), optional :: mass, massFractional

radiusEnclosingMassNumerical → double precision

Return the radius enclosing a specified mass using a numerical calculation.

double precision, intent(in ), optional :: mass, massFractional

radiusCylindricalEnclosingMass → double precision

Return the cylindrical radius enclosing a specified mass.

double precision, intent(in ), optional :: mass, massFractional

radiusCylindricalEnclosingMassNumerical → double precision

Return the cylindrical radius enclosing a specified mass using a numerical calculation.

double precision, intent(in ), optional :: mass, massFractional

radiusEnclosingDensity → double precision

Return the radius enclosing a specified density.

double precision, intent(in ) :: density
double precision, intent(in ), optional :: radiusGuess

radiusEnclosingDensityNumerical → double precision

Return the radius enclosing a specified density using a numerical calculation.

double precision, intent(in ) :: density
double precision, intent(in ), optional :: radiusGuess

radiusEnclosingSurfaceDensity → double precision

Return the radius enclosing a specified surface density.

double precision, intent(in ) :: densitySurface
double precision, intent(in ), optional :: radiusGuess

radiusEnclosingSurfaceDensityNumerical → double precision

Return the radius enclosing a specified surface density using a numerical calculation.

double precision, intent(in ) :: densitySurface
double precision, intent(in ), optional :: radiusGuess

radiusFromSpecificAngularMomentum → double precision

Return the radius corresponding to a given specific angular momentum.

double precision, intent(in ) :: angularMomentumSpecific

radiusFromSpecificAngularMomentumNumerical → double precision

Return the radius corresponding to a given specific angular momentum using a numerical calculation.

double precision, intent(in ) :: angularMomentumSpecific

rotationCurve → double precision

Return the rotation curve at the given radius.

double precision, intent(in ) :: radius

rotationCurveGradient → double precision

Return the rotation curve gradient, \(\mathrm{d}V^2/\mathrm{d}r\), at the given radius.

double precision, intent(in ) :: radius

velocityRotationCurveMaximum → double precision

Return the maximum velocity in the rotation curve.

radiusRotationCurveMaximum → double precision

Return the radius of the maximum velocity in the rotation curve.

radiusRotationCurveMaximumNumerical → double precision

Return the radius of the maximum velocity in the rotation curve.

surfaceDensity → double precision

Return the surface density at the given coordinates.

class(coordinate), intent(in ) :: coordinates

surfaceDensityRadialMoment → double precision

Return the surface density at the given coordinates.

double precision, intent(in ) :: moment
double precision, intent(in ), optional :: radiusMinimum, radiusMaximum
logical , intent( out), optional :: isInfinite

densityRadialMoment → double precision

Return the radial moment of the distribution.

double precision, intent(in ) :: moment
double precision, intent(in ), optional :: radiusMinimum, radiusMaximum
logical , intent( out), optional :: isInfinite

densitySquareIntegral → double precision

Return the integral over the square of the density of the distribution.

double precision, intent(in ), optional :: radiusMinimum, radiusMaximum
logical , intent( out), optional :: isInfinite

chandrasekharIntegral → double precision, dimension(3)

Return the Chandrasekhar integral of the distribution.

class (massDistributionClass), intent(inout) :: massDistributionEmbedding, massDistributionPerturber
double precision , intent(in ) :: massPerturber
class (coordinate ), intent(in ) :: coordinates , velocity

radiusFreefall → double precision

Return the radius at which the freefall time to the center equals the given time.

double precision, intent(in ) :: time

radiusFreefallIncreaseRate → double precision

Return the rate of increase of the freefall radius corresponding to the given time.

double precision, intent(in ) :: time

fourierTransform → double precision

Return the spherically-symmetrized Fourier transform of the density profile at the given wavenumber.

double precision, intent(in ) :: radiusOuter , wavenumber

energy → double precision

Return the total energy of the distribution within the given radius.

double precision , intent(in ) :: radiusOuter
class (massDistributionClass), intent(inout), target :: massDistributionEmbedding

positionSample → double precision, dimension(3)

Return a position sampled from the distribution.

class(randomNumberGeneratorClass ), intent(inout) :: randomNumberGenerator_

solverSet → void

Set a sub-module scope pointers on a stack to allow recursive calls to functions.

double precision, intent(in ), dimension(3), optional :: position1 , position2 , vectorUnit
double precision, intent(in ) , optional :: massTarget, densityTarget, angularMomentumSpecificTarget, densitySurfaceTarget, separation

solverUnset → void

Unset a sub-module scope pointers on the stack.

`massDistributionBetaProfile`¶

A mass distribution class for \(\beta\)-profile distributions.

Methods

initialize — (Re)initialize the parameters of the \(\beta\)-profile mass distribution.

Parameters

[beta] (default 2.0d0/3.0d0) — The value of \(\beta\) in \(\beta\)-profile hot halo cold mode mass distributions.
[beta] (default 2.0d0/3.0d0) — The value of \(\beta\) in \(\beta\)-profile hot halo mass distributions.
[beta] (default 2.0d0/3.0d0) — The value \(\beta\) in a \(\beta\)-model mass distribution.
[densityNormalization] (default 0.0d0) — The density normalization of a \(\beta\)-model mass distribution.
[mass] (default 0.0d0) — The mass of a \(\beta\)-model mass distribution.
[outerRadius] (default 0.0d0) — The outer radius of a \(\beta\)-model mass distribution.
[coreRadius] (default 0.0d0) — The core radius of a \(\beta\)-model mass distribution.
[dimensionless] (default .false.) — If true then the \(\beta\)-model mass distribution is considered to be in dimensionless units.
[truncateAtOuterRadius] (default .false.) — If true then the \(\beta\)-model mass distribution is truncated beyond the outer radius.
[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.

`massDistributionBlackHole`¶

A mass distribution class for point masses.

Methods

initialize — (Re)initialize the parameters of the black hole mass distribution.

Parameters

[mass] (default 1.0d0) — The mass (in \(\mathrm{M}_\odot\)) of the black hole, which is treated as a point mass whose gravitational potential is \(-\mathrm{G}M/r\).
[dimensionless] (default .true.) — If true the point mass distribution 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.

`massDistributionBurkert`¶

A mass distribution class which implements the (Burkert, 1995) density profile:

\[\rho_\mathrm{dark matter}(r) = \rho_0 \left(1+{r\over r_\mathrm{s}}\right)^{-1} \left(1+[{r\over r_\mathrm{s}}]^2\right)^{-1}.\]

The mass enclosed within radius \(r\) is given by

\[M(<r) = \pi \rho_0 r_\mathrm{s}^3 \left[ 2 \log(1 + R) + \log(1 + R^2) -2 \tan^{-1}(R) \right]\]

where \(R=r/r_\mathrm{s}\). The associated gravitational potential is

\[\Phi(r) = - \frac{\mathrm{G} \pi \rho_0 r_\mathrm{s}^2}{R} \left[ (R-1) \log \left(R^2+1\right)-2 (R+1) \log (R+1)-2 (R+1) \cot^{-1}(R)+\pi \right]\]

The peak of the rotation curve occurs at \(R=3.2446257246042642\) (found by numerical solution) at which point the rotation curve amplitude is 1.644297750532498, and the Fourier transform of the profile, \(F(k) = \int_0^c 4 \pi r^2 \exp(-i k r) \rho(r) \mathrm{d} r / k r\) (needed in calculations of clustering using the halo model) is given by

\[\begin{split}F(k) & = (1+i) \frac{\pi}{k m(c) } \left( \right. \nonumber \\ & + \exp( k) \left\{ -i \pi -\mathrm{E}_\mathrm{i}[- k]+\mathrm{E}_\mathrm{i}[(-1+ic)k] \right\} \nonumber \\ & +(1-i) \exp(-k) \left\{ +\mathrm{E}_\mathrm{i}[-i k]+\mathrm{E}_\mathrm{i}[(+i+ic)k] \right\} \nonumber \\ & + i \exp(-k) \left\{ +\mathrm{E}_\mathrm{i}[+ k]+\mathrm{E}_\mathrm{i}[(+1+ic)k] \right\} \nonumber \\ & \left. \right).\end{split}\]

Methods

timeFreefallTabulate — Tabulate the freefall time as a function of radius in a scale-free Burkert mass distribution.

Parameters

[densityNormalization] (default 1.0d0/Pi/(log(8.0d0)-Pi/2.0d0)) — The density normalization of the Burkert profile.
[scaleLength] (default 1.0d0) — The scale radius of the Burkert profile.
[mass] (default 1.0d0) — The total mass (in \(\mathrm{M}_\odot\)) of the Burkert profile, used to set the density normalization \(\rho_0\) when densityNormalization is not supplied.
[radiusOuter] — The outer radius of the Burkert profile.
[dimensionless] (default .true.) — If true the Burkert 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.

`massDistributionCloudOverdensities`¶

A mass distribution class that overlays a population of randomly placed, constant-density spherical clouds on top of an underlying smooth mass distribution. Cloud properties are set by [radius], [densityContrast], and [volumeFillingFactor], with inter-cloud gas characterized by [densityContrastIntercloud].

Parameters

[radius] — The radius (in Mpc) of each individual constant-density spherical cloud overlaid on the smooth background mass distribution.
[densityContrast] — The overdensity contrast of the clouds relative to the smooth background; values greater than 1 indicate denser clouds, which are used to compute the density inside cloud regions.
[volumeFillingFactor] — The fraction of the total volume filled by clouds; used together with the cloud radius to determine the number of clouds randomly placed within the boundary radius.
[radiusBoundary] — The boundary radius within which to populate clouds.
[dimensionless] (default .true.) — If true the cloud overdensities 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.

`massDistributionComposite`¶

A mass distribution class formed by superposing multiple component mass distributions (e.g.dark matter halo, disk, bulge, black hole), returning the combined density, potential, and enclosed mass as the sum over all components.

Methods

initialize — Initialize the mass distribution after construction.
subset — Return a subset of a composite mass distribution.
describe — Display a description of a composite mass distribution.

`massDistributionConstantDensityCloud`¶

A mass distribution class for constant density spherical clouds.

Parameters

[mass] — The total mass (in \(\mathrm{M}_\odot\)) of the constant-density spherical cloud, used together with the radius to set the uniform density of the cloud.
[radius] — The outer radius (in Mpc) of the constant-density spherical cloud; the density is zero beyond this radius and uniform within it.
[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.

`massDistributionCoredNFW`¶

A cored NFW (Navarro et al., 1996) mass distribution class. The density profile is given by:

\[ \rho_\mathrm{dark matter}(r) \propto \left({r_\mathrm{c}\over r_\mathrm{s}}+{r\over r_\mathrm{s}}\right)^{-1} \left[1 + \left({r\over r_\mathrm{s}}\right) \right]^{-2}.\]

Parameters

[densityNormalization] (default 1.0d0/2.0d0/Pi/(log(4.0d0)-1.0d0)) — The density normalization of the cored NFW profile.
[radiusScale] (default 1.0d0) — The scale radius of the cored NFW profile.
[radiusCore] (default 1.0d0) — The core radius of the cored NFW profile.
[mass] (default 1.0d0) — The total mass (in \(\mathrm{M}_\odot\)) of the cored NFW halo, used to set the density normalization when the concentration and virial radius are provided instead of densityNormalization.
[concentration] (default 1.0d0) — The concentration of the cored NFW profile.
[radiusVirial] (default 1.0d0) — The virial radius of the cored NFW profile.
[dimensionless] (default .true.) — If true the cored 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.
[toleranceRelativePotential] (default 1.0d-3) — The relative tolerance to use in numerical solutions for the gravitational potential.

`massDistributionCorrelationFunction`¶

An accretion flow class which models the accretion flow using the 2-halo correlation function.

Parameters

[scaleFactorVelocity] (default 1.0d0) — A dimensionless multiplicative scale factor applied to the inflow velocities computed from the correlation-function-based accretion flow model, allowing calibration of the infall velocity amplitude relative to the two-point clustering prediction.
[mass] — The virial mass (in \(\mathrm{M}_\odot\)) of the halo whose accretion flow is being modeled via the 2-halo correlation function.
[redshift] — The cosmological redshift of the halo, used to convert to cosmic time for evaluating the correlation function-based accretion flow density profile.
[radius] — The radius in the tabulated correlation function.
[correlationFunction] — The correlation in the tabulated correlation function.
[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.

`massDistributionCuspNFW`¶

The cusp-NFW mass distribution (Delos, 2025). The density profile is given by:

\[\rho_\mathrm{dark matter}(r) = \rho_\mathrm{s} \left(y^2+{r\over r_\mathrm{s}}\right)^{1/2} \left({r\over r_\mathrm{s}}\right)^{-3/2} \left[1 + \left({r\over r_\mathrm{s}}\right) \right]^{-2},\]

where \(\rho_\mathrm{s}\) and \(r_\mathrm{s}\) are the usual NFW density normalization and scale length, and \(y = A/\rho_s r_\mathrm{s}^{3/2}\) characterizes the amplitude of the cusp, with \(A\) being the “cusp coefficient” as defined by Delos (2025).

Parameters

[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.
[toleranceRelativeVelocityDispersion] (default 1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion.
[toleranceRelativeVelocityDispersionMaximum] (default 1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion.
[velocityDispersionUseSeriesExpansion] (default .true.) — If true, radial velocity dispersion is computed using series expansion (but only for the case of \(y=0\), i.e. an NFW profile).
[densityNormalization] (default 1.0d0/2.0d0/Pi/(log(4.0d0)-1.0d0)) — The density normalization of the cusp-NFW profile.
[radiusScale] (default 1.0d0) — The scale radius of the cusp-NFW profile.
[y] (default 0.0d0) — The cusp amplitude parameter the cusp-NFW profile.
[mass] (default 1.0d0) — The total mass (in \(\mathrm{M}_\odot\)) of the cusp-NFW halo, used to set the density normalization when the concentration and virial radius are provided instead of densityNormalization.
[concentration] (default 1.0d0) — The concentration of the cusp-NFW profile.
[radiusVirial] (default 1.0d0) — The virial radius of the cusp-NFW profile.
[dimensionless] (default .true.) — If true the cusp-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.
[toleranceRelativePotential] (default 1.0d-3) — The relative tolerance to use in numerical solutions for the gravitational potential.

`massDistributionCylindrical`¶

An abstract mass distribution class for cylindrically symmetric distributions.

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).

`massDistributionCylindricalScaler`¶

A mass distribution class for scaling cylindrical mass distributions. Specifically, the density at position \(\mathbf{x}\) is given by

\[\rho(\mathbf{x}) = \frac{f_\mathrm{M}}{f_\mathrm{r}^3} \rho^\prime(\mathbf{x}/f_\mathrm{r}),\]

where \(\rho^\prime(\mathbf{x})\) is the original mass distribution, and \(f_\mathrm{r}=\)[factorScalingLength], and \(f_\mathrm{M}=\)[factorScalingMass].

Methods

initialize — (Re)initialize the scaling factors of the scaled mass distribution.

Parameters

[factorScalingLength] — The multiplicative factor applied to all length scales in the underlying kinematic distribution; used to rescale the distribution from one physical size to another.
[factorScalingMass] — The multiplicative factor applied to the mass normalization of the underlying kinematic distribution; used to rescale the distribution from one physical mass to another.
[factorScalingLength] — The factor by which to scale lengths.
[factorScalingMass] — The factor by which to scale the mass.
[factorScalingLength] — The factor by which to scale lengths.
[factorScalingMass] — The factor by which to scale the mass.

`massDistributionDiemerKravtsov2014`¶

A mass distribution class for accretion flows which models the accretion flow using the fitting function of Diemer and Kravtsov (2014). Specifically, the density profile of the accretion flow is modeled using their equation (4).

Parameters

[b0] (default +1.1250d0) — The parameter \(b_0\) in the fitting function \(b(\nu,z)=b_0 (1+z)^{b_z} \nu^{b_\nu}\) for the parameter \(b(\nu,z)\) appearing in equation (4) of Diemer and Kravtsov (2014).
[bz] (default +0.625d0) — The parameter \(b_z\) in the fitting function \(b(\nu,z)=b_0 (1+z)^{b_z} \nu^{b_\nu}\) for the parameter \(b(\nu,z)\) appearing in equation (4) of Diemer and Kravtsov (2014).
[bnu] (default -0.2250d0) — The parameter \(b_\nu\) in the fitting function \(b(\nu,z)=b_0 (1+z)^{b_z} \nu^{b_\nu}\) for the parameter \(b(\nu,z)\) appearing in equation (4) of Diemer and Kravtsov (2014).
[s0] (default +1.3925d0) — The parameter \(s_0\) in the fitting function \(s(\nu,z)=s_0 (1+z)^{s_z} \nu^{s_\nu}\) for the parameter \(s(\nu,z)\) appearing in equation (4) of Diemer and Kravtsov (2014).
[sz] (default -0.199d0) — The parameter \(s_z\) in the fitting function \(s(\nu,z)=s_0 (1+z)^{s_z} \nu^{s_\nu}\) for the parameter \(s(\nu,z)\) appearing in equation (4) of Diemer and Kravtsov (2014).
[snu] (default +0.0875d0) — The parameter \(s_\nu\) in the fitting function \(s(\nu,z)=s_0 (1+z)^{s_z} \nu^{s_\nu}\) for the parameter \(s(\nu,z)\) appearing in equation (4) of Diemer and Kravtsov (2014).
[densityMean] — The mean density of the universe in the Diemer and Kravtsov (2014) accretion flow mass distribution.
[radius200Mean] — The radius enclosing a density of 200 times the mean density of the universe in the Diemer and Kravtsov (2014) accretion flow mass distribution.
[includeMean] (default .true.) — If true, include the mean density of the universe in the profile, otherwise, subtract off that mean density.
[b] — The coefficient \(b\) in the Diemer and Kravtsov (2014) accretion flow mass distribution.
[s] — The exponent \(s\) in the Diemer and Kravtsov (2014) accretion flow mass distribution.
[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.

`massDistributionEinasto`¶

An Einasto (e.g. Cardone et al. 2005) mass distribution class. The density profile is given by:

\[\rho_\mathrm{dark matter}(r) = \rho_{-2} \exp \left( - {2 \over \alpha} \left[ \left( {r \over r_{-2}} \right)^\alpha - 1 \right] \right).\]

Methods

timeFreefallTabulate — Tabulate the freefall time as a function of radius in a scale-free Einasto mass distribution.
timeFreefallMinimum — Compute the minimum freefall time in a scale-free Einasto mass distribution.

Parameters

[shapeParameter] — The shape parameter, \(\alpha\), of the Einasto profile.
[densityNormalization] (default shapeParameter/4.0d0/Pi*(2.0d0/shapeParameter)**(3.0d0/shapeParameter)*exp(-2.0d0/shapeParameter)/Gamma_Function(3.0d0/shapeParameter)) — The density normalization of the Einasto profile.
[scaleLength] (default 1.0d0) — The scale radius of the Einasto profile.
[mass] (default 1.0d0) — The total mass (in \(\mathrm{M}_\odot\)) of the Einasto profile, used to set the density normalization \(\rho_{-2}\) when densityNormalization is not supplied.
[concentration] (default 1.0d0) — The concentration of the Einasto profile.
[virialRadius] (default 1.0d0) — The virial radius of the Einasto profile.
[dimensionless] (default .true.) — If true the Einasto 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.

`massDistributionEnzoHydrostatic`¶

A hot halo mass distribution class which adopts a spherically symmetric density profile for the hot halo motivated by the “hydrostatic” profile available in the ENZO code. Specifically,

\[\begin{split}\rho_\mathrm{hot halo}(r) \propto \left\{ \begin{array}{ll} T^{-1} r^{-1} & \hbox{ if } r > r_\mathrm{core} \\ T^{-1} r_\mathrm{core}^{-1} & \hbox{ if } r \le r_\mathrm{core}, \end{array} \right.\end{split}\]

where the core radius, \(r_\mathrm{core}\), is set using the selected cored profile core radius method (see hotHaloMassDistributionCoreRadius). The profile is normalized such that the current mass in the hot gas profile is contained within the outer radius of the hot halo, \(r_\mathrm{hot, outer}\). Note that the ENZO hydrostatic profile does not include this core, but without introducing this the profile mass can be divergent at small radii.

Methods

normalizationDensity — Return the normalization of the density profile.

Parameters

[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.
[mass] — The total mass (in \(\mathrm{M}_\odot\)) of the hot gas distribution enclosed within radiusOuter; used to normalize the Enzo hydrostatic density profile.
[radiusOuter] — The outer radius of the mass distribution.
[radiusScale] — The core radius of the mass distribution.
[truncateAtOuterRadius] (default .false.) — If true then the mass distribution is truncated beyond the outer radius.

`massDistributionExponentialDisk`¶

The exponential disk mass distribution: \(\rho(r,z)=\rho_0 \exp(-r/r_\mathrm{s}) \hbox{sech}^2(z/z_\mathrm{s})\).

Methods

tabulate — Tabulates the potential for an exponential disk mass distribution.
besselFactorRotationCurve — Compute the Bessel function factor appearing in the exponential disk rotation curve.
besselFactorRotationCurveGradient — Compute the Bessel function factor appearing in the exponential disk rotation curve gradient.
besselFactorPotential — Compute the Bessel function factor appearing in the exponential disk potential.
accelerationTabulate — Tabulate the gravitational acceleration and tidal tensor due to the disk.
accelerationInterpolate — Interpolate in the tabulated gravitational acceleration and/or tidal tensor due to the disk.

Parameters

[scaleHeight] (default 0.137d0) — The scale height of the exponential disk profile.
[scaleRadius] (default 1.0d0) — The scale radius of the exponential disk profile.
[mass] (default 1.0d0) — The mass of the exponential disk profile.
[dimensionless] (default .true.) — If true the exponential disk 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.

`massDistributionGaussianEllipsoid`¶

A mass distribution class for triaxial Gaussian ellipsoids following the parameterization of Chandrasekhar (1987). The density is a Gaussian function of the ellipsoidal radius, with independent scale lengths along each of the three principal axes, and the gravitational acceleration is computed via tabulated integrals.

Methods

densityEllipsoidal — Compute the density on the isodensity surface defined by the parameter \(m^2\)2.
accelerationTabulate — Tabulate the gravitational acceleration due to the ellipsoid.
accelerationInterpolate — Interpolate in the tabulated gravitational acceleration due to the ellipsoid.
initialize — (Re)initialize the structural properties of the Gaussian ellispoid.

Parameters

[mass] — The total mass (in \(\mathrm{M}_\odot\)) of the triaxial Gaussian ellipsoid, used together with the scale lengths to set the peak density normalization of the distribution.
[scaleLength] — The scale lengths of the ellipsoid along each axis.
[axis1] (default [1.0d0,0.0d0,0.0d0]) — The unit vector defining the first axis of the ellipsoid.
[axis2] (default [0.0d0,1.0d0,0.0d0]) — The unit vector defining the second axis of the ellipsoid.
[axis3] (default [0.0d0,0.0d0,1.0d0]) — The unit vector defining the third axis of the ellipsoid.
[dimensionless] (default .true.) — If true the Gaussian ellipsoid 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.

`massDistributionGaussianSlab`¶

An infinite radial extent gas slab with a Gaussian vertical distribution: \(\rho(r,z)=\rho_0 \exp(z^2/2 z^2_\mathrm{s})\).

Parameters

[scaleHeight] (default 0.137d0) — The scale height of the Gaussian slab profile.
[densityCentral] (default 1.0d0) — The gas density at the slab mid-plane (\(z=0\)), \(\rho_0\), which sets the overall normalization of the Gaussian vertical profile \(\rho(z) = \rho_0 \exp(-z^2/2 z_\mathrm{s}^2)\).
[dimensionless] (default .true.) — If true the Gaussian slab 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.

`massDistributionHernquist`¶

A Hernquist (1990) mass distribution class.

Parameters

[densityNormalization] (default 0.5d0/Pi) — The density normalization of the Hernquist profile.
[scaleLength] (default 1.0d0) — The scale radius of the Hernquist profile.
[mass] (default 1.0d0) — The total mass (in \(\mathrm{M}_\odot\)) of the Hernquist profile, used to set the density normalization when densityNormalization is not supplied directly.
[dimensionless] (default .true.) — If true the Hernquist 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.

`massDistributionIsothermal`¶

An isothermal mass distribution class in which the density profile is given by:

\[\rho(r) \propto r^{-2}.\]

Parameters

[temperature] — The temperature (in Kelvin) of the isothermal gas distribution; used with massAtomicMean to compute the 1D velocity dispersion via \(\sigma^2 = k_\mathrm{B} T / (\mu m_\mathrm{H})\).
[massAtomicMean] — The mean atomic mass (in atomic mass units) of the distribution.
[velocityDispersion] — The 1D velocity dispersion (in km/s) of the isothermal distribution, used directly when no temperature is specified; sets the thermally broadened line-of-sight velocity spread.
[densityNormalization] (default 0.25d0/Pi) — The density normalization of the isothermal profile.
[lengthReference] (default 1.0d0) — The reference radius (in Mpc) of the isothermal profile at which densityNormalization is evaluated; sets the physical length scale of the \(\rho \propto r^{-2}\) profile.
[mass] (default 1.0d0) — The total mass (in \(\mathrm{M}_\odot\)) enclosed within the reference radius, used to normalize the \(\rho \propto r^{-2}\) density profile when densityNormalization is not supplied.
[dimensionless] (default .true.) — If true the isothermal 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.

`massDistributionMiyamotoNagai`¶

An Miyamoto-Nagai model (Miyamoto and Nagai, 1975) mass distribution class.

Methods

surfaceDensityTabulate — Initialize the surface density tabulation.
massEnclosedTabulate — Initialize the enclosed mass tabulation.

Parameters

[a] (default 1.0d0) — The \(a\) parameter of the MiyamotoNagai profile.
[b] (default 1.0d0) — The \(b\) parameter of the MiyamotoNagai profile.
[mass] (default 1.0d0) — The mass of the MiyamotoNagai profile.
[dimensionless] (default .true.) — If true the MiyamotoNagai 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.

`massDistributionNFW`¶

An NFW (Navarro et al., 1996) mass distribution class. The density profile is given by:

\[ \rho_\mathrm{dark matter}(r) \propto \left({r\over r_\mathrm{s}}\right)^{-1} \left[1 + \left({r\over r_\mathrm{s}}\right) \right]^{-2}.\]

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.

`massDistributionPatejLoeb2015`¶

A mass distribution for the Patej and Loeb (2015) model of the circumgalactic medium.

Methods

radiusDarkMatter — Return the corresponding radius in the dark matter profile.
coordinatesDarkMatter — Return the corresponding coordinates in the dark matter profile.

Parameters

[gamma] (default 1.15d0) — The parameter \(\Gamma\) in the Patej and Loeb (2015) hot halo gas mass distribution model.
[radiusShock] (default 1.0d0) — The shock radius, \(s\), (in units of the halo virial radius) in the Patej and Loeb (2015) hot halo gas mass distribution model.
[gamma] (default 1.15d0) — The parameter \(\Gamma\) in the Patej and Loeb (2015) mass distribution.
[densityNormalization] (default 0.0d0) — The density normalization of the Patej and Loeb (2015) mass distribution.
[mass] (default 0.0d0) — The mass of the Patej and Loeb (2015) mass distribution.
[radiusOuter] (default 0.0d0) — The outer radius of the Patej and Loeb (2015) mass distribution.
[truncateAtOuterRadius] (default .false.) — If true then the Patej and Loeb (2015) mass distribution is truncated beyond the outer radius.
[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.

`massDistributionSersic`¶

A S'ersic mass distribution class implementing the spherically deprojected form of the S'ersic surface brightness profile \(I(R) \propto \exp(-b_n [(R/R_e)^{1/n}-1])\), where \(n\) controls the profile shape.

Methods

tabulate — Tabulate the Sersic profile.
radiusHalfMassProjected — Return the half mass radius of the profile in projection.

Parameters

[index] (default 4.0d0) — The S'ersic index \(n\) that controls the shape of the surface brightness (or mass surface density) profile; \(n=1\) gives an exponential profile, \(n=4\) gives the de Vaucouleurs profile, and larger \(n\) produces more centrally concentrated profiles.
[radiusHalfMass] (default 1.0d0) — The projected half-mass (effective) radius (in Mpc) of the S'ersic profile, \(R_e\), within which half the total projected mass is enclosed.
[mass] (default 1.0d0) — The total mass (in \(\mathrm{M}_\odot\)) of the S'ersic profile, used together with index and radiusHalfMass to set the overall normalization of the density distribution.
[dimensionless] (default .true.) — If true the S'ersic 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.

`massDistributionShi2016`¶

A mass distribution for accretion flows using the framework of Shi (2016).

Methods

solve — Solve for the structure of the accretion flow.

Parameters

[scaleFactorVelocity] (default 1.0d0) — A dimensionless multiplicative scale factor applied to the inflow velocities computed from the Shi (2016) splashback and accretion flow model, allowing calibration of the infall velocity amplitude relative to the theoretical prediction.
[mass] — The virial mass (in \(\mathrm{M}_\odot\)) of the halo used to set the normalization of the Shi (2016) accretion flow density profile.
[massAccretionRate] — The mass accretion rate (in \(\mathrm{M}_\odot\)/Gyr) of the halo, used in the Shi (2016) framework to set the amplitude of the outer accretion flow density profile.
[radiusVirial] — The virial radius (in Mpc) of the halo, used together with the turnaround radius ratio to set the spatial scale of the Shi (2016) accretion flow.
[ratioRadiusTurnaroundVirial] — The ratio of the turnaround to virial radii of the halo.
[redshift] — The cosmological redshift of the halo, used to evaluate the cosmic time and expansion factor for the Shi (2016) accretion flow solution.
[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.

`massDistributionSIDMParametricProfile`¶

A mass distribution class for the SIDM parametric profile of Yang et al. (2024). The density profile is given by:

\[ \rho(r) = \rho_\mathrm{s} \left[ \left( \left[\frac{r}{r_\mathrm{s}}\right]^\beta + \left[\frac{r_\mathrm{c}}{r_\mathrm{s}}\right]^\beta \right)^{1/\beta} \left( 1 + \frac{r}{r_\mathrm{s}} \right)^2 \right]^{-1}.\]

Parameters

[beta] (default 4.0d0) — The value \(\beta\) in a SIDM parametric mass distribution.
[densityNormalization] (default 0.0d0) — The density normalization of a SIDM parametric mass distribution.
[radiusScale] (default 0.0d0) — The scale of a SIDM parametric mass distribution.
[radiusCore] (default 0.0d0) — The core radius of a SIDM parametric mass distribution.
[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.

`massDistributionSoliton`¶

A mass distribution class representing the solitonic core of fuzzy dark matter halos (Schive et al., 2014).

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).

`massDistributionSolitonNFW`¶

A mass distribution class for fuzzy dark matter halos (Schive et al., 2014) consisting of soliton core for small radii, transitioning to an NFW profile at larger radii.

Methods

computeProperties — Compute properties of the mass distribution.
calculationReset — Reset memoized calculations.

Parameters

[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.
[toleranceRelativeVelocityDispersion] (default 1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion.
[toleranceRelativeVelocityDispersionMaximum] (default 1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion.
[scatterFractional] (default 0.5d0) — The fractional scatter in the solitonic core-halo mass relation (default corresponds to a 50% fractional scatter).
[radiusScale] — The scale radius of the NFW component of the mass distribution.
[radiusCore] — The soliton core radius (in Mpc) characterizing the size of the central quantum pressure-supported core of the fuzzy dark matter halo before the profile transitions to the outer NFW envelope.
[radiusSoliton] — The transition radius (in Mpc) at which the solitonic core profile smoothly joins onto the outer NFW envelope; the density profile matches the NFW form beyond this radius.
[densitySolitonCentral] — The central density (in \(\mathrm{M}_\odot\)/Mpc\(^3\)) of the solitonic core at \(r=0\), which sets the normalization of the soliton density profile \(\rho(r) = \rho_\mathrm{c} [1+(r/r_c)^2]^{-8}\).
[densityNormalizationNFW] — The density normalization \(\rho_0\) (in \(\mathrm{M}_\odot\)/Mpc\(^3\)) of the outer NFW component, setting the amplitude of the \(\rho(r) = \rho_0/[(r/r_\mathrm{s})(1+r/r_\mathrm{s})^2]\) profile.
[concentration] — The concentration parameter \(c = r_\mathrm{vir}/r_\mathrm{s}\) of the outer NFW component, specifying how centrally concentrated the NFW halo is.
[radiusVirial] — The virial radius (in Mpc) of the outer NFW component, defining the outer boundary of the halo at which the mean enclosed density equals the virial overdensity threshold.
[toleranceRelativePotential] (default 1.0d-3) — The relative tolerance used in numerical ODE solutions for the gravitational potential of the soliton-NFW composite profile.
[dimensionless] (default .true.) — If true the soliton-NFW 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.

`massDistributionSolitonNFWHeated`¶

A mass distribution class for fuzzy dark matter halos (Schive et al., 2014) consisting of soliton core for small radii, transitioning to a heated NFW profile at larger radii.

Methods

computeProperties — Compute properties of the mass distribution.
calculationReset — Reset memoized calculations.

Parameters

[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.
[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.
[tolerateEnclosedMassIntegrationFailure] (default .false.) — If true, tolerate failures to find the mass enclosed as a function of radius.
[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 the heated soliton-NFW dark matter profile (e.g. due to extreme heating), allowing the calculation to proceed with a fallback result.
[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.
[toleranceRelativeVelocityDispersion] (default 1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion.
[toleranceRelativeVelocityDispersionMaximum] (default 1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion.
[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.
[scatterFractional] (default 0.5d0) — The fractional scatter in the solitonic core-halo mass relation (default corresponds to a 50% fractional scatter).
[radiusCore] — The soliton core radius (in Mpc) that characterizes the size of the central quantum pressure-supported core of the fuzzy dark matter halo; density is approximately constant within this radius.
[radiusSoliton] — The outer radius (in Mpc) of the soliton region, beyond which the profile transitions from the soliton core to the heated NFW outer envelope.
[densitySolitonCentral] — The central density (in \(\mathrm{M}_\odot\)/Mpc\(^3\)) of the solitonic core at \(r=0\), which sets the normalization of the soliton density profile \(\rho(r) = \rho_\mathrm{c} [1+(r/r_\mathrm{c})^2]^{-8}\).
[toleranceRelativePotential] (default 1.0d-3) — The relative tolerance used in numerical ODE solutions for the gravitational potential of the heated soliton-NFW composite profile.
[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.

`massDistributionSpherical`¶

An abstract mass distribution class for spherically symmetric distributions.

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).

`massDistributionSphericalAccelerator`¶

Accelerates spherical mass distribution classes by storing previous results for the enclosed mass and interpolating where possible.

Methods

tabulate — Tabulate the mass function.

Parameters

[toleranceRelative] (default 1.0d-2) — The relative tolerance within which a cached (accelerated) profile estimate is accepted; if the requested radius differs from the cached value by more than this fractional amount, the full profile calculation is recomputed.
[factorRadiusMaximum] (default 3.0d0) — The maximum radial extrapolation factor allowed when using cached profile values for the dark-matter-only profile; if the requested radius exceeds the cached radius by more than this factor, the full calculation is recomputed.
[toleranceRelative] (default 1.0d-2) — The toleranceRelative with which to accept accelerated estimates.
[factorRadiusMaximum] (default 3.0d0) — The maximum radial extrapolation factor allowed when using cached profile values; if the requested radius differs from the cached radius by more than this factor, the full profile is recomputed rather than interpolated.
[toleranceRelative] (default 1.0d-2) — The tolerance with which to accept accelerated estimates.
[factorRadiusMaximum] (default 3.0d0) — The maximum factor by which to interpolate in radius.
[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.
[tablePointsPerDecade] (default 10) — The number of points per decade of wavenumber at which to tabulate the transfer function.

`massDistributionSphericalAccretionFlow`¶

An implementation of a mass distribution which includes the accretion flow surrounding a halo. The density profile is modeled as

\[\rho(r) = f_\mathrm{trans}(r) \rho_\mathrm{halo}(r) + \rho_\mathrm{accretion}(r),\]

where \(\rho_\mathrm{halo}(r)\) is the halo mass distribution, \(\rho_\mathrm{accretion}(r)\) is the accretion flow mass distribution, and

\[f_\mathrm{trans}(r) = \left( 1 + \left[\frac{r}{r_\mathrm{trans}}\right]^4 \right)^{-2}.\]

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).

`massDistributionSphericalAdiabaticGnedin2004`¶

A dark matter profile class which applies adiabatic contraction to the halo as it responds to the presence of baryons. Adiabatic contraction follows the algorithm of Gnedin et al. (2004). The parameters \(A\) and \(\omega\) of that model are specified via input parameters A and omega respectively.

Given the final radius, \(r_\mathrm{f}\), the corresponding initial radius, \(r_\mathrm{i}\), is found by solving:

(14)¶\[f_\mathrm{i} M_\mathrm{total,0}(\bar{r}_\mathrm{i}) r_\mathrm{i} = f_\mathrm{f} M_\mathrm{total,0}(\bar{r}_\mathrm{i}) r_\mathrm{f} + V^2_\mathrm{b}(\bar{r}_\mathrm{f}) \bar{r}_\mathrm{f} r_\mathrm{f}/ \mathrm{G},\]

where \(M_\mathrm{total,0}(r)\) is the initial total matter profile, \(V_\mathrm{b}(r)\) is the baryonic contribution to the rotation curve, \(f_\mathrm{i}\), is the fraction of mass within the virial radius compared to the node massfootnoteIn Galacticus the “node mass” refers to the total mass of the node, assuming it has the universal complement of baryons. Since some halos may contain less than the complete complement of baryons it is possible that \(f_\mathrm{i}<1\)., \(f_\mathrm{f}=(\Omega_\mathrm{M}-\Omega_\mathrm{b})/\Omega_\mathrm{M}+M_\mathrm{satellite, baryonic}/M_\mathrm{total}\), \(M_\mathrm{satellite, baryonic}\) is the baryonic mass in any satellite halos, \(M_\mathrm{total}\) is the node mass, and

(15)¶\[{\bar{r} \over r_0} = A \left({r \over r_0}\right)^\omega,\]

where the pivot radius \(r_0\) is set to \(f_0 r_\mathrm{vir}\) where \(f_0=\)[radiusFractionalPivot], and \(r_\mathrm{vir}\) is the virial radius. The original Gnedin et al. (2004) assumed \(f_0=1\), but the revised model of Gnedin et al. (2011) found that \(f_0=0.03\) lead to an improved model (less scatter in the best fit values of \((A,\omega)\) when comparing to N-body simulations).

Note that we explicitly assume that the initial, uncontracted total density profile has the same shape as the initial dark matter density profile, that contraction of the halo occurs with no shell crossing, and that satellite halos trace the dark matter profile of their host halo. The derivative, \(\mathrm{d} r_\mathrm{f}/\mathrm{d}d_\mathrm{i}\equiv r^\prime_\mathrm{i}\) is found by taking the derivative of eqn. ((14)) to give:

\[\begin{split}& f_\mathrm{i} M_\mathrm{total,0}(\bar{r}_\mathrm{i}) r^\prime_\mathrm{i} + f_\mathrm{i} 4 \pi \bar{r}_\mathrm{i}^2 \rho_\mathrm{total,0}(\bar{r}_\mathrm{i}) {\mathrm{d} \bar{r}_\mathrm{i}\over\mathrm{d} r_\mathrm{i}} r_\mathrm{i} r^\prime_\mathrm{i} \nonumber \\ & = f_\mathrm{f} M_\mathrm{total,0}(\bar{r}_\mathrm{i}) + f_\mathrm{i} 4 \pi \bar{r}_\mathrm{i}^2 \rho_\mathrm{total,0}(\bar{r}_\mathrm{i}) {\mathrm{d} \bar{r}_\mathrm{i}\over\mathrm{d} r_\mathrm{i}} r_\mathrm{f} r^\prime_\mathrm{i} \nonumber \\ & + V^2_\mathrm{b}(\bar{r}_\mathrm{f}) \bar{r}_\mathrm{f} / \mathrm{G} + V^2_\mathrm{b}(\bar{r}_\mathrm{f}) {\mathrm{d}\bar{r}_\mathrm{f}\over \mathrm{d} r_\mathrm{f}} r_\mathrm{f}/ \mathrm{G} + {\mathrm{d}V^2_\mathrm{b}\over\mathrm{d} \bar{r}_\mathrm{f}}(\bar{r}_\mathrm{f}) {\mathrm{d}\bar{r}_\mathrm{f}\over \mathrm{d} r_\mathrm{f}} \bar{r}_\mathrm{f} r_\mathrm{f}/ \mathrm{G},\end{split}\]

where

\[{\mathrm{d}\bar{r} \over \mathrm{d} r} = A \left({r \over r_0}\right)^{\omega-1},\]

and which can then be solved numerically for \(r^\prime_\mathrm{i}\).

Methods

setBaryonicComponent — Set baryonic components in the mass distribution.
computeFactors — Compute factors needed for solving adiabatic contraction.
radiusOrbitalMean — Compute the orbit-averaged radius for dark matter.
radiusOrbitalMeanDerivative — Compute the derivative of the orbit-averaged radius for dark matter.
radiusInitial — Compute the initial radius in the dark matter profile.
radiusInitialDerivative — Compute the derivative of the initial radius in the dark matter profile.

Parameters

[A] (default 0.80d0) — The parameter \(A\) appearing in the Gnedin et al. (2004) adiabatic contraction algorithm.
[omega] (default 0.77d0) — The parameter \(\omega\) appearing in the Gnedin et al. (2004) adiabatic contraction algorithm.
[radiusFractionalPivot] (default 1.0d0) — The pivot radius (in units of the virial radius), \(r_0\), appearing in equation ((15)).
[toleranceRelative] (default 1.0d-2) — The relative tolerance to use in solving for the initial radius in the adiabatically-contracted dark matter 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 adiabatic contraction by baryons is used, while if set to “numerical” then numerical solvers are used to find solutions.
[A] (default 0.80d0) — The parameter \(A\) appearing in the Gnedin et al. (2004) adiabatic contraction algorithm.
[omega] (default 0.77d0) — The parameter \(\omega\) appearing in the Gnedin et al. (2004) adiabatic contraction algorithm.
[radiusFractionalPivot] (default 1.0d0) — The pivot radius (in units of the virial radius), \(r_0\), appearing in equation ((15)).
[radiusVirial] — The virial radius, \(r_\mathrm{v}\), appearing in equation ((15)).
[darkMatterFraction] — The universal cosmic dark matter fraction \(\Omega_\mathrm{DM}/\Omega_\mathrm{M}\), used to define the initial dark matter fraction in the halo before adiabatic contraction.
[darkMatterDistributedFraction] — The fraction of matter assumed to be distributed as the dark matter.
[massFractionInitial] — The fraction of matter assumed to be initially distributed as the dark matter.
[toleranceRelative] (default 1.0d-2) — The relative tolerance to use in solving for the initial radius in the adiabatically-contracted dark matter 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.
[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.

`massDistributionSphericalDecaying`¶

Decaying dark matter halo profiles.

Methods

lifetime — Return the lifetime of the dark matter particle.
massSplitting — Return the mass splitting of the decay.
velocityKick — Return the velocity kick imparted by the decay.

Parameters

[toleranceRelativeVelocityDispersion] (default 1.0d-6) — The relative tolerance to use in numerical solutions for the velocity dispersion.
[toleranceRelativeVelocityDispersionMaximum] (default 1.0d-3) — The maximum relative tolerance to use in numerical solutions for the velocity dispersion.
[toleranceRelativePotential] (default 1.0d-3) — The relative tolerance to use in numerical solutions for the gravitational potential.
[tolerateEnclosedMassIntegrationFailure] (default .false.) — If true, tolerate failures to find the mass enclosed as a function of radius.
[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 decaying dark matter profile (e.g. due to extreme decay fractions), allowing the calculation to proceed with a fallback result rather than terminating.
[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.
[toleranceRelativePotential] (default 1.0d-3) — The relative tolerance to use in numerical solutions for the gravitational potential.
[tolerateEnclosedMassIntegrationFailure] (default .false.) — If true, tolerate failures to find the mass enclosed as a function of radius.
[tolerateVelocityMaximumFailure] (default .false.) — If true, tolerate failures to find the radius of the maximum circular velocity.
[toleratePotentialIntegrationFailure] (default .false.) — If true, tolerate failures to compute the potential.
[radiusEscape] — The radius beyond which a particle is assumed to have escaped the potential.
[time] — The time at which decays should be evaluated.
[lifetime] — The mean lifetime (in Gyr) of the decaying dark matter particle before it decays into lighter daughter particles, controlling the timescale over which dark matter density is reduced by decay.
[massSplitting] — The fractional mass splitting \(\epsilon = \Delta m / m\) between the parent and daughter dark matter particles in the decay, used to compute the velocity kick imparted to the daughter particle.
[velocityKick] — The velocity kick (in km/s) imparted to the daughter dark matter particle when the parent decays, which heats and disrupts the dark matter distribution in halos over time.

`massDistributionSphericalDecorator`¶

An abstract mass distribution class for decorators of other mass distributions. “Fallthrough” functions are provided that all the decorated class or numerical solutions to be used.

Methods

massEnclosedBySphereNonAnalytic — Compute mass enclosed by a sphere for non-analytic cases.
radiusEnclosingMassNonAnalytic — Compute radius enclosing a mass for non-analytic cases.
densityGradientRadialNonAnalytic — Compute radial density gradient for non-analytic cases.
densityRadialMomentNonAnalytic — Compute radial density moment for non-analytic cases.
radiusEnclosingDensityNonAnalytic — Compute radius enclosing a mean density for non-analytic cases.
radiusFromSpecificAngularMomentumNonAnalytic — Compute radius from specific angular momentum for non-analytic cases.
fourierTransformNonAnalytic — Compute Fourier transform for non-analytic cases.
radiusFreefallNonAnalytic — Compute freefall radius for non-analytic cases.
radiusFreefallIncreaseRateNonAnalytic — Compute freefall radius growth rate for non-analytic cases.
potentialNonAnalytic — Compute gravitational potential for non-analytic cases.
energyNonAnalytic — Compute total energy for non-analytic cases.
energyPotentialNonAnalytic — Compute gravitational potential energy for non-analytic cases.
energyKineticNonAnalytic — Compute kinetic energy for non-analytic cases.
useUndecorated — Return true if the undecorated solution (instead of a numerical solution) should be used.

`massDistributionSphericalFiniteResolution`¶

A mass distribution class which applies a finite resolution to some other mass distribution class, typically to mimic the effects of finite resolution in an N-body simulation. Specifically, the density profile is given by

\[\rho(r) = \rho^\prime(r) \left( 1 + \left[ \frac{\Delta x}{r} \right]^2 \right)^{-1/2},\]

where \(\Delta x\) is the larger of the resolution length, [lengthResolution], and the radius in the original profile enclosing the mass resolution, [massResolution].

Note that this choice was constructed to give a constant density core in an NFW density profile. For a density profile, \(\rho^\prime(r)\), which rises more steeply than \(r^{-1}\) as \(r \rightarrow 0\) we will still have a cuspy density profile under this model.

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).

`massDistributionSphericalFiniteResolutionNFW`¶

A mass distribution class which applies a finite resolution to an NFW density profile, typically to mimic the effects of finite resolution in an N-body simulation. Specifically, the density profile is given by

\[\rho(r) = \rho_\mathrm{NFW}(r) \left( 1 + \left[ \frac{\Delta x}{r} \right]^2 \right)^{-1/2},\]

where \(\Delta x\) is the larger of the resolution length, [lengthResolution], and the radius in the original profile enclosing the mass resolution, [massResolution].

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.

`massDistributionSphericalHeated`¶

A mass distribution class in which the distribution starts out with a density profile defined by another massDistribution. This profile is then modified by heating, under the assumption that the energy of a shell of mass before and after heating are related by

\[-{ \mathrm{G} M^\prime(r^\prime) \over r^\prime } = -{ \mathrm{G} M(r) \over r } + 2 \epsilon(r),\]

where \(M(r)\) is the mass enclosed within a radius \(r\), and \(\epsilon(r)\) represents the specific heating in the shell initially at radius \(r\). Primes indicate values after heating, while unprimed variables indicate quantities prior to heating. With the assumption of no shell crossing, \(M^\prime(r^\prime)=M(r)\) and this equation can be solved for \(r\) given \(r^\prime\) and \(\epsilon(r)\).

Not all methods have analytic solutions for this profile. If [nonAnalyticSolver]\(=\)fallThrough then attempts to call these methods in heated profiles will simply return the result from the unheated profile, otherwise a numerical calculation is performed.

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).

`massDistributionSphericalHeatedMonotonic`¶

A mass distribution class in which dark matter halos start out with a density profile defined by another massDistributionClass. This profile is then modified by heating, under the assumption that the energy of a shell of mass before and after heating are related by

\[-{ \mathrm{G} M^\prime(r^\prime) \over r^\prime } = -{ \mathrm{G} M(r) \over r } + 2 \epsilon(r),\]

The above equation can be re-written as

\[-r^{\prime -1} = -r^{-1} + \xi(r),\]

where \(\xi(r) = 2 \epsilon(r)/[\mathrm{G} M(r)/r]\) measures the perturbation to the shell. To avoid shell crossing a monotonicity relation \(r_1 < r_2 \implies \xi(r_1) \le \xi(r_2)\) is enforced by starting at large radius and stepping inward, enforcing the condition in the next innermost shell as necessary.

Methods

computeSolution — Compute a solution for the heated profile.

Parameters

[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.
[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.
[radiusVirial] — The virial radius (in Mpc) of the halo, defining the outer boundary up to which the monotonic heating calculation tracks the energy-ordered shell mapping from the initial to heated 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.
[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.

`massDistributionSphericalScaler`¶

A mass distribution class for scaling spherical mass distributions. Specifically, the density at position \(\mathbf{x}\) is given by

\[\rho(\mathbf{x}) = \frac{f_\mathrm{M}}{f_\mathrm{r}^3} \rho^\prime(\mathbf{x}/f_\mathrm{r}),\]

where \(\rho^\prime(\mathbf{x})\) is the original mass distribution, and \(f_\mathrm{r}=\)[factorScalingLength], and \(f_\mathrm{M}=\)[factorScalingMass].

Methods

initialize — (Re)initialize the scaling factors of the scaled mass distribution.

Parameters

[factorScalingLength] — The multiplicative factor applied to all length scales in the underlying kinematic distribution; used to rescale the distribution from one physical size to another.
[factorScalingMass] — The multiplicative factor applied to the mass normalization of the underlying kinematic distribution; used to rescale the distribution from one physical mass to another.
[factorScalingLength] — The factor by which to scale lengths.
[factorScalingMass] — The factor by which to scale the mass.
[factorScalingLength] — The factor by which to scale lengths.
[factorScalingMass] — The factor by which to scale the mass.

`massDistributionSphericalShellOverdensities`¶

A mass distribution class which overlays overdense spherical shells on another mass distribution.

The intent is to mimic the effects of a 3-D distribution of spherical clouds, but along a single sight-line from the center of a spherically symmetric mass distribution. This is useful in computing radiative transfer through cloudy media for spherically symmetric systems.

In the 3-D case clouds are defined by a radius, \(r_\mathrm{c}\), a volume filling factor, \(f_\mathrm{v}\), and a density contrast, \(\Delta_\mathrm{c}\). For this case of spherical shells the same quantities are used, except that the radius is referred to as the “half-width” of the shell, but is still labeled \(r_\mathrm{c}\).

In the 3-D case the number density of clouds is

\[n_\mathrm{c} = {f_\mathrm{v} \over (4 \pi / 3 ) r_\mathrm{c}^3}.\]

Along a sightline of length \(l\) (specified by the [radiusBoundary] parameter) the number of clouds intersected is

\[N_\mathrm{c} = n_\mathrm{c} l 4 \pi r_\mathrm{c}^2 = 3 f_\mathrm{v} {l \over r_\mathrm{c}}.\]

This last relation is used to determine the number of spherical shells to generate. These shells are then placed randomly in radius between \(0\) and \(l\). Each shell is also assigned an impact parameter, \(b\), meant to represent the distance of the center of the notional spherical cloud from the line of sight. The effective half-width of the shell is then \(\sqrt{r_\mathrm{c}^2-b^2}\).

Parameters

[halfWidth] — The half-width (in Mpc) of each overdense spherical shell, representing the effective radius of the notional spherical cloud projected along the line of sight after accounting for a random impact parameter.
[densityContrast] — The density contrast of the overdense spherical shells relative to the smooth underlying mass distribution, i.e.\(\Delta_\mathrm{c} = \rho_\mathrm{shell} / \rho_\mathrm{background}\).
[volumeFillingFactor] — The fraction of the total sightline volume occupied by overdense shells; together with halfWidth determines the number of shells \(N_\mathrm{c} = 3 f_\mathrm{v} l / r_\mathrm{c}\) along the line of sight.
[radiusBoundary] — The boundary radius within which to populate shells.
[dimensionless] (default .true.) — If true the shell overdensities 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.

`massDistributionSphericalSIDM`¶

An abstract mass distribution class for spherical SIDM models. Provides a method to compute interaction radii.

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).

`massDistributionSphericalSIDMCoreNFW`¶

A mass distribution class implementing a cored-NFW dark matter halo profile to approximate the effects of SIDM based on the model of Jiang et al. (2023). The profile is defined by the enclosed mass, with (Jiang et al., 2023):

\[M(r) = M_\mathrm{NFW}(r) \mathrm{tanh}\left(\frac{r}{r_\mathrm{c}}\right),\]

where \(r_\mathrm{c} = \alpha r_1\) is a characteristic core size related to the interaction radius \(r_1\) by a constant factor \(\alpha =\)[factorRadiusCore].

Methods

radiusCore — Computes the core radius of halo.

Parameters

[factorRadiusCore] (default 0.45d0) — The factor \(\alpha\) appearing in the definition of the core radius, \(r_\mathrm{c}=\alpha r_1\) where \(r_1\) is the radius at which an SIDM particle has had, on average, 1 interaction.
[timeAge] — The age of the halo (in Gyr) since its formation, used to compute how long SIDM self-interactions have been active in determining the size of the dark matter core.
[velocityRelativeMean] — Mean relative velocity to calculate self interaction cross section.
[factorRadiusCore] (default 0.45d0) — The factor \(\alpha\) appearing in the definition of the core radius, \(r_\mathrm{c}=\alpha r_1\) where \(r_1\) is the radius at which an SIDM particle has had, on average, 1 interaction.
[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.

`massDistributionSphericalSIDMIsothermal`¶

A mass distribution class for self-interacting dark matter following the “isothermal” model of Jiang et al. (2023). This model assumes that the dark matter within the interaction radius, \(r_1\), has thermalized and can therefore be described by a constant velocity dispersion, \(\sigma_0\). Under this assumption the spherical Jeans equation has a solution of the form:

\[\rho(r) = \rho_0 \exp\left[-\frac{\phi(r)}{\sigma_0^2}\right],\]

where \(\rho(r)\) is the density \(\rho_0\) is the density at \(r=0\), and the gravitational potential satisfies (Jiang et al., 2023):

\[\nabla^2 \phi(r) = 4 \pi \mathrm{G} \rho_0 \exp \left( - \frac{\phi(r)}{\sigma_0^2} \right).\]

This second-order differential equation is solved using the boundary conditions \(\phi(r=0)=0\) and \(\mathrm{d}\phi/\mathrm{d}r(r=0)=0\). The values of \(\rho_0\) and \(\sigma_0\) are then found by minimizing a function

\[\delta^2(\rho_0,\sigma_0) = \left[ \frac{\rho(r_1)}{\rho^\prime(r_1)} - 1 \right]^2 + \left[ \frac{M(r_1)}{M^\prime(r_1)} - 1 \right]^2,\]

where \(M(r)\) is the mass contained within radius \(r\), and primes indicate the profile prior to SIDM thermalization.

This can be expressed in a convenient dimensionless form. We define \(x=r/r_1\), \(y=\rho/\rho_1\), \(z=\sigma/\sigma_1\), where

\[\sigma_1^2 = \frac{4 \pi}{3} \mathrm{G} \rho_1 r_1^2 \xi,\]

and we define \(\xi\) through the relation:

\[M_1 = \xi \frac{4 \pi}{3} \rho_1 r_1^3.\]

Using these definitions we can define a dimensionless potential, \(\Phi(r) = \phi(r) / \sigma_1^2\). The above differential equation can then be written as

\[\nabla^{\prime 2} \Phi = \frac{3}{\xi} y_0 \exp\left[ - \frac{\Phi}{z_0^2} \right] ,\]

where \(\nabla^{\prime 2}\) indicates the Laplacian with respect to coordinate \(x\). Written in this form it is straightforward to see that this equation has three parameters, \(\xi\), \(y_0\), and \(z_0\). The value of \(\xi\) is determined from the initial (pre-thermalization) density profile. We then have two constraints at \(x=1\), namely \(y=1\) and \(m=M/M_1=1\). We can solve for the values of \(y_0\) and \(z_0\) which satisfy these constraints for a given \(\xi\). As a result, we can tabulate solutions \(y_0(\xi)\) and \(z_0(\xi)\) which are applicable to any initial density profile and depend only on the effective slope of the density profile inside \(r_1\), since if \(\rho \propto r^\alpha\) then \(\xi = 1/(1+\alpha/3)\), such that \(\alpha=0\) (the largest physically-allowed value of \(\alpha\)) implies \(\xi=1\).

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).

`massDistributionSphericalSIDMIsothermalBaryons`¶

Mass distributions for self-interacting dark matter following the “isothermal” model of Jiang et al. (2023). This model assumes that the dark matter within the interaction radius, \(r_1\), has thermalized and can therefore be described by a constant velocity dispersion, \(\sigma_0\). Under this assumption the spherical Jeans equation has a solution of the form:

\[\rho(r) = \rho_0 \exp\left[-\frac{\phi(r)}{\sigma_0^2}\right],\]

where \(\rho(r)\) is the density \(\rho_0\) is the density at \(r=0\), and the gravitational potential satisfies (Jiang et al., 2023):

\[\nabla^2 \phi(r) = 4 \pi \mathrm{G} \left[ \rho_0 \exp \left( - \frac{\phi(r)}{\sigma_0^2} \right) + \rho_\mathrm{b}(r) \right],\]

where \(\rho_\mathrm{b}(r)\) is the density of the baryonic component. This second-order differential equation is solved using the boundary conditions \(\phi(r=0)=0\) and \(\mathrm{d}\phi/\mathrm{d}r(r=0)=0\). The values of \(\rho_0\) and \(\sigma_0\) are then found by minimizing a function

\[\delta^2(\rho_0,\sigma_0) = \left[ \frac{\rho(r_1)}{\rho^\prime(r_1)} - 1 \right]^2 + \left[ \frac{M(r_1)}{M^\prime(r_1)} - 1 \right]^2,\]

where \(M(r)\) is the mass contained within radius \(r\), and primes indicate the profile prior to SIDM thermalization.

Methods

setBaryonicComponent — Set baryonic components in the mass distribution.
computeSolution — Compute a solution for the isothermal core of a SIDM halo.

Parameters

[timeAge] — The age of the halo (in Gyr) since its formation, setting the time available for SIDM interactions to thermalize the dark matter core while the baryonic potential influences the resulting density profile.
[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.

`massDistributionSphericalTabulated`¶

An abstract mass distribution class for tabulated spherically symmetric distributions.

Methods

parameters — Return parameters of the current mass distribution.
factoryTabulation — Return an instance of the class with the given tabulation parameters.
suffix — Return a suffix to append to table file names.
fileRead — Read tabulation data from file.
fileWrite — Write tabulation data to file.
tabulate — (Re)tabulate the mass distribution.
interpolate — Interpolate in the mass distribution.
isTabulating — Return true if the thread associated with the object is tabulating.
velocityDispersion1D — Compute the 1D velocity dispersion at the given coordinates.
initialize — Initialize the container (specifically the number of parameters).
nameParameter — Return the name of the index parameter for a given tabulation.
countParameters — Return the number of parameters for a given tabulation.

Parameters

[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.

`massDistributionSphericalTruncated`¶

Implements a mass distribution in which the density is given by

\[\begin{split}\rho(r) = \rho^\prime(r) \left\{ \begin{array}{ll} 1 & \hbox{ if } r < r_\mathrm{min}, \\ 0 & \hbox{ if } r > r_\mathrm{max}, \\ 1-3 x^2 + 2x^3 & \hbox{otherwise,} \end{array} \right.\end{split}\]

where

\[x=\frac{r-r_\mathrm{min}}{r_\mathrm{max}-r_\mathrm{min}},\]

\(\rho^\prime(r)\) is some other density profile, \(r_\mathrm{min}=\)[radiusTruncateMinimum], and \(r_\mathrm{max}=\)[radiusTruncateMaximum].

Methods

truncationFunction — Compute the truncation fraction (and related quantities) from the radius.

Parameters

[radiusTruncateMinimum] — The minimum radius to begin truncating the density profile.
[radiusTruncateMaximum] — The maximum radius to finish truncating the density profile.
[nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available.
[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.

`massDistributionSphericalTruncatedExponential`¶

Implements an exponentially truncated mass distribution Kazantzidis et al. (2006) in which the density is given by

\[\begin{split}\rho(r) = \rho^\prime(r_\mathrm{min}) \left\{ \begin{array}{ll} 1 & \hbox{ if } r < r_\mathrm{min}, \\ \rho^\prime(r_\mathrm{min} x^\kappa \exp\left(-\frac{x-1}{x_\mathrm{max}}\right) & \hbox{otherwise,} \end{array} \right.\end{split}\]

where \(x = r/r_\mathrm{min}\), \(x_\mathrm{decay} = r_\mathrm{decay}/r_\mathrm{min}\), \(\rho^\prime(r)\) is some other density profile, \(r_\mathrm{min}=\)[radiusTruncateMinimum], \(r_\mathrm{decay}=\)[radiusTruncateDecay], and

\[\kappa = \frac{r_\mathrm{min}}{r_\mathrm{decay}} + \frac{\mathrm{d}\log \rho^\prime}{\mathrm{d}\log r}(r_\mathrm{min})\]

is chosen to ensure that the logarithmic gradient of the density profile is continuous across \(r=r_\mathrm{min}\).

Parameters

[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.
[radiusFractionalDecay] (default 1.0d0) — The truncation scale radius expressed as a fraction of the virial radius; the exponentially truncated dark matter profile decays as \(\exp(-r/r_\mathrm{trunc})\) for \(r > r_\mathrm{trunc} =\) [radiusFractionalDecay] \(\times r_\mathrm{virial}\), suppressing the profile at large radii.
[variogramFitOption] (default var_str('median')) — Option controlling how the binned semi-variance data are aggregated before fitting the exponential variogram model; allowed values are mean, median (default), or maximum of the residuals within each separation bin.
[assumeZeroVarianceAtZeroLag] (default .false.) — If true, the variogram model is forced to go to zero for states with zero separation (as expected if the likelihood model being emulated is fully deterministic). Otherwise, the variance at zero separation is treated as a free parameter.
[radiusTruncateMinimum] — The minimum radius to begin truncating the density profile.
[radiusTruncateDecay] — The exponential decay scale for truncating the density profile.
[nonAnalyticSolver] (default var_str('fallThrough')) — Selects how solutions are computed when no analytic solution is available.
[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.

`massDistributionZero`¶

A mass distribution class that returns zero density, zero enclosed mass, and zero potential everywhere; useful as a null placeholder when no mass component is present in a given region.

Parameters

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

`massDistributionZhao1996`¶

A mass distribution class which implements the (Zhao, 1996) density profile:

\[\rho_\mathrm{dark matter}(r) = \rho_0 \left({r\over r_\mathrm{s}}\right)^{-\gamma} \left(1+[{r\over r_\mathrm{s}}]^\alpha\right)^{-(\beta-\gamma)/\alpha}.\]

The mass enclosed within radius \(r\) is given by

\[M(<r) = \frac{4 \pi}{3-\gamma} \rho_0 r_\mathrm{s}^{3-\gamma} {}_2F_1\left[\left(\frac{3-\gamma}{\alpha}\right),\left(\frac{-\beta+\gamma}{\alpha},1+\frac{3-\gamma}{\alpha}\right),-r^\alpha\right]\]

where \(R=r/r_\mathrm{s}\). The associated gravitational potential is

\[\Phi(r) = - \frac{4 \pi \mathrm{G}}{-3+\gamma} \rho_0 r^{2-\gamma} \frac{\Gamma[(3+\alpha-\gamma)/\alpha]}{\Gamma[(3-\gamma)/\alpha]} \left( \Gamma\left[\frac{2-\gamma}{\alpha}\right] {}_p\tilde{F}F_q\left[\left\{\frac{2-\gamma}{\alpha},\frac{\beta-\gamma}{\alpha}\right\},\left\{\frac{2+\alpha-\gamma}{\alpha}\right\},-r\alpha\right] - \Gamma\left[\frac{3-\gamma}{\alpha}\right] {}_p\tilde{F}F_q\left[\left\{\frac{3-\gamma}{\alpha},\frac{\beta-\gamma}{\alpha}\right\},\left\{\frac{3+\alpha-\gamma}{\alpha}\right\},-r\alpha\right] \right).\]

Methods

timeFreefallTabulate — Tabulate the freefall time as a function of radius in a scale-free Zhao1996 mass distribution.

Parameters

[alpha] — The parameter \(\alpha\) of the Zhao (1996) dark matter density profile.
[beta] — The parameter \(\beta\) of the Zhao (1996) dark matter density profile.
[gamma] — The parameter \(\gamma\) of the Zhao (1996) dark matter density profile.
[alpha] — The parameter \(\alpha\) of the Zhao1996 profile.
[beta] — The parameter \(\beta\) of the Zhao1996 profile.
[gamma] — The parameter \(\gamma\) of the Zhao1996 profile.
[densityNormalization] (default (3.0d0-gamma)/4.0d0/Pi/Hypergeometric_2F1([(3.0d0-gamma)/alpha,(beta-gamma)/alpha],[1.0d0+(3.0d0-gamma)/alpha],-1.0d0)) — The density normalization of the Zhao1996 profile.
[scaleLength] (default 1.0d0) — The scale radius of the Zhao1996 profile.
[mass] (default 1.0d0) — The total mass (in \(\mathrm{M}_\odot\)) of the Zhao (1996) profile, used to set the density normalization \(\rho_0\) when densityNormalization is not supplied directly.
[radiusOuter] — The outer radius of the Zhao1996 profile.
[dimensionless] (default .true.) — If true the Zhao1996 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.

Mass Distributions¶

Methods¶

massDistributionBetaProfile¶

massDistributionBlackHole¶

massDistributionBurkert¶

massDistributionCloudOverdensities¶

massDistributionComposite¶

massDistributionConstantDensityCloud¶

massDistributionCoredNFW¶

massDistributionCorrelationFunction¶

massDistributionCuspNFW¶

massDistributionCylindrical¶

massDistributionCylindricalScaler¶

massDistributionDiemerKravtsov2014¶

massDistributionEinasto¶

massDistributionEnzoHydrostatic¶

massDistributionExponentialDisk¶

massDistributionGaussianEllipsoid¶

massDistributionGaussianSlab¶

massDistributionHernquist¶

massDistributionIsothermal¶

massDistributionMiyamotoNagai¶

massDistributionNFW¶

massDistributionPatejLoeb2015¶

massDistributionSersic¶

massDistributionShi2016¶

massDistributionSIDMParametricProfile¶

massDistributionSoliton¶

massDistributionSolitonNFW¶

massDistributionSolitonNFWHeated¶

massDistributionSpherical¶

massDistributionSphericalAccelerator¶

massDistributionSphericalAccretionFlow¶

massDistributionSphericalAdiabaticGnedin2004¶

massDistributionSphericalDecaying¶

massDistributionSphericalDecorator¶

massDistributionSphericalFiniteResolution¶

massDistributionSphericalFiniteResolutionNFW¶

massDistributionSphericalHeated¶

massDistributionSphericalHeatedMonotonic¶

massDistributionSphericalScaler¶

massDistributionSphericalShellOverdensities¶

massDistributionSphericalSIDM¶

massDistributionSphericalSIDMCoreNFW¶

massDistributionSphericalSIDMIsothermal¶

massDistributionSphericalSIDMIsothermalBaryons¶

massDistributionSphericalTabulated¶

massDistributionSphericalTruncated¶

massDistributionSphericalTruncatedExponential¶

massDistributionZero¶

massDistributionZhao1996¶

`massDistributionBetaProfile`¶

`massDistributionBlackHole`¶

`massDistributionBurkert`¶

`massDistributionCloudOverdensities`¶

`massDistributionComposite`¶

`massDistributionConstantDensityCloud`¶

`massDistributionCoredNFW`¶

`massDistributionCorrelationFunction`¶

`massDistributionCuspNFW`¶

`massDistributionCylindrical`¶

`massDistributionCylindricalScaler`¶

`massDistributionDiemerKravtsov2014`¶

`massDistributionEinasto`¶

`massDistributionEnzoHydrostatic`¶

`massDistributionExponentialDisk`¶

`massDistributionGaussianEllipsoid`¶

`massDistributionGaussianSlab`¶

`massDistributionHernquist`¶

`massDistributionIsothermal`¶

`massDistributionMiyamotoNagai`¶

`massDistributionNFW`¶

`massDistributionPatejLoeb2015`¶

`massDistributionSersic`¶

`massDistributionShi2016`¶

`massDistributionSIDMParametricProfile`¶

`massDistributionSoliton`¶

`massDistributionSolitonNFW`¶

`massDistributionSolitonNFWHeated`¶

`massDistributionSpherical`¶

`massDistributionSphericalAccelerator`¶

`massDistributionSphericalAccretionFlow`¶

`massDistributionSphericalAdiabaticGnedin2004`¶

`massDistributionSphericalDecaying`¶

`massDistributionSphericalDecorator`¶

`massDistributionSphericalFiniteResolution`¶

`massDistributionSphericalFiniteResolutionNFW`¶

`massDistributionSphericalHeated`¶

`massDistributionSphericalHeatedMonotonic`¶

`massDistributionSphericalScaler`¶

`massDistributionSphericalShellOverdensities`¶

`massDistributionSphericalSIDM`¶

`massDistributionSphericalSIDMCoreNFW`¶

`massDistributionSphericalSIDMIsothermal`¶

`massDistributionSphericalSIDMIsothermalBaryons`¶

`massDistributionSphericalTabulated`¶

`massDistributionSphericalTruncated`¶

`massDistributionSphericalTruncatedExponential`¶

`massDistributionZero`¶

`massDistributionZhao1996`¶