Modules¶

Every documented Fortran module in the Galacticus source, with the summary from its embedded documentation. Modules implementing a pluggable physics class link to that class.

Abundances_Structure: Defines the abundances structure used for describing elemental abundances in Galacticus.

Accretion_Disk_Spectra

Implements calculations of accretion disk spectra.

See Cosmology Functions.

Accretion_Disk_Spectra_Utilities: Provides globally-accessible functions supporting the accretionDiskSpectraClass class.

Accretion_Disks

Provides a class that implements accretion disks.

See Cosmology Functions.

Accretion_Halo_Totals

Provides a class for calculations of the total accretion rate onto halos for use by the halo accretion classes which compute the accretion rates of baryonic material.

See Cosmology Functions.

Accretion_Halos

Implements a class implementing accretion of gas from the IGM onto halos.

See Cosmology Functions.

Array_Utilities: Contains routines which implement useful operations on arrays.

Arrays_Search: Implements searching of ordered arrays.

Atomic_Cross_Sections_Compton: Implements calculation of the Compton cross-section.

Atomic_Cross_Sections_Ionization_Photo

Implements the atomic photo-ionization cross-section class.

See Cosmology Functions.

Atomic_Data: Provides various atomic data.

Atomic_Ionization_Potentials

Implements an atomic ionization potential class.

See Cosmology Functions.

Atomic_Radiation_Gaunt_Factors

Provides a class implementing Gaunt factors.

See Cosmology Functions.

Atomic_Rates_Excitation_Collisional

Provides a class implementing atomic collisional excitation rates.

See Cosmology Functions.

Atomic_Rates_Ionization_Collisional

Provides a class implementing radiative recombination rates.

See Cosmology Functions.

Atomic_Rates_Recombination_Dielectronic

Implements a dielectronic recombination rates class.

See Cosmology Functions.

Atomic_Rates_Recombination_Radiative

Provides a class implementing radiative recombination rates.

See Cosmology Functions.

Atomic_Rates_Recombination_Radiative_Cooling

Provides a class implementing recombination cooling rates.

See Cosmology Functions.

Benchmark_Root_Finder_Functions: Callbacks and shared state for the rootFinder benchmark. The functions read a single module-level shift, bmShift, which is rewritten by the benchmark driver before every call. This perturbs the problem (so the optimizer cannot constant-fold the solver chain) and keeps the cache state of rootFinder’s wrapper realistic from one call to the next.

Benchmark_Utilities: Shared utilities for benchmark programs. All output lines have the form .. code-block:: none BENCHMARK <suite> <id> “<description>” <mean> <stderr> “<units>” where <mean> and <stderr> are floating-point and the trailing <units> is the display unit. The format is whitespace-tokenized, grep/awk-friendly, and consistent across all benchmark programs.

Bessel_Functions: Implements calculations of Bessel functions.

Beta_Functions: Implements beta functions.

Binary_Search_Trees: Implements binary search tree data structures.

Binomial_Coefficients: Implements binomial coefficients.

Black_Hole_Accretion_Rates

Implements a class for black hole accretion rates.

See Cosmology Functions.

Black_Hole_Binary_Initial_Separation

Implements a class for black hole binary initial separations.

See Cosmology Functions.

Black_Hole_Binary_Mergers

Implements a class for calculations of black hole binary mergers.

See Cosmology Functions.

Black_Hole_Binary_Recoil_Velocities

Implements a class for black hole binary recoil velocities.

See Cosmology Functions.

Black_Hole_Binary_Separations

Implements a class for calculations of black hole binary separation growth rate.

See Cosmology Functions.

Black_Hole_CGM_Heating

Implements a class for black hole heating of the CGM.

See Cosmology Functions.

Black_Hole_Fundamentals: Implements fundamental properties of black holes.

Black_Hole_Seeds

Implements a class for black hole seeds.

See Cosmology Functions.

Black_Hole_Winds

Implements a class for black hole winds.

See Cosmology Functions.

Bondi_Hoyle_Lyttleton_Accretion: Implements calculations of Bondi-Hoyle-Lyttleton accretion (see Edgar 2004).

Calculations_Resets: Handles resetting of calculations before a new or updated node is processed.

Chemical_Abundances_Structure: Defines the structure used for describing chemical abundances in Galacticus.

Chemical_Reaction_Rates

Provides a class implementing chemical reaction rates.

See Cosmology Functions.

Chemical_Reaction_Rates_Utilities: Implements various useful utility functions for calculations of chemical abundances and rates.

Chemical_States

Provides a class implementing the chemical state.

See Cosmology Functions.

Chemical_Structures: Implements structures that describe chemicals.

Circumgalactic_Medium_Heating

Implements a class for CGM heating.

See Cosmology Functions.

Command_Arguments: Provides an interface to read command line arguments of arbitrary type.

Computational_Domain_Volume_Integrators

Provides a class that implements computational domains.

See Cosmology Functions.

Computational_Domains

Provides a class that implements computational domains.

See Cosmology Functions.

Conditional_Mass_Functions

Implements empirical models of conditional mass functions.

See Cosmology Functions.

Cooling_Cold_Mode_Infall_Rates

Implements calculations of the infall rate from the cold mode.

See Cosmology Functions.

Cooling_Freefall_Times_Available

Provides a class that implements calculations of the freefall radius.

