NcHaloMassFunction: NumCosmo Reference Manual

NcHaloMassFunction

NcHaloMassFunction — Clusters mass function.

Functions

NcHaloMassFunction *	nc_halo_mass_function_new ()
void	nc_halo_mass_function_free ()
void	nc_halo_mass_function_clear ()
void	nc_halo_mass_function_set_area ()
void	nc_halo_mass_function_set_prec ()
void	nc_halo_mass_function_set_area_sd ()
void	nc_halo_mass_function_set_eval_limits ()
void	nc_halo_mass_function_prepare ()
void	nc_halo_mass_function_prepare_if_needed ()
NcmPowspecFilter *	nc_halo_mass_function_peek_psf ()
NcMultiplicityFunc *	nc_halo_mass_function_peek_multiplicity_function ()
gdouble	nc_halo_mass_function_peek_survey_area ()
gdouble	nc_halo_mass_function_lnM_to_lnR ()
gdouble	nc_halo_mass_function_lnR_to_lnM ()
gdouble	nc_halo_mass_function_sigma_lnR ()
gdouble	nc_halo_mass_function_sigma_lnM ()
gdouble	nc_halo_mass_function_dn_dlnR ()
gdouble	nc_halo_mass_function_dn_dlnM ()
gdouble	nc_halo_mass_function_dv_dzdomega ()
gdouble	nc_halo_mass_function_d2n_dzdlnM ()
gdouble	nc_halo_mass_function_dn_dz ()
gdouble	nc_halo_mass_function_n ()

Properties

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

Types and Values

enum	NcHaloMassFunctionSplineOptimize

Object Hierarchy

    GEnum
    ╰── NcHaloMassFunctionSplineOptimize
    GObject
    ╰── NcHaloMassFunction

Description

Class that implements the mass function of clusters dark matter halos.

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

dist	a NcDistance sets to “distance”
psf	a NcmPowspecFilter sets to “powerspectrum-filtered”
mulf	a NcMultiplicityFunc sets to “multiplicity”

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

mfp

a NcHaloMassFunction

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

mfp

a NcHaloMassFunction

nc_halo_mass_function_set_area ()

void
nc_halo_mass_function_set_area (NcHaloMassFunction *mfp,
                                gdouble area);

Sets the area of the survey in steradian.

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);

Sets the precision of the integration.

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);

Sets the area of the survey in square degree.

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);

Sets the limits of the integration.

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);

Prepares the halo mass function object.

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);

Prepare the object if necessary.

Parameters

mfp	a NcHaloMassFunction
cosmo	a NcHICosmo

nc_halo_mass_function_peek_psf ()

NcmPowspecFilter *
nc_halo_mass_function_peek_psf (NcHaloMassFunction *mfp);

Peeks the power spectrum filter.

Parameters

mfp

a NcHaloMassFunction

Returns

the power spectrum filter.

[transfer none]

nc_halo_mass_function_peek_multiplicity_function ()

NcMultiplicityFunc *
nc_halo_mass_function_peek_multiplicity_function
                               (NcHaloMassFunction *mfp);

Peeks the multiplicity function.

Parameters

mfp

a NcHaloMassFunction

Returns

the multiplicity function.

[transfer none]

nc_halo_mass_function_peek_survey_area ()

gdouble
nc_halo_mass_function_peek_survey_area
                               (NcHaloMassFunction *mfp);

Peeks the survey area.

Parameters

mfp

a NcHaloMassFunction

Returns

the survey area.

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 $\ln M$

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 $\ln R$

Returns

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

nc_halo_mass_function_sigma_lnR ()

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

This function computes the matter variance for $\ln R$ = lnR at redshift z .

Parameters

mfp	a NcHaloMassFunction
cosmo	a NcHICosmo
lnR	logarithm base e of the radius $\ln R$
z	redshift $z$

nc_halo_mass_function_sigma_lnM ()

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

This function computes the matter variance for $\ln R$ = lnR at redshift z .

Parameters

mfp	a NcHaloMassFunction
cosmo	a NcHICosmo
lnM	logarithm base e of mass enclosed in the filter volume $\ln M$
z	redshift $z$

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 $\ln R$
z	redshift $z$

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 enclosed in the filter volume $\ln M$
z	redshift $z$

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 element per unit solid angle $d\Omega$ given z . See nc_distance_comoving_volume_element.

Parameters

mfp	a NcHaloMassFunction
cosmo	a NcHICosmo
z	redshift $z$

Returns

the comoving volume element (dimensionless).

nc_halo_mass_function_d2n_dzdlnM ()

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

Computes the halo mass function $d^2 N / d\ln M d z$.

Parameters

mfp	a NcHaloMassFunction
cosmo	a NcHICosmo
lnM	logarithm base e of mass $\ln M$
z	redshift

