.. _physics-satelliteMassBoundInitializor:

Satellite Bound Mass Initializor
================================

Class providing the initial bound mass of satellite halos when they first become satellites.

**Default implementation:** ``satelliteMassBoundInitializorBasicMass``

Methods
-------

``massBound`` → ``double precision``
   Returns the initial bound mass of the satellite halo associated with ``node`` (in units of :math:`\mathrm{M}_\odot`).

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

.. _physics-satelliteMassBoundInitializorBasicMass:

``satelliteMassBoundInitializorBasicMass``
------------------------------------------

A satellite bound mass initializor class that sets the initial bound mass of the satellite halo to the basic node mass, i.e.\ the total mass of the halo at the time it becomes a satellite.

**(Default implementation)**

**Parameters**

* ``[massThreshold]`` — The parameter :math:`M_0` (in units of :math:`\mathrm{M}_\odot`) appearing in the basic mass threshold for the basic mass galactic filter class.

.. _physics-satelliteMassBoundInitializorDensityContrast:

``satelliteMassBoundInitializorDensityContrast``
------------------------------------------------

A satellite bound mass initializor class that sets the initial bound mass of the satellite halo to the mass enclosed within the radius defined by a given density contrast. The density contrast is evaluated using the :galacticus-class:`virialDensityContrastClass` object specified by ``[virialDensityContrastDefinition]``, and the mass is computed using the ``Dark_Matter_Profile_Mass_Definition`` function, which accounts for the halo density profile.

.. _physics-satelliteMassBoundInitializorMaximumRadius:

``satelliteMassBoundInitializorMaximumRadius``
----------------------------------------------

A satellite bound mass initializor class that sets the initial bound mass of the satellite halo by integrating its density profile up to a maximum radius, :math:`r_\mathrm{max} =`\ ``[radiusMaximumOverRadiusVirial]`` :math:`\times r_\mathrm{virial}`. The density profile is assumed to be zero beyond this maximum radius.

**Parameters**

* ``[radiusMaximumOverRadiusVirial]`` (default ``1.0d0``) — The maximum radius of the satellite halo in units of its virial radius. This value will be used to compute the initial bound mass of the satellite halo by integrating the density profile up to this maximum radius, assuming that the density profile is zero beyond this radius.