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 Accretion Disk Spectra.

Accretion_Disk_Spectra_Utilities

Provides globally-accessible functions supporting the accretionDiskSpectraClass class.

Accretion_Disks

Provides a class that implements accretion disks.

See Accretion Disks.

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 Halo Total Accretion Rates.

Accretion_Halos

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

See Accretion Onto Halos.

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 Atomic Cross-sections for Photo-ionization.

Atomic_Data

Provides various atomic data.

Atomic_Ionization_Potentials

Implements an atomic ionization potential class.

See Atomic Ionization Potentials.

Atomic_Radiation_Gaunt_Factors

Provides a class implementing Gaunt factors.

See Gaunt Factors.

Atomic_Rates_Excitation_Collisional

Provides a class implementing atomic collisional excitation rates.

See Atomic Collisional Excitation.

Atomic_Rates_Ionization_Collisional

Provides a class implementing radiative recombination rates.

See Atomic Collisional Ionization.

Atomic_Rates_Recombination_Dielectronic

Implements a dielectronic recombination rates class.

See Atomic Dielectronic Recombination Rates.

Atomic_Rates_Recombination_Radiative

Provides a class implementing radiative recombination rates.

See Atomic Radiative Recombination.

Atomic_Rates_Recombination_Radiative_Cooling

Provides a class implementing recombination cooling rates.

See Atomic Recombination Cooling.

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 Black Hole Accretion Rates.

Black_Hole_Binary_Initial_Separation

Implements a class for black hole binary initial separations.

See Black Hole Binaries Initial Separation.

Black_Hole_Binary_Mergers

Implements a class for calculations of black hole binary mergers.

See Black Hole Binaries Merger.

Black_Hole_Binary_Recoil_Velocities

Implements a class for black hole binary recoil velocities.

See Black Hole Binaries Recoil.

Black_Hole_Binary_Separations

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

See Black Hole Binaries Separation Growth Rate.

Black_Hole_CGM_Heating

Implements a class for black hole heating of the CGM.

See Black Hole CGM Heating.

Black_Hole_Fundamentals

Implements fundamental properties of black holes.

Black_Hole_Seeds

Implements a class for black hole seeds.

See Black Hole Seeds.

Black_Hole_Winds

Implements a class for black hole winds.

See Black Hole Winds.

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 Chemical Reaction Rates.

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 Chemical State.

Chemical_Structures

Implements structures that describe chemicals.

Circumgalactic_Medium_Heating

Implements a class for CGM heating.

See Circumgalactic Medium Heating.

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 Computational Domain Volume Integrators.

Computational_Domains

Provides a class that implements computational domains.

See Computational Domains.

Conditional_Mass_Functions

Implements empirical models of conditional mass functions.

See Conditional Mass Function.

Cooling_Cold_Mode_Infall_Rates

Implements calculations of the infall rate from the cold mode.

See Cold Mode Accretion Infall Rates.

Cooling_Freefall_Times_Available

Provides a class that implements calculations of the freefall radius.

See Freefall Time Available.

Cooling_Functions

Provides a class implementing cooling functions.

See Cooling Function.

Cooling_Infall_Radii

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

See Cooling Infall Radius.

Cooling_Infall_Torques

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

See Cooling Infall Torque.

Cooling_Options

Provides options controlling cooling.

Cooling_Radii

Provides a class that implements calculations of the cooling radius.

See Cooling Radii.

Cooling_Rates

Provides a class that implements calculations of the cooling rate.

See Cooling Rates.

Cooling_Specific_Angular_Momenta

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

See Specific Angular Momenta of Cooling Gas.

Cooling_Times

Implements calculations of the cooling time.

See Cooling Times.

Cooling_Times_Available

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

See Cooling Time Available.

Correlation_Functions_Two_Point

Implements two-point correlation functions.

See Two-point Correlation 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 Cosmological Velocity Field.

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 Cosmological Parameters.