Returns

$d^2 N / d\ln M d z$.

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);

Computes the number density of halos in the mass range $[M_l, M_u]$ at redshift $z$.

Parameters

mfp	a NcHaloMassFunction
cosmo	a NcHICosmo
lnMl	logarithm base e of mass, lower threshold $\ln M_l$
lnMu	logarithm base e of mass, upper threshold $\ln M_u$
z	redshift $z$
spline	whenever to create an intermediary spline of the mass integration

Returns

the number density of halos in the mass range $[M_l, M_u]$

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 $\ln M_l$
lnMu	logarithm base e of mass, upper threshold $\ln M_u$
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”                     double

This property sets the angular area in steradian.

Owner: NcHaloMassFunction

Flags: Read / Write / Construct

Allowed values: [0,12.5664]

Default value: 0.0609235

The `“distance”` property

  “distance”                 NcDistance *

This property keeps the distance object.

Owner: NcHaloMassFunction

Flags: Read / Write / Construct Only

The `“lnMf”` property

  “lnMf”                     double

This property sets the maximum halo mass (logarithm base e) $\ln M_f$.

Owner: NcHaloMassFunction

Flags: Read / Write / Construct

Allowed values: [25.3284,39.1439]

Default value: 36.8414

The `“lnMi”` property

  “lnMi”                     double

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

Owner: NcHaloMassFunction

Flags: Read / Write / Construct

Allowed values: [25.3284,39.1439]

Default value: 29.9336

The `“mf-lb”` property

  “mf-lb”                    double

Mass function lower bound.

Owner: NcHaloMassFunction

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 1e-30

The `“multiplicity”` property

  “multiplicity”             NcMultiplicityFunc *

This property keeps the multiplicity function object.

Owner: NcHaloMassFunction

Flags: Read / Write / Construct Only

The `“powerspectrum-filtered”` property

  “powerspectrum-filtered”   NcmPowspecFilter *

This property keeps the filtered power spectrum.

Owner: NcHaloMassFunction

Flags: Read / Write / Construct Only

The `“prec”` property

  “prec”                     double

This property sets the precision.

Owner: NcHaloMassFunction

Flags: Read / Write / Construct

Allowed values: [2.22045e-16,1]

Default value: 1e-06

The `“zf”` property

  “zf”                       double

This property sets the final redshift $z_f$.

Owner: NcHaloMassFunction

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 1.4

The `“zi”` property

  “zi”                       double

This property sets the initial redshift $z_i$.

Owner: NcHaloMassFunction

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 0

NcHaloMassFunction

Functions

Properties

Types and Values

Object Hierarchy

Description

Functions

nc_halo_mass_function_new ()

Parameters

Returns

nc_halo_mass_function_free ()

Parameters

nc_halo_mass_function_clear ()

Parameters

nc_halo_mass_function_set_area ()

Parameters

nc_halo_mass_function_set_prec ()

Parameters

nc_halo_mass_function_set_area_sd ()

Parameters

nc_halo_mass_function_set_eval_limits ()

Parameters

nc_halo_mass_function_prepare ()

Parameters

nc_halo_mass_function_prepare_if_needed ()

Parameters

nc_halo_mass_function_peek_psf ()

Parameters

Returns

nc_halo_mass_function_peek_multiplicity_function ()

Parameters

Returns

nc_halo_mass_function_peek_survey_area ()

Parameters

Returns

nc_halo_mass_function_lnM_to_lnR ()

Parameters

Returns

nc_halo_mass_function_lnR_to_lnM ()

Parameters

Returns

nc_halo_mass_function_sigma_lnR ()

Parameters

nc_halo_mass_function_sigma_lnM ()

Parameters

nc_halo_mass_function_dn_dlnR ()

Parameters

Returns

nc_halo_mass_function_dn_dlnM ()

Parameters

Returns

nc_halo_mass_function_dv_dzdomega ()

Parameters

Returns

nc_halo_mass_function_d2n_dzdlnM ()

Parameters

Returns

nc_halo_mass_function_dn_dz ()

Parameters

Returns

nc_halo_mass_function_n ()

Parameters

Returns

Types and Values

enum NcHaloMassFunctionSplineOptimize

Members

Property Details

The “area” property

The “distance” property

The “lnMf” property

The “lnMi” property

The “mf-lb” property

The “multiplicity” property

The “powerspectrum-filtered” property

The “prec” property

The “zf” property

The “zi” property

The `“area”` property

The `“distance”` property

The `“lnMf”` property

The `“lnMi”` property

The `“mf-lb”` property

The `“multiplicity”` property

The `“powerspectrum-filtered”` property

The `“prec”` property

The `“zf”` property

The `“zi”` property