See Cosmology Functions.

Cooling_Functions

Provides a class implementing cooling functions.

See Cosmology Functions.

Cooling_Infall_Radii

Provides a class that implements calculations of the infall radius for cooling calculations.

See Cosmology Functions.

Cooling_Infall_Torques

Provides a class that implements calculations of the infall torques for cooling calculations.

See Cosmology Functions.

Cooling_Options: Provides options controlling cooling.

Cooling_Radii

Provides a class that implements calculations of the cooling radius.

See Cosmology Functions.

Cooling_Rates

Provides a class that implements calculations of the cooling rate.

See Cosmology Functions.

Cooling_Specific_Angular_Momenta

Provides a class that implements calculations of the specific angular momentum of cooling gas.

See Cosmology Functions.

Cooling_Times

Implements calculations of the cooling time.

See Cosmology Functions.

Cooling_Times_Available

Provides a class that implements calculations of the time available for cooling.

See Cosmology Functions.

Coordinate_Systems: Implements calculations related to coordinate systems and transformations.

Coordinates: Implements the coordinates class.

Correlation_Functions_Two_Point

Implements two-point correlation functions.

See Cosmology Functions.

Cosmological_Density_Field

Provides an object that implements critical overdensities and halo environments.

See Mass Variance of Cosmological Density Field.

Cosmological_Velocity_Field

Provides a class that implements models of the cosmological velocity field.

See Cosmology Functions.

Cosmology_Functions

Provides an object that implements cosmological functions.

See Cosmology Functions.

Cosmology_Functions_Options: Provides options for cosmological functions.

Cosmology_Functions_Parameters: Defines option parameters for cosmology functions.

Cosmology_Parameters

Provides an object that implements cosmological parameters.

See Cosmology Functions.

Dark_Matter_Halo_Biases

Implements a dark matter halo bias class.

See Cosmology Functions.

Dark_Matter_Halo_Formation_Times: Implements calculations of dark matter halo formation times.

Dark_Matter_Halo_Mass_Accretion_Histories

Provides a class for calculations of dark matter halo mass accretion histories.

See Cosmology Functions.

Dark_Matter_Halo_Scales

Provides a class implementing scales of dark matter halo scales.

See Cosmology Functions.

Dark_Matter_Halo_Spins: Implements calculations of dark matter halo angular momentum.

Dark_Matter_Halos_Correa2015: Implements utility functions for the Correa et al. (2015) dark matter halo models.

Dark_Matter_Halos_Mass_Loss_Rates

Implements calculations of mass loss rates from dark matter halos.

See Cosmology Functions.

Dark_Matter_Particles

Provides a class that implements dark matter particle physics.

See Cosmology Functions.

Dark_Matter_Profile_Mass_Definitions: Implements calculations of dark matter profile scale radii from concentrations.

Dark_Matter_Profile_Scales

Provides a class that implements scale radii dark matter halo profiles.

See Cosmology Functions.

Dark_Matter_Profiles

Provides an object that implements non-dark-matter-only dark matter halo profiles.

See Cosmology Functions.

Dark_Matter_Profiles_Concentration

Provides a class that implements concentrations of dark matter halo profiles.

See Cosmology Functions.

Dark_Matter_Profiles_DMO

Provides an object that implements dark matter halo profiles.

See Cosmology Functions.

Dark_Matter_Profiles_Shape

Provides a class that implements shape parameters of dark matter halo profiles.

See Cosmology Functions.

Dates_and_Times: Implements computation of formatted dates and times.

Debugging: Implements useful debugging utilities.

Decaying_Dark_Matter: Implements useful shared utilities for calculations of decaying dark matter.

Dependencies: Implements dependency versioning.

Dictionaries: Implements “dictionaries” (i.e. associative arrays).

Dilogarithms: Implements dilogarithms.

Disparity_Ratios: Implements calculations of disparity ratios, i.e. \(r(a,b)=\hbox{max}(|a|/|b|,|b|/|a|)\).

Display: Implements outputting of formatted, indented messages at various verbosity levels from Galacticus.

Display_Verbosity: Handle setting of verbosity.

Elliptic_Integrals: Implements exponential integrals.

Enumerations: Defines the base class for all enumeration classes.

Error: Implements error reporting for the Galacticus package.

Error_Functions: Implements calculations of error functions.

Error_Utilities: Provides error handling utilities.

Events_Black_Hole_Merger: Performs tasks associated with black hole merger events.

Events_Filters: Provides a globally-callable event filtering function.

Events_Halo_Formation: Performs tasks associated with “halo formation” events.

Events_Hooks: Handles hooking of object function class into events.

Evolve_To_Time_Reports: Contains functions which report on timestepping criteria.

Excursion_Sets_Barriers

Provides a class that implements barriers for the excursion set problem.

See Cosmology Functions.

Excursion_Sets_First_Crossings

Provides a class for first crossing distributions for excursion set calculations.

See Cosmology Functions.

Exponential_Integrals: Implements exponential integrals.

Factorials: Implements calculations of factorials

FFTLogs: Wraps the FFTLog functions.

FFTW3: Imports the FFTW3 library Fortran interface.

File_Utilities: Implements various file-related utilities.

Freefall_Radii

Provides a class that implements calculations of the freefall radius.

See Cosmology Functions.

