CLUMPY  Version 2011.09_corr2
Enumerations | Functions | Variables
params.h File Reference

Global parameters declaration/initialisation (Galaxy, DM, Cosmology, SIMU). More...

#include <TApplication.h>
#include <string>
Include dependency graph for params.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum  gENUM_CVIRMVIR {
  kB01_VIR, kENS01_VIR, kNETO07_200, kDUFFY08F_VIR,
  kDUFFY08F_200, kDUFFY08F_MEAN, kETTORI10_200
}
enum  gENUM_GAMMASPECT { kSUSY_BUB98, kSUSY_TO02, kSUSY_BBE08 }
enum  gENUM_PROFILE { kHOST = -1, kZHAO, kEINASTO, kEINASTO_N }
enum  gENUM_TYPEHALOES { kDSPH, kGALAXY, kCLUSTER }

Functions

void load_parameters (string file_name)
int string_to_enum (string par, string card_param)

Variables

const int gN_CVIRMVIR = 7
 Number of $c_{\Delta}-M_{\Delta}$ parameterisations (corresponding names defined in gNAMES_CVIRMVIR)
const int gN_GAMMASPECT = 3
 Number of $\gamma$ spectra parameterisations (corresponding names defined in gNAMES_GAMMASPECT)
const int gN_PROFILE = 3
 Number of DM profile families parameterisations (corresponding names defined in gNAMES_PROFILE)
const int gN_SHAPE_PARAMS = 3
 Number of shape parameters for DM profiles (gENUM_PROFILE)
const int gN_TYPEHALOES = 3
 Number of halo types (corresponding names defined in gNAMES_TYPEHALOES)
const char gNAMES_CVIRMVIR [gN_CVIRMVIR][50]
 $c_{\Delta}-M_{\Delta}$ relationship cards are B01_VIR, ENS01_VIR, and JS00 from here (see here)
const char gNAMES_GAMMASPECT [gN_GAMMASPECT][50]
 $\gamma$-ray spectrum are SUSY_BUB98, SUSY_TO02, and SUSY_BBE08 (see spectra.h)
const char gNAMES_PROFILE [gN_PROFILE][50]
 DM profiles names are ZHAO, EINASTO, and EINASTO_N (see here)
const char gNAMES_TYPEHALOES [gN_TYPEHALOES][50]
 Halo types names are DSPH, GALAXY, and CLUSTER.
double gCOSMO_RHO0_C
 Present day $(z=0)$ critical density of the universe $\rho_c(z=0)=144$ in unit of $M_\odot\,\,kpc^{-3}$ (PDG)
double gCOSMO_OMEGA0_M
 Present day $(z=0)$ pressure-less matter density of the Universe $ \Omega_m = \rho_m/\rho_c \approx 0.26$ (PDG)
double gCOSMO_OMEGA0_LAMBDA
 Present day $(z=0)$ dark energy density of the $\Lambda$-CDM Universe $ \Omega_{\Lambda} \approx 0.74$ (PDG)
int gDM_GAMMARAY_FLAG_SPECTRUM
 Select the DM $\gamma$-ray annihilation spectrum $d\Phi_{\gamma}/dE_{\gamma}$ [gENUM_GAMMASPECT].
double gDM_MMIN_SUBS
 Minimal mass $M_{min}^{subs}$ of DM structures (free streaming, tidal disruption...) $\in [10^{-10} - 10^4]\,\, M_\odot$ (very uncertain)
double gDM_MMAXFRAC_SUBS
 Maximal mass $M_{max}^{subs}$ of subs defined to be $M_{max}^{subs}=$ gDM_MMAXFRAC_SUBS $ \times M_{tot}^{host}$.
double gDM_RHOSAT
 Saturation density $ \rho_{sat}\approx 3.10^{18} \left(\frac{m_\chi}{100~\rm GeV}\right) \times\left( \frac{10^{-26} {\rm cm}^3~{\rm s}^{-1}}{\langle \sigma v\rangle}\right)\approx 10^{19} M_\odot\,\,kpc^{-3}$ (Berezinskii et al., 1992): high central density not sustainable as overcome by DM annihilations.
int gGAL_CLUMPS_FLAG_CVIRMVIR
 $c_{vir}-M_{vir}$ parameterisation for the Galactic clumps [gENUM_CVIRMVIR]
