NcHaloMassFunction

NcHaloMassFunction — Clusters mass function.

Properties

gdouble area Read / Write / Construct
NcDistance * distance Read / Write / Construct Only
gdouble lnMf Read / Write / Construct
gdouble lnMi Read / Write / Construct
NcMultiplicityFunc * multiplicity Read / Write / Construct Only
NcmPowspecFilter * powerspectrum-filtered Read / Write / Construct Only
gdouble prec Read / Write / Construct
gdouble zf Read / Write / Construct
gdouble zi Read / Write / Construct

Types and Values

Object Hierarchy

    GEnum
    ╰── NcHaloMassFunctionSplineOptimize
    GObject
    ╰── NcHaloMassFunction

Description

FIXME

Functions

nc_halo_mass_function_new ()

NcHaloMassFunction *
nc_halo_mass_function_new (NcDistance *dist,
                           NcmPowspecFilter *psf,
                           NcMultiplicityFunc *mulf);

This function allocates memory for a new NcHaloMassFunction object and sets its properties to the values from the input arguments.

Parameters

Returns

A new NcHaloMassFunction.


nc_halo_mass_function_free ()

void
nc_halo_mass_function_free (NcHaloMassFunction *mfp);

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

Parameters


nc_halo_mass_function_clear ()

void
nc_halo_mass_function_clear (NcHaloMassFunction **mfp);

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

Parameters


nc_halo_mass_function_set_area ()

void
nc_halo_mass_function_set_area (NcHaloMassFunction *mfp,
                                gdouble area);

FIXME

Parameters

mfp

a NcHaloMassFunction

 

area

area in steradian

 

nc_halo_mass_function_set_prec ()

void
nc_halo_mass_function_set_prec (NcHaloMassFunction *mfp,
                                gdouble prec);

FIXME

Parameters

mfp

a NcHaloMassFunction

 

prec

precision

 

nc_halo_mass_function_set_area_sd ()

void
nc_halo_mass_function_set_area_sd (NcHaloMassFunction *mfp,
                                   gdouble area_sd);

FIXME

Parameters

mfp

a NcHaloMassFunction

 

area_sd

area in square degree

 

nc_halo_mass_function_set_eval_limits ()

void
nc_halo_mass_function_set_eval_limits (NcHaloMassFunction *mfp,
                                       NcHICosmo *cosmo,
                                       gdouble lnMi,
                                       gdouble lnMf,
                                       gdouble zi,
                                       gdouble zf);

FIXME

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnMi

minimum logarithm base e of mass

 

lnMf

maximum logarithm base e of mass

 

zi

minimum redshift

 

zf

maximum redshift

 

nc_halo_mass_function_prepare ()

void
nc_halo_mass_function_prepare (NcHaloMassFunction *mfp,
                               NcHICosmo *cosmo);

FIXME

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

nc_halo_mass_function_prepare_if_needed ()

void
nc_halo_mass_function_prepare_if_needed
                               (NcHaloMassFunction *mfp,
                                NcHICosmo *cosmo);

FIXME

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

nc_halo_mass_function_lnM_to_lnR ()

gdouble
nc_halo_mass_function_lnM_to_lnR (NcHaloMassFunction *mfp,
                                  NcHICosmo *cosmo,
                                  gdouble lnM);

This function computes the ln-radius of related to the ln-mass $\ln(M / M_\odot)$.

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnM

logarithm base $e$ of the mass enclosed in the filter volume

 

Returns

$\ln(R / 1 \text{Mpc})$


nc_halo_mass_function_lnR_to_lnM ()

gdouble
nc_halo_mass_function_lnR_to_lnM (NcHaloMassFunction *mfp,
                                  NcHICosmo *cosmo,
                                  gdouble lnR);

This function computes the ln-mass of the mass enclosed in the filter volume.

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnR

ln-radius of the related volume

 

Returns

$\ln(M / 1 M_\odot)$


nc_halo_mass_function_dn_dlnR_sigma ()

void
nc_halo_mass_function_dn_dlnR_sigma (NcHaloMassFunction *mfp,
                                     NcHICosmo *cosmo,
                                     gdouble lnR,
                                     gdouble z,
                                     gdouble *sigma_ptr,
                                     gdouble *dn_dlnR_ptr);

This function computes the comoving number density of dark matter halos per redshift z and volume with ln-radius lnR .

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnR

logarithm base e of the radius $R$

 

z

redshift

 

sigma_ptr

matter variance for $\ln(R)$.

[out]

dn_dlnR_ptr

$\frac{\mathrm{d}n}{\mathrm{d}\ln(R)}$.

[out]

nc_halo_mass_function_dn_dlnM_sigma ()

void
nc_halo_mass_function_dn_dlnM_sigma (NcHaloMassFunction *mfp,
                                     NcHICosmo *cosmo,
                                     gdouble lnM,
                                     gdouble z,
                                     gdouble *sigma_ptr,
                                     gdouble *dn_dlnM_ptr);

This function computes the comoving number density of dark matter halos at redshift z and mass M.

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnM

logarithm base e of mass

 

z

redshift

 

sigma_ptr

matter variance for $\ln(M)$.

[out]

dn_dlnM_ptr

$\frac{\mathrm{d}n}{\mathrm{d}\ln(M)}$.