Function_Classes: Defines the base class for all functionClass classes.

Functions_Global: Provides pointers to global functions.

Functions_Global_Utilities: Provides utilities needed by global functions.

Galactic_Dynamics_Bar_Instabilities

Provides a class that implements calculations of bar instability in galactic disks.

See Cosmology Functions.

Galactic_Filters

Provides an object that implements galactic filters.

See Cosmology Functions.

Galactic_Structure_Options: Provides various internal option codes for the galactic structure functions.

Galactic_Structure_Radii_Definitions: Provides parsing of radii definitions used in output specifiers.

Galactic_Structure_Radius_Solver_Utilities: Provides utility functions for galactic structure solver.

Galactic_Structure_Solvers

Implements a class for calculations of sizes of galactic components (or more general components).

See Cosmology Functions.

Galacticus_Nodes

Implements an object hierarchy for nodes in merger trees and all of their constituent physical components.

See Cosmology Functions.

Gamma_Functions: Implements calculations of Gamma functions.

Geometry_Lightcones

Implements geometries of lightcones.

See Cosmology Functions.

Geometry_Mangle: Implements functions utilizing mangle survey geometry definitions.

Geometry_Surveys

Implements geometries of galaxy surveys.

See Cosmology Functions.

Gravitational_Lensing

Implements gravitational lensing from large scale structure.

See Cosmology Functions.

Halo_Model_Power_Spectrum_Modifiers

Implements a class of modifiers of the power spectrum for the halo model.

See Cosmology Functions.

Halo_Model_Projected_Correlations: Implements calculations of projected correlation functions using the halo model.

Halo_Spin_Distributions

Provides a class for dark matter halo spin distributions.

See Cosmology Functions.

Hashes_Perfect: Implements a perfect hash algorithm for long integer keys based on methods described by Czech et al. (1997). The specific implementation follows the general structure of that given in a Dr. Dobbs article.

HDF5_Access: Provides an OpenMP lock to serialize access to the HDF5 library, preventing race conditions when multiple threads attempt concurrent HDF5 operations.

HII_Region_Density_Distributions

Provides a class that implements calculations for hydrogen density distribution in a HII region.

See Cosmology Functions.

HII_Region_Escape_Fraction

Provides a class that implements calculations of escape fractions from HII regions.

See Cosmology Functions.

HII_Region_Luminosity_Functions

Provides a class that implements HII region luminosity functions.

See Cosmology Functions.

HII_Region_Mass_Functions

Provides a class that implements HII region mass functions.

See Cosmology Functions.

Histories: Defines the history object type.

Hot_Halo_Cold_Mode_Density_Core_Radii

Provides a module which provides a class that implements core radii for cored cold mode hot halo mass distributions.

See Cosmology Functions.

Hot_Halo_Cold_Mode_Mass_Distributions

Provides an object which provides a hot halo cold mode mass distribution class.

See Cosmology Functions.

Hot_Halo_Mass_Distributions

Provides an object which provides a hot halo mass distribution class.

See Cosmology Functions.

Hot_Halo_Mass_Distributions_Core_Radii

Provides an object that implements core radii for hot halo mass distributions.

See Cosmology Functions.

Hot_Halo_Outflows_Reincorporations

Provides a class that implements reincorporation of outflowed mass into the hot halo.

See Cosmology Functions.

Hot_Halo_Outflows_Stripping

Provides a class that implements stripping of outflowed mass in the hot halo.

See Cosmology Functions.

Hot_Halo_Ram_Pressure_Forces

Implements a class which provides calculations of ram pressure force.

See Cosmology Functions.

Hot_Halo_Ram_Pressure_Stripping

Implements a class for calculations of ram pressure stripping of hot halos.

See Cosmology Functions.

Hot_Halo_Ram_Pressure_Stripping_Timescales

Implements a class for calculations of ram pressure stripping timescales for hot halos.

See Cosmology Functions.

Hot_Halo_Temperature_Profiles

Provides a hot halo temperature profile class.

See Cosmology Functions.

Hypergeometric_Functions: Implements hypergeometric functions.

Ideal_Gases_Thermodynamics: Implements thermodynamic properties of ideal gases. Provides the adiabatic sound speed (assuming \(\gamma = 5/3\)) and the Jeans length, defined as the sound crossing time times the free-fall time, for gas of a given temperature, density, and mean atomic mass.

Input_Parameters: Implements reading of parameters from an XML file.

Input_Paths: Provides the path for Galacticus inputs and scripts.

Instruments_Filters: Implements calculations of filter response curves.

Interface_GSL: Interfaces with low-level aspects of the GSL library.

Interface_Local_Group_DB: Interfaces with the Local Group database.

Interfaces_AxionCAMB: Provides various interfaces to the AxionCAMB code.

Interfaces_CAMB: Provides various interfaces to the CAMB code.

Interfaces_CLASS: Provides various interfaces to the CLASS code.

Interfaces_Cloudy: Provides various interfaces to the Cloudy code.

Interfaces_Cloudy_CIE: Provides an interface to the Cloudy code for computing tables of cooling functions and chemical state in collisional ionization equilibrium.

Interfaces_FSPS: Provides various interfaces to the FSPS code (Conroy et al., 2009).

Interfaces_RecFast: Provides various interfaces to the RecFast code.