Dark_Matter_Halo_Biases

Implements a dark matter halo bias class.

See Dark Matter Halo Biases.

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 Dark Matter Halo Mass Accretion Histories.

Dark_Matter_Halo_Scales

Provides a class implementing scales of dark matter halo scales.

See Dark Matter Halo Scales.

Dark_Matter_Halo_Spins

Implements calculations of dark matter halo angular momentum.

Dark_Matter_Halo_Splashback_Radii

Provides a class implementing splashback radii of dark matter halos.

See Dark Matter Halo Splashback Radii.

Dark_Matter_Halo_Splashback_Radii_Reference

Computes the reference mass and radius used by the splashback radius classes.

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 Dark Matter Halo Mass Loss Rates.

Dark_Matter_Particles

Provides a class that implements dark matter particle physics.

See Dark Matter Particle.

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 Dark Matter Profile Scale Radii.

Dark_Matter_Profiles

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

See Dark Matter Halo Profiles.

Dark_Matter_Profiles_Concentration

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

See Dark Matter Profile Concentrations.

Dark_Matter_Profiles_DMO

Provides an object that implements dark matter halo profiles.

See Dark Matter Profile Heating.

Dark_Matter_Profiles_Shape

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

See Dark Matter Profile Shapes.

Dark_Matter_Profiles_Soliton_Status

Provides an enumeration describing the structural state of a FDM halo in the soliton+NFW dark matter profile classes.

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_Banner

Displays a banner for 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 Excursion Set Barrier.

Excursion_Sets_First_Crossings

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

See Excursion Set First Crossing Statistics.

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 Freefall Radii.

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 Bar instabilities in galactic disks.

Galactic_Filters

Provides an object that implements galactic filters.

See Galactic Filter.

Galactic_Structure_Options

Provides various internal option codes for the galactic structure functions.

Galactic_Structure_Radii_Definitions

Provides parsing and evaluation 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 Galactic Structure Solver.

Galacticus_Nodes

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

Gamma_Functions

Implements calculations of Gamma functions.

Geometry_Lightcones

Implements geometries of lightcones.

See Lightcone Geometries.

Geometry_Mangle

Implements functions utilizing mangle survey geometry definitions.

Geometry_Surveys

Implements geometries of galaxy surveys.

See Survey Geometry.

Gravitational_Lensing

Implements gravitational lensing from large scale structure.

See Gravitational Lensing.

Halo_Model_Power_Spectrum_Modifiers

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

See Halo Model Power Spectrum Modifier.

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 Dark Matter Halo Spin Parameter Distributions.

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 HII Region Density Distributions.

HII_Region_Escape_Fraction

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

See HII Regions Escape Fractions.

HII_Region_Luminosity_Functions

Provides a class that implements HII region luminosity functions.

See HII Region Luminosity Functions.

HII_Region_Mass_Functions

Provides a class that implements HII region mass functions.

See HII region mass 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 Cold Mode Hot Halo Mass Distributions Core Radii.

Hot_Halo_Cold_Mode_Mass_Distributions

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

See Hot Halo Cold Mode Mass Distributions.

Hot_Halo_Mass_Distributions

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

See Hot Halo Mass Distributions.

Hot_Halo_Mass_Distributions_Core_Radii

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

See Hot Halo Mass Distributions Core Radii.

Hot_Halo_Outflows_Reincorporations

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

See Hot Halo Outflow Reincorporation.

Hot_Halo_Outflows_Stripping

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

See Hot Halo Outflow Stripping.

Hot_Halo_Ram_Pressure_Forces

Implements a class which provides calculations of ram pressure force.

See Hot Halo Ram Pressure Force.

Hot_Halo_Ram_Pressure_Stripping

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

See Hot Halo Ram Pressure Stripping.

Hot_Halo_Ram_Pressure_Stripping_Timescales

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

See Hot Halo Ram Pressure Timescales.

