NcMultiplicityFunc

NcMultiplicityFunc — Dark matter halo multiplicity function.

Functions

Properties

double Delta Read / Write / Construct
NcMultiplicityFuncMassDef mass-def Read / Write / Construct

Types and Values

Object Hierarchy

    GEnum
    ╰── NcMultiplicityFuncMassDef
    GObject
    ╰── NcMultiplicityFunc
        ├── NcMultiplicityFuncBocquet
        ├── NcMultiplicityFuncCrocce
        ├── NcMultiplicityFuncJenkins
        ├── NcMultiplicityFuncPS
        ├── NcMultiplicityFuncST
        ├── NcMultiplicityFuncTinker
        ├── NcMultiplicityFuncTinkerMeanNormalized
        ├── NcMultiplicityFuncWarren
        ╰── NcMultiplicityFuncWatson

Description

The multiplicity function comprises information about the non-linear regime of halo (structure) formation. The mass function can be written as \begin{equation}\label{def:multip} \frac{dn (M,z)}{d\ln M} = - \frac{\rho_m (z)}{M} f(\sigma_R, z) \frac{1}{\sigma_R} \frac{d\sigma_R}{d\ln M}, \end{equation} where $\rho_m(z)$ is the mean matter density at redshift $z$, $f(\sigma_R, z)$ is the multiplicity function, and $\sigma_R$ is the variance of the linear density contrast filtered on the length scale $R$ associated to the mass $M$.

Functions

nc_multiplicity_func_free ()

void
nc_multiplicity_func_free (NcMultiplicityFunc *mulf);

Atomically decrements the reference count of mulf by one. If the reference count drops to 0, all memory allocated by mulf is released.

Parameters

mulf

a NcMultiplicityFunc

 

nc_multiplicity_func_clear ()

void
nc_multiplicity_func_clear (NcMultiplicityFunc **mulf);

Atomically decrements the reference count of mulf by one. If the reference count drops to 0, all memory allocated by mulf is released. Set pointer to NULL.

Parameters

mulf

a NcMultiplicityFunc

 

nc_multiplicity_func_set_mdef ()

void
nc_multiplicity_func_set_mdef (NcMultiplicityFunc *mulf,
                               NcMultiplicityFuncMassDef mdef);

Sets the mass definition to mdef.

[virtual set_mdef]

Parameters


nc_multiplicity_func_set_Delta ()

void
nc_multiplicity_func_set_Delta (NcMultiplicityFunc *mulf,
                                gdouble Delta);

Sets the Delta for mean or matter mass definition to mdef.

[virtual set_Delta]

Parameters

mulf

a NcMultiplicityFunc

 

Delta

the $Delta$ value

 

nc_multiplicity_func_get_Delta ()

gdouble
nc_multiplicity_func_get_Delta (NcMultiplicityFunc *mulf);

Gets the Delta Value.

[virtual get_Delta]

Parameters

mulf

a NcMultiplicityFunc

 

Returns

Delta.


nc_multiplicity_func_get_matter_Delta ()

gdouble
nc_multiplicity_func_get_matter_Delta (NcMultiplicityFunc *mulf,
                                       NcHICosmo *cosmo,
                                       gdouble z);

Gets the Delta Value with the matter density definition.

[virtual get_matter_Delta]

Parameters

mulf

a NcMultiplicityFunc

 

cosmo

a NcHICosmo

 

z

the redshift $z$

 

Returns

Delta.


nc_multiplicity_func_get_mdef ()

NcMultiplicityFuncMassDef
nc_multiplicity_func_get_mdef (NcMultiplicityFunc *mulf);

Gets the mass definition.

[virtual get_mdef]

Parameters

mulf

a NcMultiplicityFunc

 

Returns

mdef.


nc_multiplicity_func_eval ()

gdouble
nc_multiplicity_func_eval (NcMultiplicityFunc *mulf,
                           NcHICosmo *cosmo,
                           gdouble sigma,
                           gdouble z);

FIXME

[virtual eval]

Parameters

mulf

a NcMultiplicityFunc

 

cosmo

a NcHICosmo

 

sigma

standard fluctuation of the matter density contrast

 

z

redshift

 

Returns

FIXME


nc_multiplicity_func_has_correction_factor ()

gboolean
nc_multiplicity_func_has_correction_factor
                               (NcMultiplicityFunc *mulf);

Checks if the multiplicity function has a correction factor, e.g., NcMultiplicityFuncBocquet (when using matter density).

[virtual has_correction_factor]

Parameters

mulf

a NcMultiplicityFunc

 

Returns

a gboolean


nc_multiplicity_func_correction_factor ()

gdouble
nc_multiplicity_func_correction_factor
                               (NcMultiplicityFunc *mulf,
                                NcHICosmo *cosmo,
                                gdouble sigma,
                                gdouble z,
                                gdouble lnM);

FIXME

[virtual correction_factor]

Parameters

mulf

a NcMultiplicityFunc

 

cosmo

a NcHICosmo

 

sigma

standard fluctuation of the matter density contrast

 

z

redshift

 

lnM

logarithm base e of the mass

 

Returns

FIXME

Types and Values

enum NcMultiplicityFuncMassDef

Spherical overdensity halo mass: $$M_\Delta = \frac{4\pi}{3} \Delta \rho_\mathrm{bg} r_\Delta^3,$$ where $\rho_\mathrm{bg}$ is the background density of the universe at redshift z, $\rho_\mathrm{bg} (z)$. For NC_HALO_DENSITY_PROFILE_MASS_DEF_VIRIAL , the parameter “log10MDelta” is ignored and \begin{equation}\label{def:DVir} \Delta_\mathrm{Vir} = 18 \pi^2 + 82 x - 39 x^2, \quad x \equiv \Omega_m(z) - 1. \end{equation}

Members

NC_MULTIPLICITY_FUNC_MASS_DEF_MEAN

halo mass defined in terms of the mean density $\rho_\mathrm{bg} = \rho_m(z)$

 

NC_MULTIPLICITY_FUNC_MASS_DEF_CRITICAL

halo mass defined in terms of the critical density $\rho_\mathrm{bg} = \rho_\mathrm{crit}(z)$

 

NC_MULTIPLICITY_FUNC_MASS_DEF_VIRIAL

halo mass defined in terms of virial overdensity times the critical density $\rho_\mathrm{bg} = \rho_\mathrm{crit

 

NC_MULTIPLICITY_FUNC_MASS_DEF_FOF

friends of friends

 

NC_MULTIPLICITY_FUNC_DELTA_C0

#define NC_MULTIPLICITY_FUNC_DELTA_C0 (1.6864701998411454502)

Property Details

The “Delta” property

  “Delta”                    double

Delta.

Owner: NcMultiplicityFunc

Flags: Read / Write / Construct

Allowed values: >= 1

Default value: 200


The “mass-def” property

  “mass-def”                 NcMultiplicityFuncMassDef

It refers to the halo finder used to obtain the multiplicity function (e.g., SO and FoF), and the background density $\rho_\mathrm{bg}$ used in the mass definition \eqref{eq:mrr}. See the enumerator NcMultiplicityFuncMassDef for more details about the background density definition.

Owner: NcMultiplicityFunc

Flags: Read / Write / Construct

Default value: NC_MULTIPLICITY_FUNC_MASS_DEF_MEAN