Intergalactic_Medium_Filtering_Masses

Provides a class for filtering masses.

See Cosmology Functions.

Intergalactic_Medium_State

Provides a class for calculations of the intergalactic medium thermal and ionization state.

See Cosmology Functions.

IO_HDF5: Implements simple and convenient interfaces to a variety of HDF5 functionality.

IO_IRATE: Provides IO in IRATE format, an HDF5-based standard for halo catalogs that stores per-snapshot halo properties (positions, velocities, masses, IDs) alongside cosmological and simulation metadata.

IO_XML: Implements various utility functions for extracting data from XML files using the FoX DOM library, including element search by tag name, array data reading, XPath-style path traversal, and recursive resolution of xi:include directives.

Kepler_Orbits: Defines an orbit structure for use in Galacticus.

Kind_Numbers: Defines various kind types.

Lambert_Ws: Implements Lambert W functions.

Linear_Algebra: Implements linear algebra calculations.

Linear_Growth

Provides a class that implements linear growth of cosmological structure.

See Cosmology Functions.

Locks: Provides advanced locks.

Mass_Distribution_Soliton_Schive2014: Provides utility variables for the Schive et al. (2014) soliton density profile.

Mass_Distributions

Implements a class that provides mass distributions.

See Cosmology Functions.

Mass_Function_Incompletenesses

Provides a class that implements incompleteness calculations for observed mass functions.

See Cosmology Functions.

Math_Arithmetic: Provides basic arithmetic functions, often handling floating point issues.

Math_Distributions_Gaussian: Implements Gaussian distributions.

Math_Distributions_Poisson_Binomial: Implements Poisson binomial distributions.

Math_Exponentiation: Provides a fast exponentiation class which utilizes tables to do rapid exponentiation in a limited range of argument for fixed exponent, along with other exponentiation functions.

Math_Operators_Unary

Implements a class of unary operators.

See Cosmology Functions.

Memory_Reporting: Provide reporting functions for memory usage.

Merger_Tree_Branching

Implements a merger tree branching probability class.

See Cosmology Functions.

Merger_Tree_Branching_Modifiers

Provides a module which provides a class that implements core radii for cored cold mode hot halo mass distributions.

See Cosmology Functions.

Merger_Tree_Build_Controllers

Provides controller objects for building merger trees.

See Cosmology Functions.

Merger_Tree_Construction

Constructs/destructs merger trees.

See Cosmology Functions.

Merger_Tree_Data_Structure: Implements an object to store merger tree data for processing into Galacticus’s preferred file format.

Merger_Tree_Evolve_Profilers

Provides a class that implements profiling of merger tree evolution.

See Cosmology Functions.

Merger_Tree_Filters

Constructs/destructs merger trees.

See Cosmology Functions.

Merger_Tree_Initialization

Provides a class that implements initialization of merger trees.

See Cosmology Functions.

Merger_Tree_Operators

Provides an object that implements operators acting on merger trees.

See Cosmology Functions.

Merger_Tree_Outputter_Buffer_Types: Provides buffer types for merger tree outputters.

Merger_Tree_Outputters

Provides a class that implements evolution of merger trees.

See Cosmology Functions.

Merger_Tree_Read_Importers

Provides an object that implements importing of merger trees from file.

See Cosmology Functions.

Merger_Tree_Seeds

Implements a class for setting random number seeds in merger trees.

See Cosmology Functions.

Merger_Tree_State_Store: Provides state store/restore functionality for merger trees.

Merger_Tree_Timesteps

Implements a class for merger tree evolution timestepping.

See Cosmology Functions.

Merger_Tree_Walkers

Provides a class of walker objects for merger trees.

See Cosmology Functions.

Merger_Trees_Build_Mass_Resolution

Provides a class of merger tree mass resolutions.

See Cosmology Functions.

Merger_Trees_Build_Masses

Implements a class for creating sets of tree masses to use when building merger trees.

See Cosmology Functions.

Merger_Trees_Build_Masses_Distributions

Implements a class providing mass distributions for merger trees to be built.

See Cosmology Functions.

Merger_Trees_Builders

Provides a class of merger tree builders.

See Cosmology Functions.

Merger_Trees_Dump: Implements dumping of the structure of a merger tree to a file for plotting with dot.

Merger_Trees_Evolve

Provides a class that implements evolution of merger trees.

See Cosmology Functions.

Merger_Trees_Evolve_Concurrency

Provides a class that implements merger tree evolution concurrency.

See Cosmology Functions.

Merger_Trees_Evolve_Deadlock_Status: Provides an enumeration for tree deadlock statuses.

Merger_Trees_Evolve_Node

Provides a class that implements evolution of nodes.

See Cosmology Functions.

Merger_Trees_Merge_Node

Provides a class that implements processing of mergers between nodes.

See Cosmology Functions.

Meshes: Provide tools for working with grids.

Meta_Tree_Compute_Times

Provides a class for calculations of the time taken to process merger trees.

See Cosmology Functions.

Model_Parameters

Implements a class of unary operators.

See Cosmology Functions.

Models_Likelihoods

Implements a likelihood class for posterior sampling simulations.

See Cosmology Functions.

Models_Likelihoods_Constants: Provides constants for use when constraining Galacticus.

MPI_Utilities: Implements useful MPI utilities.