Hot_Halo_Temperature_Profiles

Provides a hot halo temperature profile class.

See Hot halo temperature profiles.

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 Intergalactic Medium Filtering Mass.

Intergalactic_Medium_State

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

See Intergalactic Medium State.

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 Linear Growth of Cosmological Structure.

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 Heating of Mass Distributions.

Mass_Function_Incompletenesses

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

See Mass Function Incompletenesses.

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 Unary Operators.

Memory_Reporting

Provide reporting functions for memory usage.

Merger_Tree_Branching

Implements a merger tree branching probability class.

See Merger Tree Branching Probabilities.

Merger_Tree_Branching_Modifiers

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

See Modifiers for merger tree branching probabilities.

Merger_Tree_Build_Controllers

Provides controller objects for building merger trees.

See Merger Tree Build Controllers.

Merger_Tree_Construction

Constructs/destructs merger trees.

See Merger Tree Constructors.

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 Merger Tree Evolver Profiler.

Merger_Tree_Filters

Constructs/destructs merger trees.

See Merger Tree Filters.

Merger_Tree_Initialization

Provides a class that implements initialization of merger trees.

See Merger Tree Initializors.

Merger_Tree_Operators

Provides an object that implements operators acting on merger trees.

See Merger Tree Operators.

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 Merger Tree Outputters.

Merger_Tree_Outputters_Utilities

Provides globally-accessible functions supporting the mergerTreeOutputterClass class. These exist so that a class may own a mergerTreeOutputterClass object without its module having to use the Merger_Tree_Outputters module. That matters because Merger_Tree_Outputters itself (transitively, via mergerTreeOutputterFullState) depends on Merger_Tree_Construction, which in turn depends on Nodes_Operators. A nodeOperatorClass which named the outputter class directly would therefore close a circular dependency between those modules; routing the accesses through these globally-callable functions avoids that.

Merger_Tree_Read_Importers

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

See Merger Tree Importer.

Merger_Tree_Seeds

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

See Merger Tree Random Number Seeds.

Merger_Tree_State_Store

Provides state store/restore functionality for merger trees.

Merger_Tree_Timesteps

Implements a class for merger tree evolution timestepping.

See Merger Tree Evolution Timesteps.

Merger_Tree_Walkers

Provides a class of walker objects for merger trees.

See Merger Tree Walkers.

Merger_Trees_Build_Mass_Resolution

Provides a class of merger tree mass resolutions.

See Merger Tree Building Mass Resolutions.

Merger_Trees_Build_Masses

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

See Merger Tree Build Masses.

Merger_Trees_Build_Masses_Distributions

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

See Merger Tree Mass Distributions.

Merger_Trees_Builders

Provides a class of merger tree builders.

See Merger Tree Builders.

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 Merger Tree Evolvers.

Merger_Trees_Evolve_Concurrency

Provides a class that implements merger tree evolution concurrency.

See Merger Tree Evolution Concurrency.

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 Merger Tree Node Evolvers.

Merger_Trees_Merge_Node

Provides a class that implements processing of mergers between nodes.

See Merger Tree Node Merger Processing.

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 Merger Tree Processing Times.

Model_Parameters

Implements a class of unary operators.

See Model Parameters.

Models_Likelihoods

Implements a likelihood class for posterior sampling simulations.

See Posterior Sampling Likelihoods.

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 N-Body Simulation Data Importer.

NBody_Operators

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

See N-Body Simulation Data Operators.

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.

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.

Node_Component_Black_Hole_Standard

Implement black hole tree node methods.

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.

Node_Component_Disk_Standard_Data

Stores data for the standard disk node component.

Node_Component_Disk_Very_Simple

Implements a very simple disk component.

Node_Component_Disk_Very_Simple_Size

Implements a very simple disk component.

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.

Node_Component_Hot_Halo_Standard

Implements the standard hot halo node component.

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.

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.

