7.2. Haloes: \(\tt -h\)

Run on (a list of) non-Galactic haloes.

Note

All default parameter files from the following run examples are generated with the -D flag,

$ clumpy -hX -D

7.2.1. Format of halo definition files

All submodules require the definition of the properties of one or more haloes in a separate text file. This halo definition file is called from within the main parameter file or the command line with the parameter gLIST_HALOES (submodules -h0 to -h7) or gLIST_HALOES_JEANS (submodules -h8 to -h10).

  • The gLIST_HALOES is formatted as follows. The example below is given for the Abell 2261 cluster (after CLASH, Coe et al., 2012) with arbitrary triaxiality values. Preformatted example files are also provided with the code in $CLUMPY/data/list_generic.txt and $CLUMPY/data/list_generic_triaxial.txt.

    #*********************************************************************************************************************************************************#
    #                  [OBJECT LOCATION AND SIZE]                |             DM DISTRIBUTION (RHO_TOT)                      [TRIAXIALITY]                   #
    # Name           Type      l       b      d     z   Rdelta   |     rhos       rs     prof.   #1   #2   #3       IsTriaxial  a   b   c   rot1  rot2  rot3  #
    #  -               -     [deg]   [deg]  [kpc]   -    [kpc]   |  [Msol/kpc3]  [kpc]  [enum]    -    -    -           -       -   -   -   [deg] [deg] [deg] #
    #*********************************************************************************************************************************************************#
    
    Abell_2261       CLUSTER  55.56  31.95   -1 0.2249   3e3         7.01e5    652.   kEINASTO   0.17  0   0            0    1.47 1.22 0.74  0.    0.    0.
    
    Parameter Unit Comment
    Name \(\rm -\) Arbitrary name to identify your object
    Type \(\rm -\) DSPH, CLUSTER, or GALAXY (for external galaxies). This keyword decides which values are used to describe the halo substructure, defined in the main parameter file (see Section 9.6)
    l \(\rm deg\) Galactic longitude of position
    b \(\rm deg\) Galactic latitude of position
    d \(\rm kpc\) Distance given as comoving line-of-sight distance, \(d_{\rm c}\)
    z \(\rm -\) Distance given as redshift. Either d or z must be set to -1
    Rdelta \(\rm kpc\) Outer bound of the halo, \(R_{\Delta}\)
    rhos \(\rm M_\odot\,kpc^{-3}\) DM density at the scale radius, \(\rho_{\rm s} = \rho(r_{\rm s})\)
    rs \(\rm kpc\) Scale radius, \(r_{\rm s}\)
    prof. \(\rm -\) Keyword for DM density profile. See Section 10.2 for possible keywords
    #1,#2,#3 \(\rm -\) Shape parameters of the density profile.
    IsTriaxial \(\rm -\) Boolean (1/0) to switch on/off triaxiality of the halo. See Triaxial profiles for details
    a \(\rm -\) 1st axis ratio \(a\) of triaxial halo (if no rotation angle, major along x-axis)
    b \(\rm -\) 2nd axis ratio \(b\) of triaxial halo
    c \(\rm -\) 3rd axis ratio \(c\) of triaxial halo (if no rotation angle, minor along z-axis)
    rot1 \(\rm deg\) 1st rotation angle of triaxial halo, \([-180^\circ,180^\circ]\)
    rot2 \(\rm deg\) 2nd rotation angle of triaxial halo, \([-90^\circ,90^\circ]\)
    rot3 \(\rm deg\) 3rd rotation angle of triaxial halo, \([-180^\circ,180^\circ]\)

    Note

    1. Everything written behind a # (or a blank line) is discarded
    2. A DM shape is always defined by a DM family and three shape parameters (#1,#2,#3). If the chosen profile takes less than three shape parameters, a numeric dummy value has to be assigned to the unnecessary ones. We recommend to set the dummy value to -1, which lets the code check inconsistencies with the substructure description.
    3. Substructure properties must be set in clumpy_params.txt for each object type, see Section 9.6.
    4. \(R_{\Delta}\), \(r_{\rm s}\), and \(\rho_{\rm s}\) have to be provided in comoving coordinates. Although they are given in units of kiloparsecs, all calculations in CLUMPY can also be performed on the Megaparsec scale.
    5. The last 7 parameters for triaxiality are optional, i.e., the file is also read if no values are given, and IsTriaxial is set to False.
  • The gLIST_HALOES_JEANS is formatted as follows. A preformatted example file is also provided with the code in $CLUMPY/data/list_generic_jeans.txt.

    #*************************************************************************************************************************************************************************************#
    #     [OBJECT SIZE]           |           [DATA]           |         DM DISTRIBUTION (RHO_TOT)        |             Light Profile                |        Anisotropy  Profile         #
    # Name    Type   Rdelta Rmax  |    Vel            Light    |  rhos       rs     prof.   #1   #2   #3  |     L        rs*    prof.   #1   #2   #3 | beta_0 beta_inf  prof.   ra   eta  #
    #  -        -    [kpc]  [kpc] |     -               -      |[Msol/kpc3]  [kpc]  [enum]    -    -    - |[Lsol/kpc3]  [kpc]  [enum]    -    -    - |   -       -     [enum]   kpc   -   #
    #*************************************************************************************************************************************************************************************#
    
    Test1     DSPH    10.   500. data_sigmap.txt data_light.txt  5.522e7    1.5   kZHAO    1.0  4.0  1.0  5.522e7      1.5  kZHAO3D  1.0  4.0  1.0     -1.   1.   kCONSTANT   1.0  4.0
    
    Parameter Unit Comment
    Name \(\rm -\) Arbitrary name to identify your object
    Type \(\rm -\) DSPH, CLUSTER, or GALAXY (for external galaxies). This keyword decides which values are used to describe the halo substructure, defined in the main parameter file (see Section 9.6)
    Rdelta \(\rm kpc\) Virial radius of the Dark matter halo (used as truncation radius of the halo for astrophysical factors)
    Rmax \(\rm kpc\) Maximum integration radius for Jeans analysis
    Vel \(\rm -\) Velocity data of the object, if available. File must be in the same folder as this file or given as absolute path. The data are drawn on the canvas, except if the entry is set to -
    Light \(\rm -\) Light data of the object, if available. File must be in the same folder as this file or given as absolute path. The data are drawn on the canvas, except if the entry is set to -
    rhos \(\rm M_\odot\,kpc^{-3}\) DM density at the scale radius, \(\rho_{\rm s} = \rho(r_{\rm s})\)
    rs \(\rm kpc\) Scale radius, \(r_{\rm s}\)
    prof. \(\rm -\) Keyword for DM density profile. See Section 10.2 for possible keywords
    #1,#2,#3 \(\rm -\) Shape parameters of the density profile
    L \(\rm L_\odot\,kpc^{-3}\) Luminosity of a halo (see Section 6.6.4)
    rs* \(\rm kpc\) Scale radius (see Section 6.5)
    prof. \(\rm -\) Light profile. See Light profiles for possible keywords
    #1,#2,#3 \(\rm -\) Shape parameters of light profile
    beta_0 \(\rm deg\) \(\beta_0\)
    beta_inf \(\rm -\) \(\beta_\infty\)
    prof. \(\rm -\) Anisotropy profile. See Anisotropy profiles \beta_{\rm ani}(r) for possible keywords
    ra \(\rm kpc\) \(r_a\)
    eta \(\rm -\) \(\eta\)

    Note

    1. A Light profile is always defined by a Light family, see Light profiles, 3 shape parameters (#1,#2,#3), a normalisation and a scale radius. If the chosen profile takes less than three shape parameters, a numeric dummy value has to be assigned to the unnecessary ones.
    2. An Anisotropy profile is always defined by a Anisotropy family, see Anisotropy profiles \beta_{\rm ani}(r), 4 parameters: \(\beta_0\) (if Constant or Baes profiles), \(\beta_\infty\) (if Baes), scale radius (if Baes or Osipkov), and sharpness of the transition (if Baes).

7.2.2. \(\tt -h0\): mass profiles (1D)

Calculates \(M_{\rm halo}(r)\) in one dimension of all haloes defined in gLIST_HALOES:

$ clumpy -h0 -i clumpy_params_h0.txt
_images/h0D.png

Fig. 7.14 Mass profiles of the haloes in data/list_generic.txt.

Note that triaxial haloes can be studied as well.


7.2.3. \(\tt -h1\): density profiles (1D)

Calculates \(\rho_{\rm halo}(r)\) (smooth, sub-continuum and total) of spherically symmetric haloes defined in gLIST_HALOES in one dimension:

$ clumpy -h1 -i clumpy_params_h1.txt
_images/h1D.png

Fig. 7.15 Density profiles of the haloes in data/list_generic.txt.


7.2.4. \(\tt -h2\): J-factors (1D)

Calculates \(J(\alpha_{\rm int})\) towards a the halo centers defined in gLIST_HALOES. Note that triaxial haloes can be studied as well.

$ clumpy -h2 -i clumpy_params_h2.txt
_images/h2D.png

Fig. 7.16 J-factors (of smooth, sub-continuum and total components) of the haloes in data/list_generic.txt as a function of the integration radius \(\alpha_{\rm int}\) of the search cone \(\Delta\Omega\).

If enabled with the gSIM_IS_WRITE_FLUXMAPS = True, also the corresponding fluxes are calculated. The corresponding ROOT figure is shown in Fig. 6.29.


7.2.5. \(\tt -h3\): \({\rm d}J/{\rm d}\Omega\) (1D)

Calculates \({\rm d}J/{\rm d}\Omega(\theta)\) as a function of the distance \(\theta\) from the centre spherically symmetric haloes defined in gLIST_HALOES.

$ clumpy -h3 -i clumpy_params_h3.txt
_images/h3D.png

Fig. 7.17 \({\rm d}J/{\rm d}\Omega\) (of smooth, sub-continuum and total components) over the distance \(\theta\) from the centers of the haloes in data/list_generic.txt.

If enabled with the gSIM_IS_WRITE_FLUXMAPS=True, also the corresponding intensities are calculated. The corresponding ROOT figure is shown in Fig. 6.30.


7.2.6. \(\tt -h4\): \(\langle J_{\rm pixel}\rangle\) and \(\langle{\rm d}J/{\rm d}\Omega\rangle\) (2D)

$ clumpy -h4 -i clumpy_params_h4.txt
_images/h4D.png

Corresponding flux- and intensity maps for the -h4 and -h5 are calculated with the gSIM_IS_WRITE_FLUXMAPS = True enabled.


7.2.7. \(\tt -h5\): h4 + drawn subhaloes (2D)

$ clumpy -h5 -i clumpy_params_h5.txt
_images/h5D.png

This is figure Fig. 5.3 from the Quick start tutorial.


7.2.8. \(\tt -h6\): \(\alpha_f\) for which \(J_f=f\times J_{\rm max}\)

$ clumpy -h6 -i clumpy_params_h6.txt
....

>>>>> Load $CLUMPY/data/list_generic.txt
  - List of haloes loaded from /home/iwsatlas1/mhuetten/software/clumpy3/data/list_generic.txt
#**********************************************************************************************************#
#                  [OBJECT LOCATION AND SIZE]                |            DM DISTRIBUTION (RHO_TOT)        #
# Name           Type      l       b      d      z   Rdelta  |     rhos       rs    prof.   #1   #2   #3   #
#  -               -     [deg]   [deg]  [kpc]    -   [kpc]   |  [Msol/kpc3]  [kpc] [enum]    -    -    -   #
#**********************************************************************************************************#
rs01_gamma05    kDSPH     +20.0  +20.0    100  0.000     10     1.7e+09      0.1  kZHAO      1    3  0.5
rs10_gamma10    kDSPH    +179.0   +0.0    100  0.000 18.1025     2.5e+07        1  kZHAO      1    3    1
Abell_2261      kCLUSTER  +55.6  +31.9 941045  0.225   3000     7.0e+05      652  kEINASTO 0.17    3    1
#**********************************************************************************************************#
>>>>> Integration angle (in deg) to get J_x=80% of J (insensitive to rhos)
      for all haloes in /home/iwsatlas1/mhuetten/software/clumpy3/data/list_generic.txt

   Halo            d       alpha_100%    J_100%      alpha_x       J_x      as=atan(rs/d) alpha_x/a_s
                 [kpc]       [deg]   [Msol^2/kpc^5]   [deg]   [Msol^2/kpc^5]     [deg]         -
 rs01_gamma05   1.00e+02   1.72e+00     3.21e+11     7.62e-02    2.57e+11       5.73e-02    1.33e+00
 rs10_gamma10   1.00e+02   1.72e+00     4.32e+11     4.33e+00    3.46e+11       5.73e-01    7.55e+00
 Abell_2261     9.41e+05   1.83e-04     3.48e+10     4.72e-02    2.78e+10       3.97e-02    1.19e+00

   [alpha_int(f*Jtot)]  clumpy -h6 -i param_file

7.2.9. \(\tt -h7\): test \(d\) for which \(J_{\rm point-like}\approx J_{\rm full}\)

$ clumpy -h7 -i clumpy_params_h7.txt
....

>>>>> Load $CLUMPY/data/list_generic.txt
  - List of haloes loaded from /home/iwsatlas1/mhuetten/software/clumpy3/data/list_generic.txt
#**********************************************************************************************************#
#                  [OBJECT LOCATION AND SIZE]                |            DM DISTRIBUTION (RHO_TOT)        #
# Name           Type      l       b      d      z   Rdelta  |     rhos       rs    prof.   #1   #2   #3   #
#  -               -     [deg]   [deg]  [kpc]    -   [kpc]   |  [Msol/kpc3]  [kpc] [enum]    -    -    -   #
#**********************************************************************************************************#
rs01_gamma05    kDSPH     +20.0  +20.0    100  0.000     10     1.7e+09      0.1  kZHAO      1    3  0.5
rs10_gamma10    kDSPH    +179.0   +0.0    100  0.000 18.1025     2.5e+07        1  kZHAO      1    3    1
Abell_2261      kCLUSTER  +55.6  +31.9 941045  0.225   3000     7.0e+05      652  kEINASTO 0.17    3    1
#**********************************************************************************************************#
>>>>> Distance [kpc] to set the halo (for alpha_int=0.1 deg)
      for which J(d) = 80% of Jpoint-like (=L/d^2)
      for all haloes in /home/iwsatlas1/mhuetten/software/clumpy3/data/list_generic.txt

   Halo       J_pointlike    J_x        d
                  [Msol^2/kpc^5]      [kpc]
 rs01_gamma05   9.22e-01   9.22e-01  5.73e+07
 rs10_gamma10   2.47e-01   2.47e-01  1.04e+08
 Abell_2261     1.25e+02   1.25e+02  1.40e+10

7.2.10. \(\tt -h8\): \(\sigma_p\) from file (Jeans)

$ clumpy -h8 -i clumpy_params_h8.txt
_images/h8D.png

Fig. 7.18 -h8 output ROOT figure


7.2.11. \(\tt -h9\): \(I(r)\) from file (Jeans)

$ clumpy -h9 -i clumpy_params_h9.txt
_images/h9D.png

Fig. 7.19 -h9 output ROOT figure


7.2.12. \(\tt -h10\): \(\beta_{\rm ani}\) from file (Jeans)

$ clumpy -h10 -i clumpy_params_h10.txt
_images/h10D.png

Fig. 7.20 -h10 output ROOT figure