Multi_Counters: Implements multi-counters - objects which iterate over all combinations of an arbitrary number of counters, each with an arbitrary range.

Multidimensional_Minimizer: Implements multidimensional minimizers.

NBody_Importers

Provides a class that implements importing of data from N-body simulations.

See Cosmology Functions.

NBody_Operators

Provides a class that implements operators on data from N-body simulations.

See Cosmology Functions.

NBody_Simulation_Data: Provides a class to store N-body simulation data.

Nearest_Neighbors: Wraps the ANN (Approximate Nearest Neighbor) library.

Node_Branch_Jumps: Handles satellite node branch jump events.

Node_Component_Basic_Standard

The standard implementation of basic tree node methods.

See Cosmology Functions.

Node_Component_Black_Hole_Noncentral: Implement non-central black hole tree node methods.

Node_Component_Black_Hole_Simple

Implements the simple black hole node component.

See Cosmology Functions.

Node_Component_Black_Hole_Standard

Implement black hole tree node methods.

See Cosmology Functions.

Node_Component_Black_Hole_Standard_Data: Stores data for the standard black hole node component.

Node_Component_Dark_Matter_Profile_Scale: Implements a dark matter profile method that provides a scale radius.

Node_Component_Dark_Matter_Profile_Scale_Free: Implements a dark matter profile method that provides no properties (but does provide a mass distribution factory).

Node_Component_Dark_Matter_Profile_Scale_Shape: Implements a dark matter profile method that provides a scale radius and a shape parameter.

Node_Component_Dark_Matter_Profile_Scale_Triaxial: Implements a dark matter profile method that provides a scale radius and a shape parameter.

Node_Component_Disk_Standard

Implements the standard disk node component.

See Cosmology Functions.

Node_Component_Disk_Standard_Data: Stores data for the standard disk node component.

Node_Component_Disk_Very_Simple

Implements a very simple disk component.

See Cosmology Functions.

Node_Component_Disk_Very_Simple_Size

Implements a very simple disk component.

See Cosmology Functions.

Node_Component_Disk_Very_Simple_Size_Data: Stores data for the very simple size disk node component.

Node_Component_Halo_Angular_Momentum_Scalar: Implement a scalar spin component for tree nodes.

Node_Component_Halo_Angular_Momentum_Vector: Implements the vector spin component.

Node_Component_Hot_Halo_Cold_Mode

Implements an extension to the standard hot halo node component which supports a cold mode reservoir.

See Cosmology Functions.

Node_Component_Hot_Halo_Standard

Implements the standard hot halo node component.

See Cosmology Functions.

Node_Component_Hot_Halo_Standard_Data: Provides data for the standard hot halo node component.

Node_Component_Hot_Halo_Very_Simple

Implements a very simple hot halo node component.

See Cosmology Functions.

Node_Component_Hot_Halo_VS_Delayed

Implements an extension to the very simple hot halo node component by including an outflowed reservoir with delayed reincorporation.

See Cosmology Functions.

Node_Component_NSC_Standard

Implements the standard Galacticusnsc node component.

See Cosmology Functions.

Node_Component_NSC_Standard_Data: Stores data for the standard nuclear star cluster node component.

Node_Component_Position_Cartesian: Implements a position component in Cartesian coordinates.

Node_Component_Satellite_Merge_Time: Implements a satellite orbit component that simply tracks the time of merging.

Node_Component_Satellite_Orbiting: Implements the orbiting satellite component.

Node_Component_Satellite_Preset

Implements a preset satellite orbit component.

See Cosmology Functions.

Node_Component_Satellite_Standard: Implements the standard satellite component.

Node_Component_Spheroid_Standard

Implements the standard spheroid component.

See Cosmology Functions.

Node_Component_Spheroid_Standard_Data: Contains data for standard spheroid components.

Node_Component_Spheroid_Very_Simple

Implements a very simple spheroid component.

See Cosmology Functions.

Node_Components

Implements top-level functions for node components.

See Cosmology Functions.

Node_Events_Inter_Tree: Handles inter-tree node events.

Node_Property_Extractor_Galaxy_Merger_Trees: A module storing object references needed for galaxy merger trees.

Node_Property_Extractors

Provides a class that implements extraction of properties from nodes.

See Cosmology Functions.

Node_Subhalo_Promotions: Handles subhalo promotion events.

Nodes_Labels: Provides functionality for labeling nodes.

Nodes_Operators

Provides a class that implements physical processes.

See Cosmology Functions.

Nodes_Operators_Black_Holes_Utilities: Provides functions supporting the black hole physics in the nodeOperatorClass class.

Nodes_Operators_Utilities: Provides globally-accessible functions supporting the nodeOperatorClass class.

Nuclear_Star_Cluster_Growth_Rates

Provides a class that implements calculations of rates of gas inflows onto nuclear star clusters.

See Cosmology Functions.

Numerical_Comparison: Implements comparisons of values.

Numerical_Constants_Astronomical: Contains various useful astronomical constants.

Numerical_Constants_Atomic: Contains various useful atomic constants.

Numerical_Constants_Boolean: Contains various useful Boolean constants.

Numerical_Constants_Math: Contains various useful mathematical constants.

Numerical_Constants_Physical: Contains various useful physical constants.

Numerical_Constants_Prefixes: Contains useful numerical prefixes.

