Tinker10

class hmf.mass_function.fitting_functions.Tinker10(**model_parameters)[source]

Tinker10 mass function fit.

For details on attributes, see documentation for BaseFittingFunction.

Parameters:

  • nu2 (array_like) – A vector of peak-heights, \(\delta_c^2/\sigma^2\) corresponding to m

  • m (array_like, optional) – A vector of halo masses [units M_sun/h]. Only necessary if req_mass is True. Typically provides limits of applicability. Must correspond to nu2.

  • z (float, optional) – The redshift. Only used by models that depend on redshift. Default is 0.

  • n_eff (array_like, optional) – The effective spectral index at m. Only required if req_neff is True.

  • mass_definition (hmf.halos.mass_definitions.MassDefinition instance) – A halo mass definition. Only required for fits which explicitly include a parameterization for halo definition.

  • cosmo (astropy.cosmology.FLRW instance, optional) – A cosmology. Default is hmf.cosmology.cosmo.DEFAULT_COSMOLOGY (Planck18), as for the frameworks. Either omegam_z or cosmo is required if req_omz is True. If both are passed, omegam_z takes precedence.

  • **model_parameters (unpacked-dictionary) – These parameters are model-specific. The available parameters and their defaults are listed in the Notes section of each model (and are also available as <model>._defaults).

Notes

The Tinker10 [1] form is:

\[f_{\rm Tkr}(\sigma) = (1+(\beta\nu)^{-2\phi})\nu^{2\eta+1}\exp(-\gamma\nu^2/2)\]

Default model parameters (override them with keyword arguments, or with hmf_params in MassFunction):

Parameter

Default

alpha_200

0.368

alpha_300

0.363

alpha_400

0.385

alpha_600

0.389

alpha_800

0.393

alpha_1200

0.365

alpha_1600

0.379

alpha_2400

0.355

alpha_3200

0.327

beta_200

0.589

beta_300

0.585

beta_400

0.544

beta_600

0.543

beta_800

0.564

beta_1200

0.623

beta_1600

0.637

beta_2400

0.673

beta_3200

0.702

gamma_200

0.864

gamma_300

0.922

gamma_400

0.987

gamma_600

1.09

gamma_800

1.2

gamma_1200

1.34

gamma_1600

1.5

gamma_2400

1.68

gamma_3200

1.81

phi_200

-0.729

phi_300

-0.789

phi_400

-0.91

phi_600

-1.05

phi_800

-1.2

phi_1200

-1.26

phi_1600

-1.45

phi_2400

-1.5

phi_3200

-1.49

eta_200

-0.243

eta_300

-0.261

eta_400

-0.261

eta_600

-0.273

eta_800

-0.278

eta_1200

-0.301

eta_1600

-0.301

eta_2400

-0.319

eta_3200

-0.336

beta_exp

0.2

phi_exp

-0.08

eta_exp

0.27

gamma_exp

-0.01

max_z

3

References

Attributes

cutmask

Boolean mask of the elements within the fit's calibrated range.

delta_virs

fsigma

The function \(f(\sigma)\equiv\nu f(\nu)\).

lnsigma

Negative log of sigma.

normalized

Whether this model is normalized so that all mass is in halos

nu

The peak height, \(\nu = \delta_c/\sigma\).

omegam_z

Normalised matter density at current redshift.

references

References to cite when this model is used, each a formatted citation string.

req_dhalo

req_mass

Whether m is required for this subclass

req_neff

Whether n_eff is required for this subclass

req_z

sigma

The sqrt of mass variance as a function of mass.

sim_definition

Details of the defining simulation, instance of SimDetails

terminate

Methods

classmethod get_measured_mdef()

Get the mass definition used in the defining simulation.

classmethod get_models() → Mapping[str, type]

Get a read-only mapping of all implemented models for this component.

The mapping is a live view of the registry, so it shows models registered later, but it can not be used to add or remove models.