pm_cosmology::getDisComTransNormed Interface Reference

Generate and return the cosmological Transverse Comoving Distance normalized to Hubble Distance, given the user-specified cosmological parameters. More...

Detailed Description

Generate and return the cosmological Transverse Comoving Distance normalized to Hubble Distance, given the user-specified cosmological parameters.

Assuming \((\Omega_M, \Omega_\Lambda, \Omega_R, \Omega_K)\) represent the normalized densities of Dark Matter, Dark Energy, Radiation Energy, and Curvature in a Universe with negligible neutrino mass such that \(\Omega_M + \Omega_\Lambda + \Omega_R + \Omega_K = 1\), the Comoving Distance between two events at the same redshift or distance but separated on the sky by some angle \(\delta\theta\) is \(D_M\delta\theta\) where \(D_M\) is the Transverse Comoving Distance and is simply related to the line-of-sight Comoving Distance as,

\begin{equation} \large D_M(z; \Omega_M, \Omega_\Lambda, \Omega_R, \Omega_K) = \begin{cases} \frac{D_H}{\sqrt{\Omega_K}} \sinh \bigg( \frac{\sqrt{\Omega_K}}{D_H} D_C \bigg) &, \Omega_K > 0 ~, \\ D_C &, \Omega_K = 0 ~, \\ \frac{D_H}{\sqrt{-\Omega_K}} \sin \bigg( \frac{\sqrt{-\Omega_K}}{D_H} D_C \bigg) &, \Omega_K < 0 ~, \end{cases} \end{equation}

where

1. \(D_C(z)\) is the cosmological line-of-sight Comoving Distance in units of Mpc as a function of redshift,
2. \(z\) is the redshift,
3. \(D_H = \frac{C}{H_0}\) is the Hubble Distance,
4. \(C\) is the speed of light,
5. \(H_0\) is the Hubble Constant.

The value returned by the procedures under this generic interface is \(\frac{D_M}{D_H}\).
The default method of computing the Transverse Comoving Distance is the same as that of the line-of-sight Comoving Distance.

Parameters

[in]	zplus1	: The input scalar or array of the same rank as other array-like arguments, of type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128) representing the redshift plus one, \(\log(z+1)\), at which the Comoving Distance must be computed.
[in]	omegaM	: The input scalar or array of the same rank as other array-like arguments, of the same type and kind as the input argument zplus1 representing the normalized matter density in the universe. (optional, default = OMEGA_M. It must be present if omegaL ( \(\Omega_\Lambda\)) is also present.)
[in]	omegaL	: The input scalar or array of the same rank as other array-like arguments, of the same type and kind as the input argument zplus1 representing the normalized Dark Energy density in the universe. (optional, default = OMEGA_L. It must be present if omegaR is also present.)
[in]	omegaR	: The input scalar or array of the same rank as other array-like arguments, of the same type and kind as the input argument zplus1 representing the normalized radiation density in the universe. (optional, default = OMEGA_R. It must be present if omegaK is also present.)
[in]	omegaK	: The input scalar or array of the same rank as other array-like arguments, of the same type and kind as the input argument zplus1 representing the normalized curvature density of the universe. (optional, default = OMEGA_K)
[in]	sqrtAbsOmegaK	: The input scalar or array of the same rank as other array-like arguments, of the same type and kind as the input argument zplus1 representing the square root of the normalized curvature density of the universe sqrt(omegaK). This argument is requested as an input to avoid the redundant costly sqrt(OmegaK) operation within the algorithm when the procedure is to be called repeatedly with the same omegaK. (optional, it must be present if and only if omegaK is also present.)
[in]	reltol	: See the description of the corresponding argument in the documentation of getQuadErr. A reasonable recommended value is reltol = sqrt(epsilon(real(0, kind(zplus1)))).
[out]	neval	: See the description of the corresponding argument in the documentation of getQuadErr. (optional. If missing, the number of function evaluations will not be returned.)
[out]	err	: The output scalar of type integer of default kind IK, that is set to zero if the integration converges without any errors. Otherwise, a non-zero value of err indicates the occurrence of an error of varying severities. See the description of the corresponding output argument in the documentation of getQuadErr.