Numerical_Constants_Units: Contains various useful unit conversions.

Numerical_Differentiation: Implements numerical differentiation.

Numerical_Integration: Implements numerical integration.

Numerical_Integration2: Implements a variety of numerical integrators.

Numerical_Integration_2D: Implements a simple two-dimensional integrator.

Numerical_Interpolation: A simple interface to the GNU Scientific Library interpolation routines.

Numerical_Interpolation_2D_Irregular: Implements bivariate interpolation on irregularly distributed points (Akima, 1978). All state is encapsulated in interpolator2DIrregular so that separate instances are fully independent and thread-safe without any critical sections.

Numerical_ODE_Solvers: Implements an ODE solver class.

Numerical_Quasi_Random_Sequences: Implements quasi-random sequences.

Numerical_Random_Numbers

Provides a class that implements random number generators.

See Cosmology Functions.

Numerical_Ranges: Implements construction of numerical ranges.

Numerical_Roman_Numerals: Implements conversion of integers to Roman numerals.

Object_Pools: Implements a reusable pool of reference-counted functionClass objects, so that objects which would otherwise be created and destroyed on every call (e.g. per-node mass distributions) can instead be re-used. An object held in a pool is considered available for re-use when its reference count has fallen to \(1\), i.e. the only remaining reference to it is that held by the pool itself.

Octree_Data_Structure: Implements an object to store octree data structure.

ODE_Solver_Error_Codes: Defines internal error codes for the Galacticus ODE solver.

OpenMP_Utilities: Implements useful OpenMP utilities.

OpenMP_Utilities_Data: Implements data for useful OpenMP utilities.

Output_Analyses

Provides a class that implements on-the-fly analyses.

See Cosmology Functions.

Output_Analyses_Options: Provides options and enumerations for on-the-fly analyses.

Output_Analysis_Distribution_Normalizers

Provides a class that normalizers on distributions used in on-the-fly output analyses.

See Cosmology Functions.

Output_Analysis_Distribution_Operators

Provides a class that operators on distributions used in on-the-fly output analyses.

See Cosmology Functions.

Output_Analysis_Molecular_Ratios

Provides a class that implements operators on properties for on-the-fly analyses.

See Cosmology Functions.

Output_Analysis_Property_Operators

Provides a class that implements operators on properties for on-the-fly analyses.

See Cosmology Functions.

Output_Analysis_Target_Data

Provides a class that packages the shared “target data” arguments used by the various 1D function output analyses (outputAnalysisMeanFunction1D, outputAnalysisScatterFunction1D, outputAnalysisVolumeFunction1D). These fields are conceptually coupled — a comparison dataset for a 1D function output — so wrapping them into a single object both clarifies intent at call sites and collapses what would otherwise be a \(2^N\) presence-combination explosion in the Python wrapper’s optional-argument branching down to a single optional object argument on each outer constructor.

See Cosmology Functions.

Output_Analysis_Utilities: Provides a collection of utilities useful for on-the-fly analyses.

Output_Analysis_Weight_Operators

Provides a class that implements operators on weights for on-the-fly analyses.

See Cosmology Functions.

Output_Build: Implements writing of Galacticus build information to the Galacticus output file.

Output_HDF5: Manages HDF5 output from Galacticus.

Output_HDF5_Open: Handles opening of the Galacticus output file.

Output_Times

Provides a class that implements output times for Galacticus.

See Cosmology Functions.

Output_Versioning: Implements writing of the version number and run time to the Galacticus output file.

Points: Provide tools for working with sets of points.

Points_Convex_Hull: Provide tools for working with convex hulls of sets of points.

Poly_Ranks: Provides poly-ranked types (i.e. types which can store data in arrays of different ranks).

Polylogarithms: Implements polylogarithm functions.

Posterior_Sample_Differential_Proposal_Size

Implements algorithms for the proposal size in differential evolution algorithms.

See Cosmology Functions.

Posterior_Sample_Differential_Random_Jump

Implements a class for the random jump component in differential evolution algorithms.

See Cosmology Functions.

Posterior_Sampling_Convergence

Implements a class that provides convergence criteria for posterior sampling simulations.

See Cosmology Functions.

Posterior_Sampling_Prop_Size_Temp_Exp

Implements algorithms for the temperature exponent of proposal size in tempered differential evolution algorithms.

See Cosmology Functions.

Posterior_Sampling_Simulation

Implements a class of posterior sampling simulators.

See Cosmology Functions.

Posterior_Sampling_State

Implements a class that maintains during posterior sampling.

See Cosmology Functions.

Posterior_Sampling_State_Initialize

Implements a class for posterior sampling state initialization.

See Cosmology Functions.

Posterior_Sampling_State_Samples

Implements a class that returns lists of states at which to sample the posterior.

See Cosmology Functions.

Posterior_Sampling_Stopping_Criteria

Implements a stopping criteria class for constraint simulations.

See Cosmology Functions.

Power_Spectra

Implements linear-theory power spectra.

See Cosmology Functions.

Power_Spectra_Nonlinear

Implements the nonlinear power spectrum.

See Cosmology Functions.

Power_Spectra_Primordial

Provides a class that implements the primordial power spectrum.

See Cosmology Functions.

Power_Spectra_Primordial_Transferred

Provides a class that implements the transferred primordial power spectrum.