int gGAL_CLUMPS_FLAG_PROFILE
 Profile of Galactic clumps [gENUM_PROFILE].
double gGAL_CLUMPS_SHAPE_PARAMS [gN_SHAPE_PARAMS]
 Shape parameters for any clump in the Galactic halo ( $(\alpha,-,-)$ for kEINASTO, $(n,-,-)$ kEINASTO_N, or $(\alpha,\beta,\gamma)$ for kZHAO)
double gGAL_DPDM_SLOPE
 Slope of Gal. clumps $d{\cal P}/dM\propto M^{-\alpha_M}$: canonical value is 1.9 (range $[1.7,2.0]$)
int gGAL_DPDV_FLAG_PROFILE
 Spatial distrib. of Gal. clumps [gENUM_PROFILE].
double gGAL_DPDV_RSCALE
 Scale radius [kpc] for the Galactic spatial distribution of clumps.
double gGAL_DPDV_SHAPE_PARAMS [gN_SHAPE_PARAMS]
 $d{\cal P}/dV(r)$ shape parameters for the Galactic clumps ( $(\alpha,-,-)$ for kEINASTO, $(n,-,-)$ kEINASTO_N, or $(\alpha,\beta,\gamma)$ for kZHAO)
double gGAL_SUBS_M1
 Lower end of the mass range [M1,M2] in which gGAL_SUBS_N_INM1M2 Gal. clumps are found $M_\odot$.
double gGAL_SUBS_M2
 Upper end of the mass range [M1,M2] in which gGAL_SUBS_N_INM1M2 Gal. clumps are found $M_\odot$.
int gGAL_SUBS_N_INM1M2
 Number of Gal. sub-halos found in the mass range [M1,M2] = [gGAL_SUBS_M1,gGAL_SUBS_M2].
double gGAL_RHOSOL
 $ \rho_\odot=\rho_{tot}(R_\odot)$ is the local density of dark matter in $M_\odot\,\,kpc^{-3}$ ( $\rho_\odot \sim 0.3~GeV\cdot cm^{-3}$)
double gGAL_RSOL
 $ R_\odot\sim8.0$ kpc, distance Earth - Galactic Center
double gGAL_RVIR
 $ R_{vir}^{gal}\sim 280$ kpc is the virial radius of the dark matter halo of the Galaxy [kpc]
int gGAL_TOT_FLAG_PROFILE
 Total DM profile $\rho_{\rm tot}(r)$ for the Milky-Way [gENUM_PROFILE].
double gGAL_TOT_RSCALE
 Scale radius for the total DM halo of the Milky-Way [kpc].
double gGAL_TOT_SHAPE_PARAMS [gN_SHAPE_PARAMS]
 $\rho_{\rm tot}(r)$ shape parameters for the Galactic total DM halo ( $(\alpha,-,-)$ for kEINASTO, $(n,-,-)$ kEINASTO_N, or $(\alpha,\beta,\gamma)$ for kZHAO)
int gHALO_CLUMPS_FLAG_CVIRMVIR [gN_TYPEHALOES]
 card_cvir $c_{vir}-M_{vir}$ parameterisation [gENUM_CVIRMVIR] for sub-clumps for each halo type (gN_TYPEHALOES)
int gHALO_CLUMPS_FLAG_PROFILE [gN_TYPEHALOES]
 Profile for sub-clumps for each halo type [gENUM_PROFILE].
double gHALO_CLUMPS_SHAPE_PARAMS [gN_TYPEHALOES][gN_SHAPE_PARAMS]
 Shape parameters for sub-clumps for each halo type ( $(\alpha,-,-)$ for kEINASTO, $(n,-,-)$ kEINASTO_N, or $(\alpha,\beta,\gamma)$ for kZHAO)
double gHALO_DPDM_SLOPE [gN_TYPEHALOES]
 Mass distribution slope for each halo type $d{\cal P}/dM\propto M^{-\alpha_M}$: canonical value is 1.9 (range $[1.7,2.0]$)
int gHALO_DPDV_FLAG_PROFILE [gN_TYPEHALOES]
 card_profile (spatial distrib.) for each halo type [gENUM_PROFILE]