Returns

disComTransNormed : The output scalar or array of the same rank as other array-like arguments, of the same type and kind as the input argument zplus1 containing the cosmological Transverse Comoving Distance at the desired redshift normalized to the Hubble Distance.

Possible calling interfaces ⛓

use pm_cosmology, only: getDisComTransNormed
 
disComTransNormed = getDisComTransNormed(zplus1, reltol, neval = neval, err = err)
disComTransNormed = getDisComTransNormed(zplus1, omegaM, omegaL, reltol, neval = neval, err = err)
disComTransNormed = getDisComTransNormed(zplus1, omegaM, omegaL, omegaR, reltol, neval = neval, err = err)
disComTransNormed = getDisComTransNormed(zplus1, omegaM, omegaL, omegaR, omegaK, sqrtAbsOmegaK, reltol, neval = neval, err = err)

Warning

The conditions listed in the documentation of getDisComNormed must hold for this generic interface.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

Remarks

The procedures under discussion are impure.

The procedures under discussion are elemental.

Note

Dropping all optional arguments corresponds to the \(\Lambda\)CDM Universe with the latest experimental parameter inferences.

Setting omegaM = 1 and omegaL = 0 corresponds to the Einstein–de Sitter model of the universe proposed by Albert Einstein and Willem de Sitter in 1932.

See also