[out]

nc_halo_mass_function_dn_dlnR ()

gdouble
nc_halo_mass_function_dn_dlnR (NcHaloMassFunction *mfp,
                               NcHICosmo *cosmo,
                               gdouble lnR,
                               gdouble z);

This function computes the comoving number density of dark matter halos per redshift z and volume with ln-radius lnR .

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnR

logarithm base e of the radius $R$

 

z

redshift

 

Returns

$\frac{\mathrm{d}n}{\mathrm{d}\ln(R)}$.


nc_halo_mass_function_dn_dlnM ()

gdouble
nc_halo_mass_function_dn_dlnM (NcHaloMassFunction *mfp,
                               NcHICosmo *cosmo,
                               gdouble lnM,
                               gdouble z);

This function computes the comoving number density of dark matter halos at redshift z and mass M.

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnM

logarithm base e of mass

 

z

redshift

 

Returns

$\frac{\mathrm{d}n}{\mathrm{d}\ln(M)}$.


nc_halo_mass_function_dv_dzdomega ()

gdouble
nc_halo_mass_function_dv_dzdomega (NcHaloMassFunction *mfp,
                                   NcHICosmo *cosmo,
                                   gdouble z);

This function computes the comoving volume (flat universe) element per unit solid angle $d\Omega$ given z , namely, $$\frac{\mathrm{d}^2V}{\mathrm{d}z\mathrm{d}\Omega} = \frac{c}{H(z)} D_c^2(z),$$ where $H(z)$ is the Hubble function and $D_c$ is the comoving distance.

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

z

redshift

 

Returns

comoving volume element $\frac{\mathrm{d}^2V}{\mathrm{d}z\mathrm{d}\Omega} \,\left[\mathrm{Mpc}^3\right]$.


nc_halo_mass_function_d2n_dzdlnM ()

gdouble
nc_halo_mass_function_d2n_dzdlnM (NcHaloMassFunction *mfp,
                                  NcHICosmo *cosmo,
                                  gdouble lnM,
                                  gdouble z);

FIXME

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnM

logarithm base e of mass

 

z

redshift

 

Returns

FIXME


nc_halo_mass_function_dn_dz ()

gdouble
nc_halo_mass_function_dn_dz (NcHaloMassFunction *mfp,
                             NcHICosmo *cosmo,
                             gdouble lnMl,
                             gdouble lnMu,
                             gdouble z,
                             gboolean spline);

FIXME

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnMl

logarithm base e of mass, lower threshold

 

lnMu

logarithm base e of mass, upper threshold

 

z

redshift

 

spline

whenever to create an intermediary spline of the mass integration

 

Returns

FIXME


nc_halo_mass_function_n ()

gdouble
nc_halo_mass_function_n (NcHaloMassFunction *mfp,
                         NcHICosmo *cosmo,
                         gdouble lnMl,
                         gdouble lnMu,
                         gdouble zl,
                         gdouble zu,
                         NcHaloMassFunctionSplineOptimize spline);

FIXME

Parameters

mfp

a NcHaloMassFunction

 

cosmo

a NcHICosmo

 

lnMl

logarithm base e of mass, lower threshold

 

lnMu

logarithm base e of mass, upper threshold

 

zl

minimum redshift

 

zu

maximum redshift

 

spline

whenever to create an intermediary spline of the integration

 

Returns

FIXME

Types and Values

enum NcHaloMassFunctionSplineOptimize

FIXME

Members

NC_HALO_MASS_FUNCTION_SPLINE_NONE

FIXME

 

NC_HALO_MASS_FUNCTION_SPLINE_LNM

FIXME

 

NC_HALO_MASS_FUNCTION_SPLINE_Z

FIXME

 

Property Details

The “area” property

  “area”                     gdouble

This property sets the angular area in steradian.

Flags: Read / Write / Construct

Allowed values: [0,12.5664]

Default value: 0.0609235


The “distance” property

  “distance”                 NcDistance *

This property keeps the distance object.

Flags: Read / Write / Construct Only


The “lnMf” property

  “lnMf”                     gdouble

This property sets the maximum halo mass (logarithm base e).

Flags: Read / Write / Construct

Allowed values: [27.5,36.84]

Default value: 36


The “lnMi” property

  “lnMi”                     gdouble

This property sets the minimum halo mass (logarithm base e).

Flags: Read / Write / Construct

Allowed values: [27.5,36.84]

Default value: 32


The “multiplicity” property

  “multiplicity”             NcMultiplicityFunc *

This property keeps the multiplicity function object.

Flags: Read / Write / Construct Only


The “powerspectrum-filtered” property

  “powerspectrum-filtered”   NcmPowspecFilter *

This property keeps the filtered powerspectrum.

Flags: Read / Write / Construct Only


The “prec” property

  “prec”                     gdouble

This property sets the precision.

Flags: Read / Write / Construct

Allowed values: [2.22045e-16,1]

Default value: 1e-06


The “zf” property

  “zf”                       gdouble

This property sets the final redshift.

Flags: Read / Write / Construct

Allowed values: [0,2]

Default value: 1.4


The “zi” property

  “zi”                       gdouble

This property sets the initial redshift.

Flags: Read / Write / Construct

Allowed values: [0,2]

Default value: 0