.. _physics-hotHaloColdModeMassDistribution:

Hot Halo Cold Mode Mass Distributions
=====================================

Class providing the radial mass distribution of cold-mode gas in the hot halo, returned as a :galacticus-class:`massDistributionClass` object. In massive halos at high redshift, a fraction of the infalling gas may remain in dense, cold filaments rather than shock-heating to the virial temperature. This class models the spatial distribution of that cold-mode component, which can be compared with the hot halo profile to determine the rate of cold-mode accretion onto the central galaxy.

**Default implementation:** ``hotHaloColdModeMassDistributionBetaProfile``

Methods
-------

``get`` → ``class(massDistributionClass)``
   Return the mass distribution of the hot halo cold mode component.

   * ``type (treeNode ), intent(inout) :: node``

   * ``type (enumerationWeightByType), intent(in ), optional :: weightBy``

   * ``integer , intent(in ), optional :: weightIndex``

.. _physics-hotHaloColdModeMassDistributionBetaProfile:

``hotHaloColdModeMassDistributionBetaProfile``
----------------------------------------------

A hot halo cold mode mass distribution class which adopts a spherically symmetric :math:`\beta`-profile density profile for the hot halo. Specifically,

.. math::

   \rho_\mathrm{hot halo}(r) \propto \left[ r^2 + r_\mathrm{core}^2 \right]^{3\beta/2},

where the core radius, :math:`r_\mathrm{core}`, is set using the selected cored profile core radius method (see :galacticus-class:`hotHaloColdModeCoreRadii`). The value of :math:`\beta` is specified by the ``[beta]`` parameter. The profile is normalized such that the current mass in the hot gas profile is contained within the outer radius of the hot halo, :math:`r_\mathrm{hot, outer}`.

**(Default implementation)**

**Methods**

* ``initialize`` — (Re)initialize the parameters of the :math:`\beta`-profile mass distribution.

**Parameters**

* ``[beta]`` (default ``2.0d0/3.0d0``) — The value of :math:`\beta` in :math:`\beta`-profile hot halo cold mode mass distributions.
* ``[beta]`` (default ``2.0d0/3.0d0``) — The value of :math:`\beta` in :math:`\beta`-profile hot halo mass distributions.
* ``[beta]`` (default ``2.0d0/3.0d0``) — The value :math:`\beta` in a :math:`\beta`-model mass distribution.
* ``[densityNormalization]`` (default ``0.0d0``) — The density normalization of a :math:`\beta`-model mass distribution.
* ``[mass]`` (default ``0.0d0``) — The mass of a :math:`\beta`-model mass distribution.
* ``[outerRadius]`` (default ``0.0d0``) — The outer radius of a :math:`\beta`-model mass distribution.
* ``[coreRadius]`` (default ``0.0d0``) — The core radius of a :math:`\beta`-model mass distribution.
* ``[dimensionless]`` (default ``.false.``) — If true then the :math:`\beta`-model mass distribution is considered to be in dimensionless units.
* ``[truncateAtOuterRadius]`` (default ``.false.``) — If true then the :math:`\beta`-model mass distribution is truncated beyond the outer radius.
* ``[componentType]`` (default ``var_str('unknown')``) — The component type that this mass distribution represents.
* ``[massType]`` (default ``var_str('unknown')``) — The mass type that this mass distribution represents.