getHubbleParamNormedSq
getDisComTransNormed
getDisLumNormed
getDisAngNormed
getDisComNormed
LOG_HUBBLE_CONST
HUBBLE_DISTANCE_MPC
HUBBLE_CONST
OMEGA_M
OMEGA_L
OMEGA_R
OMEGA_K

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK
    use pm_cosmology, only: getDisComTransNormed
    use pm_io, only: display_type
 
    implicit none
 
    type(display_type)      :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("!Compute the Transverse Comoving distance in units of Hubble Distance.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDisComTransNormed(zplus1 = 1., reltol = sqrt(epsilon(0.)))")
    call disp%show( getDisComTransNormed(zplus1 = 1., reltol = sqrt(epsilon(0.))) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDisComTransNormed(zplus1 = 1.1, reltol = sqrt(epsilon(0.)))")
    call disp%show( getDisComTransNormed(zplus1 = 1.1, reltol = sqrt(epsilon(0.))) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDisComTransNormed(zplus1 = [ 2., 3.], omegaM = 0.4, omegaL = 0.6, reltol = 0.0001)")
    call disp%show( getDisComTransNormed(zplus1 = [ 2., 3.], omegaM = 0.4, omegaL = 0.6, reltol = 0.0001) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDisComTransNormed(zplus1 = [ 2., 3.], omegaM = 0.4, omegaL = 0.4, omegaR = 0.2, reltol = 0.0001)")
    call disp%show( getDisComTransNormed(zplus1 = [ 2., 3.], omegaM = 0.4, omegaL = 0.4, omegaR = 0.2, reltol = 0.0001) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDisComTransNormed(zplus1 = [ 2., 3.], omegaM = 0.4, omegaL = 0.4, omegaR = 0.4, omegaK = -0.2, sqrtAbsOmegaK = sqrt(0.2), reltol = 0.0001)")
    call disp%show( getDisComTransNormed(zplus1 = [ 2., 3.], omegaM = 0.4, omegaL = 0.4, omegaR = 0.4, omegaK = -0.2, sqrtAbsOmegaK = sqrt(0.2), reltol = 0.0001) )
    call disp%skip()
 
    ! Generate both the cosmic rate and the rate density.
 
    block
 
        use pm_val2str, only: getStr
        use pm_arraySpace, only: getLinSpace
        use pm_arraySpace, only: getLogSpace
 
        real, allocatable   :: zplus1(:), OmegaM(:), OmegaL(:)
        integer :: fileUnit, i
 
        OmegaM = [0., 0.5, 1.]
        OmegaL = 1. - OmegaM
        zplus1 = 1. + getLogSpace(log(0.0001), log(10000.), 500_IK)
 
        open(newunit = fileUnit, file = "getDisComTransNormed.RK.txt")
        write(fileUnit, "(*(g0,:,','))") "z", ("DisLum_"//getStr(OmegaM(i),"(g0.1)")//"_"//getStr(OmegaL(i),"(g0.1)"), i = 1, size(OmegaM))
        do i = 1, size(zplus1)
            write(fileUnit, "(*(g0,:,','))") zplus1(i) - 1., getDisComTransNormed(zplus1(i), OmegaM, OmegaL, sqrt(epsilon(0.)))
        end do
        close(fileUnit)
 
    end block
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!Compute the Transverse Comoving distance in units of Hubble Distance.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
getDisComTransNormed(zplus1 = 1., reltol = sqrt(epsilon(0.)))
+0.00000000
 
 
getDisComTransNormed(zplus1 = 1.1, reltol = sqrt(epsilon(0.)))
+0.976341516E-1
 
 
getDisComTransNormed(zplus1 = [ 2., 3.], omegaM = 0.4, omegaL = 0.6, reltol = 0.0001)
+0.730347216, +1.11986530
 
 
getDisComTransNormed(zplus1 = [ 2., 3.], omegaM = 0.4, omegaL = 0.4, omegaR = 0.2, reltol = 0.0001)
+0.632169306, +0.903086841
 
 
getDisComTransNormed(zplus1 = [ 2., 3.], omegaM = 0.4, omegaL = 0.4, omegaR = 0.4, omegaK = -0.2, sqrtAbsOmegaK = sqrt(0.2), reltol = 0.0001)
+0.580774844, +0.795633197
 
 

Postprocessing of the example output ⛓

#!/usr/bin/env python
 
import matplotlib.pyplot as plt
import pandas as pd
import numpy as np
import glob
import sys
 
fontsize = 17
 
marker ={ "CK" : "-"
        , "IK" : "."
        , "RK" : "-"
        }
xlab =  { "CK" : "redshift: Z ( real/imaginary components )"
        , "IK" : "redshift: Z ( integer-valued )"
        , "RK" : "redshift: Z ( real-valued )"
        }
legends =   [ "$\Omega_M = 0.0, \Omega_\Lambda = 1.0$"
            , "$\Omega_M = 0.5, \Omega_\Lambda = 0.5$"
            , "$\Omega_M = 1.0, \Omega_\Lambda = 0.0$"
            ]
 
for kind in ["IK", "CK", "RK"]:
 
    pattern = "*." + kind + ".txt"
    fileList = glob.glob(pattern)
    if len(fileList) == 1:
 
        df = pd.read_csv(fileList[0], delimiter = ",")
 
        fig = plt.figure(figsize = 1.25 * np.array([6.4, 4.8]), dpi = 200)
        ax = plt.subplot()
 
        if kind == "CK":
            plt.plot( df.values[:, 0]
                    , df.values[:,1:len(legends)+1]
                    , marker[kind]
                   #, color = "r"
                    )
            plt.plot( df.values[:, 1]
                    , df.values[:,1:len(legends)+1]
                    , marker[kind]
                   #, color = "blue"
                    )
        else:
            plt.plot( df.values[:, 0]
                    , df.values[:,1:len(legends)+1]
                    , marker[kind]
                   #, color = "r"
                    )
            ax.legend   ( legends
                        , fontsize = fontsize
                        )
 
        plt.xticks(fontsize = fontsize - 2)
        plt.yticks(fontsize = fontsize - 2)
        ax.set_xlabel(xlab[kind], fontsize = 17)
        ax.set_ylabel("Comoving Distance / Hubble Distance", fontsize = 17)
        plt.grid(visible = True, which = "both", axis = "both", color = "0.85", linestyle = "-")
        ax.tick_params(axis = "y", which = "minor")
        ax.tick_params(axis = "x", which = "minor")
        ax.set_xscale("log")
        ax.set_yscale("log")
 
        plt.savefig(fileList[0].replace(".txt",".png"))
 
    elif len(fileList) > 1:
 
        sys.exit("Ambiguous file list exists.")

Visualization of the example output ⛓

Test:

test_pm_cosmology

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 1523 of file pm_cosmology.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_cosmology.F90