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. .. _module-abundances_structure: ``Abundances_Structure`` Defines the abundances structure used for describing elemental abundances in Galacticus. .. _module-accretion_disk_spectra: ``Accretion_Disk_Spectra`` Implements calculations of accretion disk spectra. See :ref:`physics-cosmologyFunctions`. .. _module-accretion_disk_spectra_utilities: ``Accretion_Disk_Spectra_Utilities`` Provides globally-accessible functions supporting the :galacticus-class:`accretionDiskSpectraClass` class. .. _module-accretion_disks: ``Accretion_Disks`` Provides a class that implements accretion disks. See :ref:`physics-cosmologyFunctions`. .. _module-accretion_halo_totals: ``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 :ref:`physics-cosmologyFunctions`. .. _module-accretion_halos: ``Accretion_Halos`` Implements a class implementing accretion of gas from the :term:`IGM` onto halos. See :ref:`physics-cosmologyFunctions`. .. _module-array_utilities: ``Array_Utilities`` Contains routines which implement useful operations on arrays. .. _module-arrays_search: ``Arrays_Search`` Implements searching of ordered arrays. .. _module-atomic_cross_sections_compton: ``Atomic_Cross_Sections_Compton`` Implements calculation of the Compton cross-section. .. _module-atomic_cross_sections_ionization_photo: ``Atomic_Cross_Sections_Ionization_Photo`` Implements the atomic photo-ionization cross-section class. See :ref:`physics-cosmologyFunctions`. .. _module-atomic_data: ``Atomic_Data`` Provides various atomic data. .. _module-atomic_ionization_potentials: ``Atomic_Ionization_Potentials`` Implements an atomic ionization potential class. See :ref:`physics-cosmologyFunctions`. .. _module-atomic_radiation_gaunt_factors: ``Atomic_Radiation_Gaunt_Factors`` Provides a class implementing Gaunt factors. See :ref:`physics-cosmologyFunctions`. .. _module-atomic_rates_excitation_collisional: ``Atomic_Rates_Excitation_Collisional`` Provides a class implementing atomic collisional excitation rates. See :ref:`physics-cosmologyFunctions`. .. _module-atomic_rates_ionization_collisional: ``Atomic_Rates_Ionization_Collisional`` Provides a class implementing radiative recombination rates. See :ref:`physics-cosmologyFunctions`. .. _module-atomic_rates_recombination_dielectronic: ``Atomic_Rates_Recombination_Dielectronic`` Implements a dielectronic recombination rates class. See :ref:`physics-cosmologyFunctions`. .. _module-atomic_rates_recombination_radiative: ``Atomic_Rates_Recombination_Radiative`` Provides a class implementing radiative recombination rates. See :ref:`physics-cosmologyFunctions`. .. _module-atomic_rates_recombination_radiative_cooling: ``Atomic_Rates_Recombination_Radiative_Cooling`` Provides a class implementing recombination cooling rates. See :ref:`physics-cosmologyFunctions`. .. _module-benchmark_root_finder_functions: ``Benchmark_Root_Finder_Functions`` Callbacks and shared state for the :galacticus-class:`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. .. _module-benchmark_utilities: ``Benchmark_Utilities`` Shared utilities for benchmark programs. All output lines have the form .. code-block:: none BENCHMARK "" "" where ```` and ```` are floating-point and the trailing ```` is the display unit. The format is whitespace-tokenized, grep/awk-friendly, and consistent across all benchmark programs. .. _module-bessel_functions: ``Bessel_Functions`` Implements calculations of Bessel functions. .. _module-beta_functions: ``Beta_Functions`` Implements beta functions. .. _module-binary_search_trees: ``Binary_Search_Trees`` Implements `binary search tree `_ data structures. .. _module-binomial_coefficients: ``Binomial_Coefficients`` Implements binomial coefficients. .. _module-black_hole_accretion_rates: ``Black_Hole_Accretion_Rates`` Implements a class for black hole accretion rates. See :ref:`physics-cosmologyFunctions`. .. _module-black_hole_binary_initial_separation: ``Black_Hole_Binary_Initial_Separation`` Implements a class for black hole binary initial separations. See :ref:`physics-cosmologyFunctions`. .. _module-black_hole_binary_mergers: ``Black_Hole_Binary_Mergers`` Implements a class for calculations of black hole binary mergers. See :ref:`physics-cosmologyFunctions`. .. _module-black_hole_binary_recoil_velocities: ``Black_Hole_Binary_Recoil_Velocities`` Implements a class for black hole binary recoil velocities. See :ref:`physics-cosmologyFunctions`. .. _module-black_hole_binary_separations: ``Black_Hole_Binary_Separations`` Implements a class for calculations of black hole binary separation growth rate. See :ref:`physics-cosmologyFunctions`. .. _module-black_hole_cgm_heating: ``Black_Hole_CGM_Heating`` Implements a class for black hole heating of the :term:`CGM`. See :ref:`physics-cosmologyFunctions`. .. _module-black_hole_fundamentals: ``Black_Hole_Fundamentals`` Implements fundamental properties of black holes. .. _module-black_hole_seeds: ``Black_Hole_Seeds`` Implements a class for black hole seeds. See :ref:`physics-cosmologyFunctions`. .. _module-black_hole_winds: ``Black_Hole_Winds`` Implements a class for black hole winds. See :ref:`physics-cosmologyFunctions`. .. _module-bondi_hoyle_lyttleton_accretion: ``Bondi_Hoyle_Lyttleton_Accretion`` Implements calculations of Bondi-Hoyle-Lyttleton accretion (see :cite:author:`edgar_review_2004` :cite:year:`edgar_review_2004`). .. _module-calculations_resets: ``Calculations_Resets`` Handles resetting of calculations before a new or updated node is processed. .. _module-chemical_abundances_structure: ``Chemical_Abundances_Structure`` Defines the structure used for describing chemical abundances in Galacticus. .. _module-chemical_reaction_rates: ``Chemical_Reaction_Rates`` Provides a class implementing chemical reaction rates. See :ref:`physics-cosmologyFunctions`. .. _module-chemical_reaction_rates_utilities: ``Chemical_Reaction_Rates_Utilities`` Implements various useful utility functions for calculations of chemical abundances and rates. .. _module-chemical_states: ``Chemical_States`` Provides a class implementing the chemical state. See :ref:`physics-cosmologyFunctions`. .. _module-chemical_structures: ``Chemical_Structures`` Implements structures that describe chemicals. .. _module-circumgalactic_medium_heating: ``Circumgalactic_Medium_Heating`` Implements a class for :term:`CGM` heating. See :ref:`physics-cosmologyFunctions`. .. _module-command_arguments: ``Command_Arguments`` Provides an interface to read command line arguments of arbitrary type. .. _module-computational_domain_volume_integrators: ``Computational_Domain_Volume_Integrators`` Provides a class that implements computational domains. See :ref:`physics-cosmologyFunctions`. .. _module-computational_domains: ``Computational_Domains`` Provides a class that implements computational domains. See :ref:`physics-cosmologyFunctions`. .. _module-conditional_mass_functions: ``Conditional_Mass_Functions`` Implements empirical models of conditional mass functions. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_cold_mode_infall_rates: ``Cooling_Cold_Mode_Infall_Rates`` Implements calculations of the infall rate from the cold mode. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_freefall_times_available: ``Cooling_Freefall_Times_Available`` Provides a class that implements calculations of the freefall radius. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_functions: ``Cooling_Functions`` Provides a class implementing cooling functions. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_infall_radii: ``Cooling_Infall_Radii`` Provides a class that implements calculations of the infall radius for cooling calculations. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_infall_torques: ``Cooling_Infall_Torques`` Provides a class that implements calculations of the infall torques for cooling calculations. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_options: ``Cooling_Options`` Provides options controlling cooling. .. _module-cooling_radii: ``Cooling_Radii`` Provides a class that implements calculations of the cooling radius. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_rates: ``Cooling_Rates`` Provides a class that implements calculations of the cooling rate. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_specific_angular_momenta: ``Cooling_Specific_Angular_Momenta`` Provides a class that implements calculations of the specific angular momentum of cooling gas. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_times: ``Cooling_Times`` Implements calculations of the cooling time. See :ref:`physics-cosmologyFunctions`. .. _module-cooling_times_available: ``Cooling_Times_Available`` Provides a class that implements calculations of the time available for cooling. See :ref:`physics-cosmologyFunctions`. .. _module-coordinate_systems: ``Coordinate_Systems`` Implements calculations related to coordinate systems and transformations. .. _module-coordinates: ``Coordinates`` Implements the coordinates class. .. _module-correlation_functions_two_point: ``Correlation_Functions_Two_Point`` Implements two-point correlation functions. See :ref:`physics-cosmologyFunctions`. .. _module-cosmological_density_field: ``Cosmological_Density_Field`` Provides an object that implements critical overdensities and halo environments. See :ref:`physics-cosmologicalMassVariance`. .. _module-cosmological_velocity_field: ``Cosmological_Velocity_Field`` Provides a class that implements models of the cosmological velocity field. See :ref:`physics-cosmologyFunctions`. .. _module-cosmology_functions: ``Cosmology_Functions`` Provides an object that implements cosmological functions. See :ref:`physics-cosmologyFunctions`. .. _module-cosmology_functions_options: ``Cosmology_Functions_Options`` Provides options for cosmological functions. .. _module-cosmology_functions_parameters: ``Cosmology_Functions_Parameters`` Defines option parameters for cosmology functions. .. _module-cosmology_parameters: ``Cosmology_Parameters`` Provides an object that implements cosmological parameters. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_halo_biases: ``Dark_Matter_Halo_Biases`` Implements a dark matter halo bias class. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_halo_formation_times: ``Dark_Matter_Halo_Formation_Times`` Implements calculations of dark matter halo formation times. .. _module-dark_matter_halo_mass_accretion_histories: ``Dark_Matter_Halo_Mass_Accretion_Histories`` Provides a class for calculations of dark matter halo mass accretion histories. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_halo_scales: ``Dark_Matter_Halo_Scales`` Provides a class implementing scales of dark matter halo scales. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_halo_spins: ``Dark_Matter_Halo_Spins`` Implements calculations of dark matter halo angular momentum. .. _module-dark_matter_halos_correa2015: ``Dark_Matter_Halos_Correa2015`` Implements utility functions for the :cite:t:`correa_accretion_2015` dark matter halo models. .. _module-dark_matter_halos_mass_loss_rates: ``Dark_Matter_Halos_Mass_Loss_Rates`` Implements calculations of mass loss rates from dark matter halos. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_particles: ``Dark_Matter_Particles`` Provides a class that implements dark matter particle physics. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_profile_mass_definitions: ``Dark_Matter_Profile_Mass_Definitions`` Implements calculations of dark matter profile scale radii from concentrations. .. _module-dark_matter_profile_scales: ``Dark_Matter_Profile_Scales`` Provides a class that implements scale radii dark matter halo profiles. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_profiles: ``Dark_Matter_Profiles`` Provides an object that implements non-dark-matter-only dark matter halo profiles. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_profiles_concentration: ``Dark_Matter_Profiles_Concentration`` Provides a class that implements concentrations of dark matter halo profiles. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_profiles_dmo: ``Dark_Matter_Profiles_DMO`` Provides an object that implements dark matter halo profiles. See :ref:`physics-cosmologyFunctions`. .. _module-dark_matter_profiles_shape: ``Dark_Matter_Profiles_Shape`` Provides a class that implements shape parameters of dark matter halo profiles. See :ref:`physics-cosmologyFunctions`. .. _module-dates_and_times: ``Dates_and_Times`` Implements computation of formatted dates and times. .. _module-debugging: ``Debugging`` Implements useful debugging utilities. .. _module-decaying_dark_matter: ``Decaying_Dark_Matter`` Implements useful shared utilities for calculations of decaying dark matter. .. _module-dependencies: ``Dependencies`` Implements dependency versioning. .. _module-dictionaries: ``Dictionaries`` Implements "dictionaries" (i.e. associative arrays). .. _module-dilogarithms: ``Dilogarithms`` Implements dilogarithms. .. _module-disparity_ratios: ``Disparity_Ratios`` Implements calculations of disparity ratios, i.e. :math:`r(a,b)=\hbox{max}(|a|/|b|,|b|/|a|)`. .. _module-display: ``Display`` Implements outputting of formatted, indented messages at various verbosity levels from Galacticus. .. _module-display_banner: ``Display_Banner`` Displays a banner for Galacticus. .. _module-display_verbosity: ``Display_Verbosity`` Handle setting of verbosity. .. _module-elliptic_integrals: ``Elliptic_Integrals`` Implements exponential integrals. .. _module-enumerations: ``Enumerations`` Defines the base class for all ``enumeration`` classes. .. _module-error: ``Error`` Implements error reporting for the Galacticus package. .. _module-error_functions: ``Error_Functions`` Implements calculations of error functions. .. _module-error_utilities: ``Error_Utilities`` Provides error handling utilities. .. _module-events_black_hole_merger: ``Events_Black_Hole_Merger`` Performs tasks associated with black hole merger events. .. _module-events_filters: ``Events_Filters`` Provides a globally-callable event filtering function. .. _module-events_halo_formation: ``Events_Halo_Formation`` Performs tasks associated with "halo formation" events. .. _module-events_hooks: ``Events_Hooks`` Handles hooking of object function class into events. .. _module-evolve_to_time_reports: ``Evolve_To_Time_Reports`` Contains functions which report on timestepping criteria. .. _module-excursion_sets_barriers: ``Excursion_Sets_Barriers`` Provides a class that implements barriers for the excursion set problem. See :ref:`physics-cosmologyFunctions`. .. _module-excursion_sets_first_crossings: ``Excursion_Sets_First_Crossings`` Provides a class for first crossing distributions for excursion set calculations. See :ref:`physics-cosmologyFunctions`. .. _module-exponential_integrals: ``Exponential_Integrals`` Implements exponential integrals. .. _module-factorials: ``Factorials`` Implements calculations of factorials .. _module-fftlogs: ``FFTLogs`` Wraps the :term:`FFTLog` functions. .. _module-fftw3: ``FFTW3`` Imports the FFTW3 library Fortran interface. .. _module-file_utilities: ``File_Utilities`` Implements various file-related utilities. .. _module-freefall_radii: ``Freefall_Radii`` Provides a class that implements calculations of the freefall radius. See :ref:`physics-cosmologyFunctions`. .. _module-function_classes: ``Function_Classes`` Defines the base class for all ``functionClass`` classes. .. _module-functions_global: ``Functions_Global`` Provides pointers to global functions. .. _module-functions_global_utilities: ``Functions_Global_Utilities`` Provides utilities needed by global functions. .. _module-galactic_dynamics_bar_instabilities: ``Galactic_Dynamics_Bar_Instabilities`` Provides a class that implements calculations of bar instability in galactic disks. See :ref:`physics-cosmologyFunctions`. .. _module-galactic_filters: ``Galactic_Filters`` Provides an object that implements galactic filters. See :ref:`physics-cosmologyFunctions`. .. _module-galactic_structure_options: ``Galactic_Structure_Options`` Provides various internal option codes for the galactic structure functions. .. _module-galactic_structure_radii_definitions: ``Galactic_Structure_Radii_Definitions`` Provides parsing of radii definitions used in output specifiers. .. _module-galactic_structure_radius_solver_utilities: ``Galactic_Structure_Radius_Solver_Utilities`` Provides utility functions for galactic structure solver. .. _module-galactic_structure_solvers: ``Galactic_Structure_Solvers`` Implements a class for calculations of sizes of galactic components (or more general components). See :ref:`physics-cosmologyFunctions`. .. _module-galacticus_nodes: ``Galacticus_Nodes`` Implements an object hierarchy for nodes in merger trees and all of their constituent physical components. See :ref:`physics-cosmologyFunctions`. .. _module-gamma_functions: ``Gamma_Functions`` Implements calculations of Gamma functions. .. _module-geometry_lightcones: ``Geometry_Lightcones`` Implements geometries of lightcones. See :ref:`physics-cosmologyFunctions`. .. _module-geometry_mangle: ``Geometry_Mangle`` Implements functions utilizing :term:`mangle` survey geometry definitions. .. _module-geometry_surveys: ``Geometry_Surveys`` Implements geometries of galaxy surveys. See :ref:`physics-cosmologyFunctions`. .. _module-gravitational_lensing: ``Gravitational_Lensing`` Implements gravitational lensing from large scale structure. See :ref:`physics-cosmologyFunctions`. .. _module-halo_model_power_spectrum_modifiers: ``Halo_Model_Power_Spectrum_Modifiers`` Implements a class of modifiers of the power spectrum for the halo model. See :ref:`physics-cosmologyFunctions`. .. _module-halo_model_projected_correlations: ``Halo_Model_Projected_Correlations`` Implements calculations of projected correlation functions using the halo model. .. _module-halo_spin_distributions: ``Halo_Spin_Distributions`` Provides a class for dark matter halo spin distributions. See :ref:`physics-cosmologyFunctions`. .. _module-hashes_perfect: ``Hashes_Perfect`` Implements a perfect hash algorithm for long integer keys based on methods described by :cite:t:`czech_fundamental_1997`. The specific implementation follows the general structure of that given in a Dr. Dobbs `article `_. .. _module-hdf5_access: ``HDF5_Access`` Provides an OpenMP lock to serialize access to the HDF5 library, preventing race conditions when multiple threads attempt concurrent HDF5 operations. .. _module-hii_region_density_distributions: ``HII_Region_Density_Distributions`` Provides a class that implements calculations for hydrogen density distribution in a HII region. See :ref:`physics-cosmologyFunctions`. .. _module-hii_region_escape_fraction: ``HII_Region_Escape_Fraction`` Provides a class that implements calculations of escape fractions from HII regions. See :ref:`physics-cosmologyFunctions`. .. _module-hii_region_luminosity_functions: ``HII_Region_Luminosity_Functions`` Provides a class that implements HII region luminosity functions. See :ref:`physics-cosmologyFunctions`. .. _module-hii_region_mass_functions: ``HII_Region_Mass_Functions`` Provides a class that implements HII region mass functions. See :ref:`physics-cosmologyFunctions`. .. _module-histories: ``Histories`` Defines the history object type. .. _module-hot_halo_cold_mode_density_core_radii: ``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 :ref:`physics-cosmologyFunctions`. .. _module-hot_halo_cold_mode_mass_distributions: ``Hot_Halo_Cold_Mode_Mass_Distributions`` Provides an object which provides a hot halo cold mode mass distribution class. See :ref:`physics-cosmologyFunctions`. .. _module-hot_halo_mass_distributions: ``Hot_Halo_Mass_Distributions`` Provides an object which provides a hot halo mass distribution class. See :ref:`physics-cosmologyFunctions`. .. _module-hot_halo_mass_distributions_core_radii: ``Hot_Halo_Mass_Distributions_Core_Radii`` Provides an object that implements core radii for hot halo mass distributions. See :ref:`physics-cosmologyFunctions`. .. _module-hot_halo_outflows_reincorporations: ``Hot_Halo_Outflows_Reincorporations`` Provides a class that implements reincorporation of outflowed mass into the hot halo. See :ref:`physics-cosmologyFunctions`. .. _module-hot_halo_outflows_stripping: ``Hot_Halo_Outflows_Stripping`` Provides a class that implements stripping of outflowed mass in the hot halo. See :ref:`physics-cosmologyFunctions`. .. _module-hot_halo_ram_pressure_forces: ``Hot_Halo_Ram_Pressure_Forces`` Implements a class which provides calculations of ram pressure force. See :ref:`physics-cosmologyFunctions`. .. _module-hot_halo_ram_pressure_stripping: ``Hot_Halo_Ram_Pressure_Stripping`` Implements a class for calculations of ram pressure stripping of hot halos. See :ref:`physics-cosmologyFunctions`. .. _module-hot_halo_ram_pressure_stripping_timescales: ``Hot_Halo_Ram_Pressure_Stripping_Timescales`` Implements a class for calculations of ram pressure stripping timescales for hot halos. See :ref:`physics-cosmologyFunctions`. .. _module-hot_halo_temperature_profiles: ``Hot_Halo_Temperature_Profiles`` Provides a hot halo temperature profile class. See :ref:`physics-cosmologyFunctions`. .. _module-hypergeometric_functions: ``Hypergeometric_Functions`` Implements hypergeometric functions. .. _module-ideal_gases_thermodynamics: ``Ideal_Gases_Thermodynamics`` Implements thermodynamic properties of ideal gases. Provides the adiabatic sound speed (assuming :math:`\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. .. _module-input_parameters: ``Input_Parameters`` Implements reading of parameters from an XML file. .. _module-input_paths: ``Input_Paths`` Provides the path for Galacticus inputs and scripts. .. _module-instruments_filters: ``Instruments_Filters`` Implements calculations of filter response curves. .. _module-interface_gsl: ``Interface_GSL`` Interfaces with low-level aspects of the GSL library. .. _module-interface_local_group_db: ``Interface_Local_Group_DB`` Interfaces with the Local Group database. .. _module-interfaces_axioncamb: ``Interfaces_AxionCAMB`` Provides various interfaces to the :term:`AxionCAMB` code. .. _module-interfaces_camb: ``Interfaces_CAMB`` Provides various interfaces to the :term:`CAMB` code. .. _module-interfaces_class: ``Interfaces_CLASS`` Provides various interfaces to the :term:`CLASS` code. .. _module-interfaces_cloudy: ``Interfaces_Cloudy`` Provides various interfaces to the :term:`Cloudy` code. .. _module-interfaces_cloudy_cie: ``Interfaces_Cloudy_CIE`` Provides an interface to the :term:`Cloudy` code for computing tables of cooling functions and chemical state in collisional ionization equilibrium. .. _module-interfaces_fsps: ``Interfaces_FSPS`` Provides various interfaces to the FSPS code :cite:p:`conroy_propagation_2009`. .. _module-interfaces_recfast: ``Interfaces_RecFast`` Provides various interfaces to the :term:`RecFast` code. .. _module-intergalactic_medium_filtering_masses: ``Intergalactic_Medium_Filtering_Masses`` Provides a class for filtering masses. See :ref:`physics-cosmologyFunctions`. .. _module-intergalactic_medium_state: ``Intergalactic_Medium_State`` Provides a class for calculations of the intergalactic medium thermal and ionization state. See :ref:`physics-cosmologyFunctions`. .. _module-io_hdf5: ``IO_HDF5`` Implements simple and convenient interfaces to a variety of HDF5 functionality. .. _module-io_irate: ``IO_IRATE`` Provides IO in :term:`IRATE` format, an HDF5-based standard for halo catalogs that stores per-snapshot halo properties (positions, velocities, masses, IDs) alongside cosmological and simulation metadata. .. _module-io_xml: ``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. .. _module-kepler_orbits: ``Kepler_Orbits`` Defines an orbit structure for use in Galacticus. .. _module-kind_numbers: ``Kind_Numbers`` Defines various kind types. .. _module-lambert_ws: ``Lambert_Ws`` Implements Lambert W functions. .. _module-linear_algebra: ``Linear_Algebra`` Implements linear algebra calculations. .. _module-linear_growth: ``Linear_Growth`` Provides a class that implements linear growth of cosmological structure. See :ref:`physics-cosmologyFunctions`. .. _module-locks: ``Locks`` Provides advanced locks. .. _module-mass_distribution_soliton_schive2014: ``Mass_Distribution_Soliton_Schive2014`` Provides utility variables for the :cite:t:`schive_understanding_2014` soliton density profile. .. _module-mass_distributions: ``Mass_Distributions`` Implements a class that provides mass distributions. See :ref:`physics-cosmologyFunctions`. .. _module-mass_function_incompletenesses: ``Mass_Function_Incompletenesses`` Provides a class that implements incompleteness calculations for observed mass functions. See :ref:`physics-cosmologyFunctions`. .. _module-math_arithmetic: ``Math_Arithmetic`` Provides basic arithmetic functions, often handling floating point issues. .. _module-math_distributions_gaussian: ``Math_Distributions_Gaussian`` Implements Gaussian distributions. .. _module-math_distributions_poisson_binomial: ``Math_Distributions_Poisson_Binomial`` Implements Poisson binomial distributions. .. _module-math_exponentiation: ``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. .. _module-math_operators_unary: ``Math_Operators_Unary`` Implements a class of unary operators. See :ref:`physics-cosmologyFunctions`. .. _module-memory_reporting: ``Memory_Reporting`` Provide reporting functions for memory usage. .. _module-merger_tree_branching: ``Merger_Tree_Branching`` Implements a merger tree branching probability class. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_branching_modifiers: ``Merger_Tree_Branching_Modifiers`` Provides a module which provides a class that implements core radii for cored cold mode hot halo mass distributions. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_build_controllers: ``Merger_Tree_Build_Controllers`` Provides controller objects for building merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_construction: ``Merger_Tree_Construction`` Constructs/destructs merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_data_structure: ``Merger_Tree_Data_Structure`` Implements an object to store merger tree data for processing into Galacticus's preferred file format. .. _module-merger_tree_evolve_profilers: ``Merger_Tree_Evolve_Profilers`` Provides a class that implements profiling of merger tree evolution. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_filters: ``Merger_Tree_Filters`` Constructs/destructs merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_initialization: ``Merger_Tree_Initialization`` Provides a class that implements initialization of merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_operators: ``Merger_Tree_Operators`` Provides an object that implements operators acting on merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_outputter_buffer_types: ``Merger_Tree_Outputter_Buffer_Types`` Provides buffer types for merger tree outputters. .. _module-merger_tree_outputters: ``Merger_Tree_Outputters`` Provides a class that implements evolution of merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_read_importers: ``Merger_Tree_Read_Importers`` Provides an object that implements importing of merger trees from file. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_seeds: ``Merger_Tree_Seeds`` Implements a class for setting random number seeds in merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_state_store: ``Merger_Tree_State_Store`` Provides state store/restore functionality for merger trees. .. _module-merger_tree_timesteps: ``Merger_Tree_Timesteps`` Implements a class for merger tree evolution timestepping. See :ref:`physics-cosmologyFunctions`. .. _module-merger_tree_walkers: ``Merger_Tree_Walkers`` Provides a class of walker objects for merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_trees_build_mass_resolution: ``Merger_Trees_Build_Mass_Resolution`` Provides a class of merger tree mass resolutions. See :ref:`physics-cosmologyFunctions`. .. _module-merger_trees_build_masses: ``Merger_Trees_Build_Masses`` Implements a class for creating sets of tree masses to use when building merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_trees_build_masses_distributions: ``Merger_Trees_Build_Masses_Distributions`` Implements a class providing mass distributions for merger trees to be built. See :ref:`physics-cosmologyFunctions`. .. _module-merger_trees_builders: ``Merger_Trees_Builders`` Provides a class of merger tree builders. See :ref:`physics-cosmologyFunctions`. .. _module-merger_trees_dump: ``Merger_Trees_Dump`` Implements dumping of the structure of a merger tree to a file for plotting with `dot `_. .. _module-merger_trees_evolve: ``Merger_Trees_Evolve`` Provides a class that implements evolution of merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-merger_trees_evolve_concurrency: ``Merger_Trees_Evolve_Concurrency`` Provides a class that implements merger tree evolution concurrency. See :ref:`physics-cosmologyFunctions`. .. _module-merger_trees_evolve_deadlock_status: ``Merger_Trees_Evolve_Deadlock_Status`` Provides an enumeration for tree deadlock statuses. .. _module-merger_trees_evolve_node: ``Merger_Trees_Evolve_Node`` Provides a class that implements evolution of nodes. See :ref:`physics-cosmologyFunctions`. .. _module-merger_trees_merge_node: ``Merger_Trees_Merge_Node`` Provides a class that implements processing of mergers between nodes. See :ref:`physics-cosmologyFunctions`. .. _module-meshes: ``Meshes`` Provide tools for working with grids. .. _module-meta_tree_compute_times: ``Meta_Tree_Compute_Times`` Provides a class for calculations of the time taken to process merger trees. See :ref:`physics-cosmologyFunctions`. .. _module-model_parameters: ``Model_Parameters`` Implements a class of unary operators. See :ref:`physics-cosmologyFunctions`. .. _module-models_likelihoods: ``Models_Likelihoods`` Implements a likelihood class for posterior sampling simulations. See :ref:`physics-cosmologyFunctions`. .. _module-models_likelihoods_constants: ``Models_Likelihoods_Constants`` Provides constants for use when constraining Galacticus. .. _module-mpi_utilities: ``MPI_Utilities`` Implements useful MPI utilities. .. _module-multi_counters: ``Multi_Counters`` Implements multi-counters - objects which iterate over all combinations of an arbitrary number of counters, each with an arbitrary range. .. _module-multidimensional_minimizer: ``Multidimensional_Minimizer`` Implements multidimensional minimizers. .. _module-nbody_importers: ``NBody_Importers`` Provides a class that implements importing of data from N-body simulations. See :ref:`physics-cosmologyFunctions`. .. _module-nbody_operators: ``NBody_Operators`` Provides a class that implements operators on data from N-body simulations. See :ref:`physics-cosmologyFunctions`. .. _module-nbody_simulation_data: ``NBody_Simulation_Data`` Provides a class to store N-body simulation data. .. _module-nearest_neighbors: ``Nearest_Neighbors`` Wraps the `ANN `_ (Approximate Nearest Neighbor) library. .. _module-node_branch_jumps: ``Node_Branch_Jumps`` Handles satellite node branch jump events. .. _module-node_component_basic_standard: ``Node_Component_Basic_Standard`` The standard implementation of basic tree node methods. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_black_hole_noncentral: ``Node_Component_Black_Hole_Noncentral`` Implement non-central black hole tree node methods. .. _module-node_component_black_hole_simple: ``Node_Component_Black_Hole_Simple`` Implements the simple black hole node component. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_black_hole_standard: ``Node_Component_Black_Hole_Standard`` Implement black hole tree node methods. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_black_hole_standard_data: ``Node_Component_Black_Hole_Standard_Data`` Stores data for the standard black hole node component. .. _module-node_component_dark_matter_profile_scale: ``Node_Component_Dark_Matter_Profile_Scale`` Implements a dark matter profile method that provides a scale radius. .. _module-node_component_dark_matter_profile_scale_free: ``Node_Component_Dark_Matter_Profile_Scale_Free`` Implements a dark matter profile method that provides no properties (but does provide a mass distribution factory). .. _module-node_component_dark_matter_profile_scale_shape: ``Node_Component_Dark_Matter_Profile_Scale_Shape`` Implements a dark matter profile method that provides a scale radius and a shape parameter. .. _module-node_component_dark_matter_profile_scale_triaxial: ``Node_Component_Dark_Matter_Profile_Scale_Triaxial`` Implements a dark matter profile method that provides a scale radius and a shape parameter. .. _module-node_component_disk_standard: ``Node_Component_Disk_Standard`` Implements the standard disk node component. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_disk_standard_data: ``Node_Component_Disk_Standard_Data`` Stores data for the standard disk node component. .. _module-node_component_disk_very_simple: ``Node_Component_Disk_Very_Simple`` Implements a very simple disk component. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_disk_very_simple_size: ``Node_Component_Disk_Very_Simple_Size`` Implements a very simple disk component. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_disk_very_simple_size_data: ``Node_Component_Disk_Very_Simple_Size_Data`` Stores data for the very simple size disk node component. .. _module-node_component_halo_angular_momentum_scalar: ``Node_Component_Halo_Angular_Momentum_Scalar`` Implement a scalar spin component for tree nodes. .. _module-node_component_halo_angular_momentum_vector: ``Node_Component_Halo_Angular_Momentum_Vector`` Implements the vector spin component. .. _module-node_component_hot_halo_cold_mode: ``Node_Component_Hot_Halo_Cold_Mode`` Implements an extension to the standard hot halo node component which supports a cold mode reservoir. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_hot_halo_standard: ``Node_Component_Hot_Halo_Standard`` Implements the standard hot halo node component. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_hot_halo_standard_data: ``Node_Component_Hot_Halo_Standard_Data`` Provides data for the standard hot halo node component. .. _module-node_component_hot_halo_very_simple: ``Node_Component_Hot_Halo_Very_Simple`` Implements a very simple hot halo node component. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_hot_halo_vs_delayed: ``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 :ref:`physics-cosmologyFunctions`. .. _module-node_component_nsc_standard: ``Node_Component_NSC_Standard`` Implements the standard Galacticusnsc node component. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_nsc_standard_data: ``Node_Component_NSC_Standard_Data`` Stores data for the standard nuclear star cluster node component. .. _module-node_component_position_cartesian: ``Node_Component_Position_Cartesian`` Implements a position component in Cartesian coordinates. .. _module-node_component_satellite_merge_time: ``Node_Component_Satellite_Merge_Time`` Implements a satellite orbit component that simply tracks the time of merging. .. _module-node_component_satellite_orbiting: ``Node_Component_Satellite_Orbiting`` Implements the orbiting satellite component. .. _module-node_component_satellite_preset: ``Node_Component_Satellite_Preset`` Implements a preset satellite orbit component. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_satellite_standard: ``Node_Component_Satellite_Standard`` Implements the standard satellite component. .. _module-node_component_spheroid_standard: ``Node_Component_Spheroid_Standard`` Implements the standard spheroid component. See :ref:`physics-cosmologyFunctions`. .. _module-node_component_spheroid_standard_data: ``Node_Component_Spheroid_Standard_Data`` Contains data for standard spheroid components. .. _module-node_component_spheroid_very_simple: ``Node_Component_Spheroid_Very_Simple`` Implements a very simple spheroid component. See :ref:`physics-cosmologyFunctions`. .. _module-node_components: ``Node_Components`` Implements top-level functions for node components. See :ref:`physics-cosmologyFunctions`. .. _module-node_events_inter_tree: ``Node_Events_Inter_Tree`` Handles inter-tree node events. .. _module-node_property_extractor_galaxy_merger_trees: ``Node_Property_Extractor_Galaxy_Merger_Trees`` A module storing object references needed for galaxy merger trees. .. _module-node_property_extractors: ``Node_Property_Extractors`` Provides a class that implements extraction of properties from nodes. See :ref:`physics-cosmologyFunctions`. .. _module-node_subhalo_promotions: ``Node_Subhalo_Promotions`` Handles subhalo promotion events. .. _module-nodes_labels: ``Nodes_Labels`` Provides functionality for labeling nodes. .. _module-nodes_operators: ``Nodes_Operators`` Provides a class that implements physical processes. See :ref:`physics-cosmologyFunctions`. .. _module-nodes_operators_black_holes_utilities: ``Nodes_Operators_Black_Holes_Utilities`` Provides functions supporting the black hole physics in the :galacticus-class:`nodeOperatorClass` class. .. _module-nodes_operators_utilities: ``Nodes_Operators_Utilities`` Provides globally-accessible functions supporting the :galacticus-class:`nodeOperatorClass` class. .. _module-nuclear_star_cluster_growth_rates: ``Nuclear_Star_Cluster_Growth_Rates`` Provides a class that implements calculations of rates of gas inflows onto nuclear star clusters. See :ref:`physics-cosmologyFunctions`. .. _module-numerical_comparison: ``Numerical_Comparison`` Implements comparisons of values. .. _module-numerical_constants_astronomical: ``Numerical_Constants_Astronomical`` Contains various useful astronomical constants. .. _module-numerical_constants_atomic: ``Numerical_Constants_Atomic`` Contains various useful atomic constants. .. _module-numerical_constants_boolean: ``Numerical_Constants_Boolean`` Contains various useful Boolean constants. .. _module-numerical_constants_math: ``Numerical_Constants_Math`` Contains various useful mathematical constants. .. _module-numerical_constants_physical: ``Numerical_Constants_Physical`` Contains various useful physical constants. .. _module-numerical_constants_prefixes: ``Numerical_Constants_Prefixes`` Contains useful numerical prefixes. .. _module-numerical_constants_units: ``Numerical_Constants_Units`` Contains various useful unit conversions. .. _module-numerical_differentiation: ``Numerical_Differentiation`` Implements numerical differentiation. .. _module-numerical_integration: ``Numerical_Integration`` Implements numerical integration. .. _module-numerical_integration2: ``Numerical_Integration2`` Implements a variety of numerical integrators. .. _module-numerical_integration_2d: ``Numerical_Integration_2D`` Implements a simple two-dimensional integrator. .. _module-numerical_interpolation: ``Numerical_Interpolation`` A simple interface to the `GNU Scientific Library `_ `interpolation routines `_. .. _module-numerical_interpolation_2d_irregular: ``Numerical_Interpolation_2D_Irregular`` Implements bivariate interpolation on irregularly distributed points :cite:p:`akima_algorithm_1978`. All state is encapsulated in ``interpolator2DIrregular`` so that separate instances are fully independent and thread-safe without any critical sections. .. _module-numerical_ode_solvers: ``Numerical_ODE_Solvers`` Implements an ODE solver class. .. _module-numerical_quasi_random_sequences: ``Numerical_Quasi_Random_Sequences`` Implements quasi-random sequences. .. _module-numerical_random_numbers: ``Numerical_Random_Numbers`` Provides a class that implements random number generators. See :ref:`physics-cosmologyFunctions`. .. _module-numerical_ranges: ``Numerical_Ranges`` Implements construction of numerical ranges. .. _module-numerical_roman_numerals: ``Numerical_Roman_Numerals`` Implements conversion of integers to Roman numerals. .. _module-object_pools: ``Object_Pools`` Implements a reusable pool of reference-counted :galacticus-class:`functionClass` objects, so that objects which would otherwise be created and destroyed on every call (e.g. per-:term:`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 :math:`1`, i.e. the only remaining reference to it is that held by the pool itself. .. _module-octree_data_structure: ``Octree_Data_Structure`` Implements an object to store octree data structure. .. _module-ode_solver_error_codes: ``ODE_Solver_Error_Codes`` Defines internal error codes for the Galacticus ODE solver. .. _module-openmp_utilities: ``OpenMP_Utilities`` Implements useful OpenMP utilities. .. _module-openmp_utilities_data: ``OpenMP_Utilities_Data`` Implements data for useful OpenMP utilities. .. _module-output_analyses: ``Output_Analyses`` Provides a class that implements on-the-fly analyses. See :ref:`physics-cosmologyFunctions`. .. _module-output_analyses_options: ``Output_Analyses_Options`` Provides options and enumerations for on-the-fly analyses. .. _module-output_analysis_distribution_normalizers: ``Output_Analysis_Distribution_Normalizers`` Provides a class that normalizers on distributions used in on-the-fly output analyses. See :ref:`physics-cosmologyFunctions`. .. _module-output_analysis_distribution_operators: ``Output_Analysis_Distribution_Operators`` Provides a class that operators on distributions used in on-the-fly output analyses. See :ref:`physics-cosmologyFunctions`. .. _module-output_analysis_molecular_ratios: ``Output_Analysis_Molecular_Ratios`` Provides a class that implements operators on properties for on-the-fly analyses. See :ref:`physics-cosmologyFunctions`. .. _module-output_analysis_property_operators: ``Output_Analysis_Property_Operators`` Provides a class that implements operators on properties for on-the-fly analyses. See :ref:`physics-cosmologyFunctions`. .. _module-output_analysis_target_data: ``Output_Analysis_Target_Data`` Provides a class that packages the shared "target data" arguments used by the various 1D function output analyses (:galacticus-class:`outputAnalysisMeanFunction1D`, :galacticus-class:`outputAnalysisScatterFunction1D`, :galacticus-class:`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 :math:`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 :ref:`physics-cosmologyFunctions`. .. _module-output_analysis_utilities: ``Output_Analysis_Utilities`` Provides a collection of utilities useful for on-the-fly analyses. .. _module-output_analysis_weight_operators: ``Output_Analysis_Weight_Operators`` Provides a class that implements operators on weights for on-the-fly analyses. See :ref:`physics-cosmologyFunctions`. .. _module-output_build: ``Output_Build`` Implements writing of Galacticus build information to the Galacticus output file. .. _module-output_hdf5: ``Output_HDF5`` Manages HDF5 output from Galacticus. .. _module-output_hdf5_open: ``Output_HDF5_Open`` Handles opening of the Galacticus output file. .. _module-output_times: ``Output_Times`` Provides a class that implements output times for Galacticus. See :ref:`physics-cosmologyFunctions`. .. _module-output_versioning: ``Output_Versioning`` Implements writing of the version number and run time to the Galacticus output file. .. _module-points: ``Points`` Provide tools for working with sets of points. .. _module-points_convex_hull: ``Points_Convex_Hull`` Provide tools for working with convex hulls of sets of points. .. _module-poly_ranks: ``Poly_Ranks`` Provides poly-ranked types (i.e. types which can store data in arrays of different ranks). .. _module-polylogarithms: ``Polylogarithms`` Implements polylogarithm functions. .. _module-posterior_sample_differential_proposal_size: ``Posterior_Sample_Differential_Proposal_Size`` Implements algorithms for the proposal size in differential evolution algorithms. See :ref:`physics-cosmologyFunctions`. .. _module-posterior_sample_differential_random_jump: ``Posterior_Sample_Differential_Random_Jump`` Implements a class for the random jump component in differential evolution algorithms. See :ref:`physics-cosmologyFunctions`. .. _module-posterior_sampling_convergence: ``Posterior_Sampling_Convergence`` Implements a class that provides convergence criteria for posterior sampling simulations. See :ref:`physics-cosmologyFunctions`. .. _module-posterior_sampling_prop_size_temp_exp: ``Posterior_Sampling_Prop_Size_Temp_Exp`` Implements algorithms for the temperature exponent of proposal size in tempered differential evolution algorithms. See :ref:`physics-cosmologyFunctions`. .. _module-posterior_sampling_simulation: ``Posterior_Sampling_Simulation`` Implements a class of posterior sampling simulators. See :ref:`physics-cosmologyFunctions`. .. _module-posterior_sampling_state: ``Posterior_Sampling_State`` Implements a class that maintains during posterior sampling. See :ref:`physics-cosmologyFunctions`. .. _module-posterior_sampling_state_initialize: ``Posterior_Sampling_State_Initialize`` Implements a class for posterior sampling state initialization. See :ref:`physics-cosmologyFunctions`. .. _module-posterior_sampling_state_samples: ``Posterior_Sampling_State_Samples`` Implements a class that returns lists of states at which to sample the posterior. See :ref:`physics-cosmologyFunctions`. .. _module-posterior_sampling_stopping_criteria: ``Posterior_Sampling_Stopping_Criteria`` Implements a stopping criteria class for constraint simulations. See :ref:`physics-cosmologyFunctions`. .. _module-power_spectra: ``Power_Spectra`` Implements linear-theory power spectra. See :ref:`physics-cosmologyFunctions`. .. _module-power_spectra_nonlinear: ``Power_Spectra_Nonlinear`` Implements the nonlinear power spectrum. See :ref:`physics-cosmologyFunctions`. .. _module-power_spectra_primordial: ``Power_Spectra_Primordial`` Provides a class that implements the primordial power spectrum. See :ref:`physics-cosmologyFunctions`. .. _module-power_spectra_primordial_transferred: ``Power_Spectra_Primordial_Transferred`` Provides a class that implements the transferred primordial power spectrum. See :ref:`physics-cosmologyFunctions`. .. _module-power_spectrum_window_functions: ``Power_Spectrum_Window_Functions`` Provides a class which implements window functions for computing the variance of the power spectrum. See :ref:`physics-cosmologyFunctions`. .. _module-radiation_fields: ``Radiation_Fields`` Implements a class to describe radiation fields. See :ref:`physics-cosmologyFunctions`. .. _module-radiative_transfer_convergences: ``Radiative_Transfer_Convergences`` Provides a class that implements convergence criteria for radiative transfer calculations. See :ref:`physics-cosmologyFunctions`. .. _module-radiative_transfer_matters: ``Radiative_Transfer_Matters`` Provides a class that implements matter types for radiative transfer calculations. See :ref:`physics-cosmologyFunctions`. .. _module-radiative_transfer_outputters: ``Radiative_Transfer_Outputters`` Provides a class that implements outputters for radiative transfer calculations. See :ref:`physics-cosmologyFunctions`. .. _module-radiative_transfer_photon_packet: ``Radiative_Transfer_Photon_Packet`` Provides a class that implements photon packets for radiative transfer calculations. See :ref:`physics-cosmologyFunctions`. .. _module-radiative_transfer_sources: ``Radiative_Transfer_Sources`` Provides a class that implements photon sources for radiative transfer calculations. See :ref:`physics-cosmologyFunctions`. .. _module-radiative_transfer_spectra: ``Radiative_Transfer_Spectra`` Provides a class that implements spectra for radiative transfer calculations. See :ref:`physics-cosmologyFunctions`. .. _module-ram_pressure_stripping_mass_loss_rate: ``Ram_Pressure_Stripping_Mass_Loss_Rate`` Provides a class that implements calculations of ram pressure stripping. See :ref:`physics-cosmologyFunctions`. .. _module-regular_expressions: ``Regular_Expressions`` Implements regular expressions by wrapping the GNU C Library implementations. .. _module-resource_manager: ``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++. .. _module-root_finder: ``Root_Finder`` Implements root finding. .. _module-satellite_deceleration_sidm: ``Satellite_Deceleration_SIDM`` Implements calculation of the deceleration of orbiting satellites due to dark matter self-interactions. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_dynamical_friction: ``Satellite_Dynamical_Friction`` Implements calculations of dynamical friction for satellites. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_evaporation_sidm: ``Satellite_Evaporation_SIDM`` Implements calculation of the evaporation of orbiting satellites due to dark matter self-interactions. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_merging_mass_movements: ``Satellite_Merging_Mass_Movements`` Implements a class for determining how mass is moved around as a consequence of a satellite merging event. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_merging_progenitor_properties: ``Satellite_Merging_Progenitor_Properties`` Implements a class for calculations for progenitor properties for mergers. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_merging_remnant_sizes: ``Satellite_Merging_Remnant_Sizes`` Implements a class for calculations of merger remnant sizes. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_merging_timescales: ``Satellite_Merging_Timescales`` Provides and object that implements satellite merging timescales. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_oprhan_distributions: ``Satellite_Oprhan_Distributions`` Provides a class for dark matter halo spin distributions. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_orbits: ``Satellite_Orbits`` Implements calculations related to satellite orbits. .. _module-satellite_promotion: ``Satellite_Promotion`` Handles events where a satellite is moved to a new host halo. .. _module-satellite_tidal_heating: ``Satellite_Tidal_Heating`` Implements a class for calculations of tidal heating for satellites. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_tidal_stripping: ``Satellite_Tidal_Stripping`` Provides a class to perform calculations of the mass loss rate due to tidal stripping for satellites. See :ref:`physics-cosmologyFunctions`. .. _module-satellite_tidal_stripping_radii: ``Satellite_Tidal_Stripping_Radii`` Provides a class to perform calculations of the tidal stripping radius for satellites. See :ref:`physics-cosmologyFunctions`. .. _module-satellites_bound_mass_initialize: ``Satellites_Bound_Mass_Initialize`` Implements a class for initializing the bound mass of satellite halos. See :ref:`physics-cosmologyFunctions`. .. _module-satellites_tidal_fields: ``Satellites_Tidal_Fields`` Implements calculations of tidal fields acting on satellites. See :ref:`physics-cosmologyFunctions`. .. _module-shocks_1d: ``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. .. _module-sidm_parametric_model: ``SIDM_Parametric_Model`` Implements the fitting functions of the parametric self-interacting dark matter model of :cite:t:`yang_parametric_2024`. .. _module-sorting: ``Sorting`` Implements sorting. .. _module-sorting_topological: ``Sorting_Topological`` Implements topological sorting. .. _module-spherical_collapse_solvers: ``Spherical_Collapse_Solvers`` Provides a class implementing solvers for collapse of spherical perturbations. See :ref:`physics-cosmologyFunctions`. .. _module-star_formation_active_masses: ``Star_Formation_Active_Masses`` Provides a class that implements calculations of active masses for star formation. See :ref:`physics-cosmologyFunctions`. .. _module-star_formation_histories: ``Star_Formation_Histories`` Implements a class for computation and output of star formation histories for galaxies. See :ref:`physics-cosmologyFunctions`. .. _module-star_formation_rate_krumholz2009_utilities: ``Star_Formation_Rate_Krumholz2009_Utilities`` Implements various useful utility functions for calculations for the :cite:t:`krumholz_star_2009` star formation surface density rate law. .. _module-star_formation_rate_surface_density_disks: ``Star_Formation_Rate_Surface_Density_Disks`` Provides a class that implements surface density rates of star formation in disks. See :ref:`physics-cosmologyFunctions`. .. _module-star_formation_rates_disks: ``Star_Formation_Rates_Disks`` Provides a class that implements calculations of rates of formation in disks. See :ref:`physics-cosmologyFunctions`. .. _module-star_formation_rates_nuclear_star_clusters: ``Star_Formation_Rates_Nuclear_Star_Clusters`` Provides a class that implements calculations of rates of formation in nuclear star clusters. See :ref:`physics-starFormationRateNuclearStarClusters`. .. _module-star_formation_rates_spheroids: ``Star_Formation_Rates_Spheroids`` Provides a class that implements calculations of rates of formation in spheroids. See :ref:`physics-cosmologyFunctions`. .. _module-star_formation_timescales: ``Star_Formation_Timescales`` Provides a class that implements calculations of timescales for star formation. See :ref:`physics-cosmologyFunctions`. .. _module-state: ``State`` Implements storage and recovery of the Galacticus internal state. Used for restoring random number generator sequences for example. .. _module-stateful_types: ``Stateful_Types`` Contains stateful types. .. _module-statistics_points_correlations: ``Statistics_Points_Correlations`` Compute correlation statistics from point distributions. .. _module-statistics_points_power_spectra: ``Statistics_Points_Power_Spectra`` Compute power spectra from point distributions. .. _module-statistics_variograms: ``Statistics_Variograms`` Implements variogram models for Gaussian Process regression. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_astrophysics: ``Stellar_Astrophysics`` Implements a class for calculations of stellar astrophysics. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_astrophysics_tracks: ``Stellar_Astrophysics_Tracks`` Implements a class for stellar tracks. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_astrophysics_winds: ``Stellar_Astrophysics_Winds`` Implements a class for calculations of stellar winds. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_feedback: ``Stellar_Feedback`` Implements a class that performs calculations of stellar feedback. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_feedback_outflows: ``Stellar_Feedback_Outflows`` Provides a class that implements ejective stellar feedback. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_luminosities_data: ``Stellar_Luminosities_Data`` Holds data for the stellar luminosities class. .. _module-stellar_luminosities_initialization: ``Stellar_Luminosities_Initialization`` Initializes data for the stellar luminosities class. .. _module-stellar_luminosities_structure: ``Stellar_Luminosities_Structure`` Defines the stellar luminosities object. .. _module-stellar_population_broad_band_luminosities: ``Stellar_Population_Broad_Band_Luminosities`` Provides a class that implements broad band luminosities of stellar populations. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_population_properties: ``Stellar_Population_Properties`` Implements a class for computing properties of stellar populations. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_population_selectors: ``Stellar_Population_Selectors`` Implements a class for selecting stellar populations. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_population_spectra: ``Stellar_Population_Spectra`` Provides a class implementing stellar population spectra. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_population_spectra_postprocess: ``Stellar_Population_Spectra_Postprocess`` Implements a class for stellar spectra postprocessors. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_populations: ``Stellar_Populations`` Implements a class for stellar populations. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_populations_initial_mass_functions: ``Stellar_Populations_Initial_Mass_Functions`` Implements a class for stellar initial mass functions. See :ref:`physics-cosmologyFunctions`. .. _module-stellar_spectra_dust_attenuations: ``Stellar_Spectra_Dust_Attenuations`` Provides a class implementing dust attenuation of stellar spectra. See :ref:`physics-cosmologyFunctions`. .. _module-string_handling: ``String_Handling`` Implements various useful functionality for manipulating character strings. .. _module-struve_functions: ``Struve_Functions`` Implements Struve functions. .. _module-supernovae_population_iii: ``Supernovae_Population_III`` Implements a class for calculations of Population III supernovae. See :ref:`physics-cosmologyFunctions`. .. _module-supernovae_type_ia: ``Supernovae_Type_Ia`` Implements a class for calculations of Type Ia supernovae. See :ref:`physics-cosmologyFunctions`. .. _module-system_command: ``System_Command`` Executes system commands. .. _module-system_compilers: ``System_Compilers`` Provides compiler commands. .. _module-system_download: ``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. .. _module-system_limits: ``System_Limits`` Set resource limits. .. _module-system_which: ``System_Which`` Wraps the system ``which`` command to allow finding of other tools. .. _module-table_labels: ``Table_Labels`` Defines labels for the ``table`` class. .. _module-tables: ``Tables`` Defines a ``table`` class with optimized interpolation operators. .. _module-task_evolve_forests_work_shares: ``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 :ref:`physics-cosmologyFunctions`. .. _module-tasks: ``Tasks`` Provides a class that implements general tasks to be performed by Galacticus. See :ref:`physics-cosmologyFunctions`. .. _module-tasks_evolve_forests_utilities: ``Tasks_Evolve_Forests_Utilities`` Provides globally-accessible functions supporting the ``evolveForests`` task class. .. _module-tensors: ``Tensors`` Defines the structure used for describing tensors. .. _module-test_debugging_functions: ``Test_Debugging_Functions`` Contains functions used in debugging tests. .. _module-test_differentiation_functions: ``Test_Differentiation_Functions`` Contains functions for differentiation unit tests. .. _module-test_integration2_functions: ``Test_Integration2_Functions`` Contains integrands for unit tests. .. _module-test_integration2d_functions: ``Test_Integration2D_Functions`` Provides simple analytic test integrand functions used by the two-dimensional integration unit tests. .. _module-test_integration_functions: ``Test_Integration_Functions`` Contains integrands for unit tests. .. _module-test_multidimensional_minimizer_functions: ``Test_Multidimensional_Minimizer_Functions`` Contains functions for root finding unit tests. .. _module-test_nodes_tasks: ``Test_Nodes_Tasks`` Implements a simple test of mapping a function over all components in a :term:`node`. .. _module-test_ode_solver_functions: ``Test_ODE_Solver_Functions`` Contains ODEs for unit tests. .. _module-test_resource_manager_wrapper: ``Test_Resource_Manager_Wrapper`` Provides a wrapper class for testing the ``resourceManager`` class. .. _module-test_root_finding_functions: ``Test_Root_Finding_Functions`` Contains functions for root finding unit tests. .. _module-tests_event_hook_functions: ``Tests_Event_Hook_Functions`` Module providing functions used in testing the functionality of the event hook infrastructure. .. _module-thermodynamics_radiation: ``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. .. _module-tidal_stripping_mass_loss_rate: ``Tidal_Stripping_Mass_Loss_Rate`` Provides a class that implements calculations of tidal stripping. See :ref:`physics-cosmologyFunctions`. .. _module-timers: ``Timers`` Implements timers. .. _module-transfer_functions: ``Transfer_Functions`` Provides an object that implements transfer functions. See :ref:`physics-cosmologyFunctions`. .. _module-trigonometric_functions: ``Trigonometric_Functions`` Implements trigonometric functions. .. _module-unit_tests: ``Unit_Tests`` Implements unit testing. .. _module-units_metadata: ``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. .. _module-universe_operators: ``Universe_Operators`` Provides a class that implements operators on universes. See :ref:`physics-cosmologyFunctions`. .. _module-vectors: ``Vectors`` Implements calculations of vectors. .. _module-virial_density_contrast: ``Virial_Density_Contrast`` Provides a class implementing the virial density contrast for halos. See :ref:`physics-cosmologyFunctions`. .. _module-virial_density_contrast_percolation_utilities: ``Virial_Density_Contrast_Percolation_Utilities`` Provides utilities needed by the ``percolation`` virial density contrast class. .. _module-virial_orbits: ``Virial_Orbits`` Provides a class implementing satellite orbital parameters at virial radius crossing. See :ref:`physics-cosmologyFunctions`.