Node_Component_NSC_Standard

Implements the standard Galacticusnsc node component.

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.

Node_Component_Satellite_Standard

Implements the standard satellite component.

Node_Component_Spheroid_Standard

Implements the standard spheroid component.

Node_Component_Spheroid_Standard_Data

Contains data for standard spheroid components.

Node_Component_Spheroid_Very_Simple

Implements a very simple spheroid component.

Node_Components

Implements top-level functions for node components.

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 Node Property Extractor.

Node_Subhalo_Promotions

Handles subhalo promotion events.

Node_Trajectory_Events

Enumerates the events at which node evolution trajectories may be recorded by the nodeOperatorOutputTrajectory node operator. The identifier of the event which caused each record to be made is available in the output via the nodePropertyExtractorTrajectoryEvent property extractor.

Nodes_Labels

Provides functionality for labeling nodes.

Nodes_Operators

Provides a class that implements physical processes.

See Node Operators.

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 Nuclear Star Cluster Growth Rates.

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 Random Number Generators.

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 Output Analysis.

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 Output Analysis Distribution Normalizer.

Output_Analysis_Distribution_Operators

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

See Output Analysis Distribution Operator.

Output_Analysis_Molecular_Ratios

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

See Output Analysis Molecular Ratio.

Output_Analysis_Property_Operators

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

See Output Analysis Property Operator.

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 Output Analysis Target Data.

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 Output Analysis Weight Operator.

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 Output Times.

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 Posterior Sampling Differential Evolution Proposal Size.

Posterior_Sample_Differential_Random_Jump

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

See Posterior Sampling Differential Evolution Random Jumps.

Posterior_Sampling_Convergence

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

See Posterior Sampling Convergence Criteria.

Posterior_Sampling_Prop_Size_Temp_Exp

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

See Posterior Sampling Differential Evolution Proposal Size Temperature Exponent.

Posterior_Sampling_Simulation

Implements a class of posterior sampling simulators.

See Posterior Sampling Simulations.

Posterior_Sampling_State

Implements a class that maintains during posterior sampling.

See Posterior Sampling State.

Posterior_Sampling_State_Initialize

Implements a class for posterior sampling state initialization.

See Posterior Sampling State Initialization.

Posterior_Sampling_State_Samples

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

See Posterior Samples.

Posterior_Sampling_Stopping_Criteria

Implements a stopping criteria class for constraint simulations.

See Posterior Sampling Stopping Criteria.

Power_Spectra

Implements linear-theory power spectra.

See Linear Theory Power Spectrum.

Power_Spectra_Nonlinear

Implements the nonlinear power spectrum.

See Nonlinear Power Spectrum.

Power_Spectra_Primordial

Provides a class that implements the primordial power spectrum.

See Primordial Power Spectrum.

Power_Spectra_Primordial_Transferred

Provides a class that implements the transferred primordial power spectrum.

See Transferred Primordial Power Spectrum.

Power_Spectrum_Window_Functions

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

See Power Spectrum Window Functions.

Radiation_Fields

Implements a class to describe radiation fields.

See Radiation Fields.

Radiative_Transfer_Convergences

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

See Radiative Transfer Convergence Criteria.

Radiative_Transfer_Matters

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

See Radiative Transfer Matter.

Radiative_Transfer_Outputters

Provides a class that implements outputters for radiative transfer calculations.

See Radiative Transfer Outputters.

Radiative_Transfer_Photon_Packet

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

See Radiative Transfer Photon Packets.

Radiative_Transfer_Sources

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

See Radiative Transfer Photon Sources.

Radiative_Transfer_Spectra

Provides a class that implements spectra for radiative transfer calculations.

See Radiative Transfer Spectra.

Ram_Pressure_Stripping_Mass_Loss_Rate

Provides a class that implements calculations of ram pressure stripping.

See Ram Pressure Stripping.

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 Dark Matter Self-interaction Satellite Deceleration.