See Cosmology Functions.

Power_Spectrum_Window_Functions

Provides a class which implements window functions for computing the variance of the power spectrum.

See Cosmology Functions.

Radiation_Fields

Implements a class to describe radiation fields.

See Cosmology Functions.

Radiative_Transfer_Convergences

Provides a class that implements convergence criteria for radiative transfer calculations.

See Cosmology Functions.

Radiative_Transfer_Matters

Provides a class that implements matter types for radiative transfer calculations.

See Cosmology Functions.

Radiative_Transfer_Outputters

Provides a class that implements outputters for radiative transfer calculations.

See Cosmology Functions.

Radiative_Transfer_Photon_Packet

Provides a class that implements photon packets for radiative transfer calculations.

See Cosmology Functions.

Radiative_Transfer_Sources

Provides a class that implements photon sources for radiative transfer calculations.

See Cosmology Functions.

Radiative_Transfer_Spectra

Provides a class that implements spectra for radiative transfer calculations.

See Cosmology Functions.

Ram_Pressure_Stripping_Mass_Loss_Rate

Provides a class that implements calculations of ram pressure stripping.

See Cosmology Functions.

Regular_Expressions: Implements regular expressions by wrapping the GNU C Library implementations.

Resource_Manager: Implements a class that manages shared resources (typically pointers to objects shared by multiple other objects) via a reference counting approach and destructs them when no more references exist. Similar in approach to a shared_ptr in C++.

Root_Finder: Implements root finding.

Satellite_Deceleration_SIDM

Implements calculation of the deceleration of orbiting satellites due to dark matter self-interactions.

See Cosmology Functions.

Satellite_Dynamical_Friction

Implements calculations of dynamical friction for satellites.

See Cosmology Functions.

Satellite_Evaporation_SIDM

Implements calculation of the evaporation of orbiting satellites due to dark matter self-interactions.

See Cosmology Functions.

Satellite_Merging_Mass_Movements

Implements a class for determining how mass is moved around as a consequence of a satellite merging event.

See Cosmology Functions.

Satellite_Merging_Progenitor_Properties

Implements a class for calculations for progenitor properties for mergers.

See Cosmology Functions.

Satellite_Merging_Remnant_Sizes

Implements a class for calculations of merger remnant sizes.

See Cosmology Functions.

Satellite_Merging_Timescales

Provides and object that implements satellite merging timescales.

See Cosmology Functions.

Satellite_Oprhan_Distributions

Provides a class for dark matter halo spin distributions.

See Cosmology Functions.

Satellite_Orbits: Implements calculations related to satellite orbits.

Satellite_Promotion: Handles events where a satellite is moved to a new host halo.

Satellite_Tidal_Heating

Implements a class for calculations of tidal heating for satellites.

See Cosmology Functions.

Satellite_Tidal_Stripping

Provides a class to perform calculations of the mass loss rate due to tidal stripping for satellites.

See Cosmology Functions.

Satellite_Tidal_Stripping_Radii

Provides a class to perform calculations of the tidal stripping radius for satellites.

See Cosmology Functions.

Satellites_Bound_Mass_Initialize

Implements a class for initializing the bound mass of satellite halos.

See Cosmology Functions.

Satellites_Tidal_Fields

Implements calculations of tidal fields acting on satellites.

See Cosmology Functions.

Shocks_1D: Implements calculations of one-dimensional shock jump conditions. Provides the Rankine-Hugoniot density jump ratio across a planar shock as a function of the upstream Mach number and adiabatic index, including the strong-shock (infinite Mach number) limit.

SIDM_Parametric_Model: Implements the fitting functions of the parametric self-interacting dark matter model of Yang et al. (2024).

Sorting: Implements sorting.

Sorting_Topological: Implements topological sorting.

Spherical_Collapse_Solvers

Provides a class implementing solvers for collapse of spherical perturbations.

See Cosmology Functions.

Star_Formation_Active_Masses

Provides a class that implements calculations of active masses for star formation.

See Cosmology Functions.

Star_Formation_Histories

Implements a class for computation and output of star formation histories for galaxies.

See Cosmology Functions.

Star_Formation_Rate_Krumholz2009_Utilities: Implements various useful utility functions for calculations for the Krumholz et al. (2009) star formation surface density rate law.

Star_Formation_Rate_Surface_Density_Disks

Provides a class that implements surface density rates of star formation in disks.

See Cosmology Functions.

Star_Formation_Rates_Disks

Provides a class that implements calculations of rates of formation in disks.

See Cosmology Functions.

Star_Formation_Rates_Nuclear_Star_Clusters

Provides a class that implements calculations of rates of formation in nuclear star clusters.

See Star Formation Rates in Nuclear Star Clusters.

Star_Formation_Rates_Spheroids

Provides a class that implements calculations of rates of formation in spheroids.

See Cosmology Functions.

Star_Formation_Timescales

Provides a class that implements calculations of timescales for star formation.

See Cosmology Functions.

State: Implements storage and recovery of the Galacticus internal state. Used for restoring random number generator sequences for example.

Stateful_Types: Contains stateful types.

Statistics_Points_Correlations: Compute correlation statistics from point distributions.

Statistics_Points_Power_Spectra: Compute power spectra from point distributions.

Statistics_Variograms

Implements variogram models for Gaussian Process regression.