double gHALO_DPDV_RSCALE [gN_TYPEHALOES]
 Scale radius [kpc] of dP/dV fr each halo type.
double gHALO_DPDV_SHAPE_PARAMS [gN_TYPEHALOES][gN_SHAPE_PARAMS]
 $d{\cal P}/dV(r)$ shape parameters for each type ( $(\alpha,-,-)$ for kEINASTO, $(n,-,-)$ kEINASTO_N, or $(\alpha,\beta,\gamma)$ for kZHAO)
double gHALO_SUBS_MASSFRACTION [gN_TYPEHALOES]
 Mass fraction in sub-clumps for each type [%].
string gLIST_HALOES
 Relative path to a file containing a list of halos (DSPH, CLUSTER, GALAXY...) and their characteristics.
double gSIMU_ALPHAINT
 Integr. angle $\alpha_{\rm int}$ [rad] corresponding to the solid angle $\Delta\Omega = 2\pi[1-\cos(\alpha_{\rm int})]$.
double gSIMU_EPS
 Relative precision sought for all calculations.
bool gSIMU_IS_ANNIHIL_OR_DECAY
 Calculation is performed for an annihilating DM candidate (if true) or a decaying DM (if false)
bool gSIMU_IS_DISPLAY
 Enables or disables displays (Root CERN graphs) in CLUMPY.
bool gSIMU_IS_PRINT
 Enables or disables print on screen in CLUMPY.
TApplication * gSIMU_ROOTAPP
 ROOT application (mandatory to enable displays) in CLUMPY.
int gSIMU_SEED
 Seed for random number generator. If gSIMU_SEED = 0, seed is chosen from computer clock.

Detailed Description

Global parameters declaration/initialisation (Galaxy, DM, Cosmology, SIMU).

     I. CLUMPY base parameters
     II. Functions

________________________________________


I. CLUMPY base parameters

We sort the parameters in two broad categories.

  1. "Fixed" parameters (for the simulation). They can be actually varied, but unless you have very good reasons to do so (e.g., you find a more recent paper giving slightly different prescriptions for some of them), we advise you to let them as is.
    • Cosmology parameters: $\rho_c(z=0)$, $\rho_m(z=0)$, $\rho_\Lambda(z=0)$ (see references above).
    • Galaxy parameters: $R_\odot$, $R_{vir}^{gal}$, $\rho_\odot$, and the number of DM clumps counted in N-body simulation in a given the mass range.

  2. "Free" parameters (in the simulation).
    • Flags for profiles: chosen among the gENUM_PROFILE (see here).
    • Flags for $c_{vir}(M)$ to be chosen among gENUM_CVIRMVIR (see here).
    • Mass clump parameters: the mass distribution is parametrised as $d{\cal P}/dM\propto M^{-\alpha}$. The parameters are $\alpha$, $M_{\rm min}$, $M_{\rm max}$.
    • Integration angle: $\alpha_{\rm int}$, recalling that the solid angle $d\Omega = d\beta \sin(\alpha) d\alpha$ and $\Omega = 2\pi\cdot(1-\cos(\alpha_{\rm int}))$
    • List of halos: gLIST_HALOES points towards a list of halos that can be used for skymaps, etc.
    • Other simulation parameters: the relative precision reached for all calculation (gSIMU_EPS), and wherever clumps are drawn, the seed gSIMU_SEED.
Remarks:
Here we generically call $r_s$ the scale radius appearing in the different profiles. However, depending on the chosen parameterisation, it can mean $r_s$, $r_{-2}$ or $r_e$ (see here). It is up to the user to check that the values for $r_s$ he/she uses in the input parameter file are 'realistic'. The table here gives some "reasonable" values for the Galactic halo.
________________________________________


II. Functions

  • load_parameters(): loads global parameters gXXX from the parameter file file_name
    Parameters:
    [in]file_nameName of the parameter file (e.g. clumpy_params.txt)

  • string_to_enum(): dummy function to get the integer of an enum from a string
    Parameters:
    [in]parParameter name (string)
    [in]card_paramParameter value (string)
    Returns:
    Integer associated with par in the corresponding gENUM... list

Definition in file params.h.

 All Classes Files Functions Variables Enumerations Enumerator Defines