Satellite_Dynamical_Friction

Implements calculations of dynamical friction for satellites.

See Dynamical Friction.

Satellite_Evaporation_SIDM

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

See Dark Matter Self-interaction Satellite Evaporation.

Satellite_Merging_Mass_Movements

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

See Merger Mass Movements.

Satellite_Merging_Progenitor_Properties

Implements a class for calculations for progenitor properties for mergers.

See Merger Progenitor Properties.

Satellite_Merging_Remnant_Sizes

Implements a class for calculations of merger remnant sizes.

See Merger Remnant Sizes.

Satellite_Merging_Timescales

Provides and object that implements satellite merging timescales.

See Satellite Merging Timescales.

Satellite_Oprhan_Distributions

Provides a class for dark matter halo spin distributions.

See Satellite Orphan Distributions.

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 Satellite Halo Tidal Heating Rates.

Satellite_Tidal_Stripping

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

See Tidal Stripping of Satellites.

Satellite_Tidal_Stripping_Radii

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

See Tidal Stripping Radii.

Satellites_Bound_Mass_Initialize

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

See Satellite Bound Mass Initializor.

Satellites_Tidal_Fields

Implements calculations of tidal fields acting on satellites.

See Satellite Tidal Fields.

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 Spherical Collapse Solvers.

Star_Formation_Active_Masses

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

See Active Masses for Star Formation.

Star_Formation_Histories

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

See Star Formation Histories.

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 Surface Density Rates of Star Formation in Disks.

Star_Formation_Rates_Disks

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

See Star Formation Rates in Disks.

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 Star Formation Rates in Spheroids.

Star_Formation_Timescales

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

See Star Formation Timescales.

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

Stellar_Astrophysics

Implements a class for calculations of stellar astrophysics.

See Stellar Astrophysics.

Stellar_Astrophysics_Tracks

Implements a class for stellar tracks.

See Stellar Tracks.

Stellar_Astrophysics_Winds

Implements a class for calculations of stellar winds.

See Stellar Winds.

Stellar_Feedback

Implements a class that performs calculations of stellar feedback.

See Stellar Feedback.

Stellar_Feedback_Outflows

Provides a class that implements ejective stellar feedback.

See Stellar Feedback Outflows.

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 Stellar Population Broad Band Luminosities.

Stellar_Population_Properties

Implements a class for computing properties of stellar populations.

See Stellar Population Properties.

Stellar_Population_Selectors

Implements a class for selecting stellar populations.

See Stellar Population Selectors.

Stellar_Population_Spectra

Provides a class implementing stellar population spectra.

See Stellar Population Spectra.

Stellar_Population_Spectra_Postprocess

Implements a class for stellar spectra postprocessors.

See Stellar Population Spectra Postprocessor Builders.

Stellar_Populations

Implements a class for stellar populations.

See Stellar Populations.

Stellar_Populations_Initial_Mass_Functions

Implements a class for stellar initial mass functions.

See Initial Mass Functions.

Stellar_Spectra_Dust_Attenuations

Provides a class implementing dust attenuation of stellar spectra.

See Stellar Spectra Dust Attenuation.

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 Population III Supernovae.

Supernovae_Type_Ia

Implements a class for calculations of Type Ia supernovae.

See Supernovae Type Ia.

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. Downloads verify the TLS certificate of the server unless the optional allowInsecure argument is set to true—see downloadMultiple for the conditions under which that is permissible.

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 Evolve Forests Work Share.

Tasks

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

See Tasks.

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 Tidal Stripping Mass Loss Rates.

Timers

Implements timers.

Transfer_Functions

Provides an object that implements transfer functions.

See Transfer Function.

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 Universe Operators.

Vectors

Implements calculations of vectors.

Virial_Density_Contrast

Provides a class implementing the virial density contrast for halos.

See Virial Density Contrasts.

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 Virial Orbits.