See Cosmology Functions.

Stellar_Astrophysics

Implements a class for calculations of stellar astrophysics.

See Cosmology Functions.

Stellar_Astrophysics_Tracks

Implements a class for stellar tracks.

See Cosmology Functions.

Stellar_Astrophysics_Winds

Implements a class for calculations of stellar winds.

See Cosmology Functions.

Stellar_Feedback

Implements a class that performs calculations of stellar feedback.

See Cosmology Functions.

Stellar_Feedback_Outflows

Provides a class that implements ejective stellar feedback.

See Cosmology Functions.

Stellar_Luminosities_Data: Holds data for the stellar luminosities class.

Stellar_Luminosities_Initialization: Initializes data for the stellar luminosities class.

Stellar_Luminosities_Structure: Defines the stellar luminosities object.

Stellar_Population_Broad_Band_Luminosities

Provides a class that implements broad band luminosities of stellar populations.

See Cosmology Functions.

Stellar_Population_Properties

Implements a class for computing properties of stellar populations.

See Cosmology Functions.

Stellar_Population_Selectors

Implements a class for selecting stellar populations.

See Cosmology Functions.

Stellar_Population_Spectra

Provides a class implementing stellar population spectra.

See Cosmology Functions.

Stellar_Population_Spectra_Postprocess

Implements a class for stellar spectra postprocessors.

See Cosmology Functions.

Stellar_Populations

Implements a class for stellar populations.

See Cosmology Functions.

Stellar_Populations_Initial_Mass_Functions

Implements a class for stellar initial mass functions.

See Cosmology Functions.

Stellar_Spectra_Dust_Attenuations

Provides a class implementing dust attenuation of stellar spectra.

See Cosmology Functions.

String_Handling: Implements various useful functionality for manipulating character strings.

Struve_Functions: Implements Struve functions.

Supernovae_Population_III

Implements a class for calculations of Population III supernovae.

See Cosmology Functions.

Supernovae_Type_Ia

Implements a class for calculations of Type Ia supernovae.

See Cosmology Functions.

System_Command: Executes system commands.

System_Compilers: Provides compiler commands.

System_Download: Downloads content from a supplied URL. A scalar URL may be provided, or a 1D array of URLs to be tried in turn—if the download from one URL fails, the next is used as a fallback.

System_Limits: Set resource limits.

System_Which: Wraps the system which command to allow finding of other tools.

Table_Labels: Defines labels for the table class.

Tables: Defines a table class with optimized interpolation operators.

Task_Evolve_Forests_Work_Shares

Provides a class implementing work sharing strategies that assign merger tree forests to MPI processes and OpenMP threads for parallel execution in the evolve forests task.

See Cosmology Functions.

Tasks

Provides a class that implements general tasks to be performed by Galacticus.

See Cosmology Functions.

Tasks_Evolve_Forests_Utilities: Provides globally-accessible functions supporting the evolveForests task class.

Tensors: Defines the structure used for describing tensors.

Test_Debugging_Functions: Contains functions used in debugging tests.

Test_Differentiation_Functions: Contains functions for differentiation unit tests.

Test_Integration2_Functions: Contains integrands for unit tests.

Test_Integration2D_Functions: Provides simple analytic test integrand functions used by the two-dimensional integration unit tests.

Test_Integration_Functions: Contains integrands for unit tests.

Test_Multidimensional_Minimizer_Functions: Contains functions for root finding unit tests.

Test_Nodes_Tasks: Implements a simple test of mapping a function over all components in a node.

Test_ODE_Solver_Functions: Contains ODEs for unit tests.

Test_Resource_Manager_Wrapper: Provides a wrapper class for testing the resourceManager class.

Test_Root_Finding_Functions: Contains functions for root finding unit tests.

Tests_Event_Hook_Functions: Module providing functions used in testing the functionality of the event hook infrastructure.

Thermodynamics_Radiation: Implements calculations of Planck blackbody thermal radiation. Provides the spectral radiance per unit wavelength or per unit frequency (the Planck function) as a function of wavelength and temperature, and the total bolometric radiance integrated over all frequencies using the Stefan-Boltzmann law.

Tidal_Stripping_Mass_Loss_Rate

Provides a class that implements calculations of tidal stripping.

See Cosmology Functions.

Timers: Implements timers.

Transfer_Functions

Provides an object that implements transfer functions.

See Cosmology Functions.

Trigonometric_Functions: Implements trigonometric functions.

Unit_Tests: Implements unit testing.

Units_MetaData: Defines the unitType derived type and associated constructor for encoding unit metadata as a compound HDF5 attribute. Each instance stores: unitsInSI Multiplicative conversion factor to SI units. description Human-readable units description (e.g.“Solar masses”). quantity astropy-parseable units string (e.g.Msun). isComoving 0 for physical units, 1 for comoving units.

Universe_Operators

Provides a class that implements operators on universes.

See Cosmology Functions.

Vectors: Implements calculations of vectors.

Virial_Density_Contrast

Provides a class implementing the virial density contrast for halos.

See Cosmology Functions.

Virial_Density_Contrast_Percolation_Utilities: Provides utilities needed by the percolation virial density contrast class.

Virial_Orbits

Provides a class implementing satellite orbital parameters at virial radius crossing.

See Cosmology Functions.