pm_distBand::getBandEpeak Interface Reference

Generate and return the spectral peak energy parameter of the Band spectral model/distribution from the corresponding spectral break energy \(\ebreak\) and the Band model spectral indices \((\alpha, \beta)\).
More...

Detailed Description

Generate and return the spectral peak energy parameter of the Band spectral model/distribution from the corresponding spectral break energy \(\ebreak\) and the Band model spectral indices \((\alpha, \beta)\).

See the documentation of pm_distBand for more information on the Band distribution.
The break energy of the Band distribution is related to the peak energy via the following relation,

\begin{equation} \epeak = \frac{2 + \alpha}{\alpha - \beta} \ebreak \end{equation}

Parameters

[in]	alpha	: The input scalar or array of the same shape as other array-like arguments, of the same type and kind as ebreak, containing the first shape parameter of the distribution.
[in]	beta	: The input scalar or array of the same shape as other array-like arguments, of the same type and kind as ebreak, containing the second shape parameter of the distribution.
[in]	ebreak	: The input scalar or array of the same shape as other array like arguments, of type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), containing the spectral break energy values.

Returns

epeak : The output scalar or array of the same shape as any input array-like argument, of the same type and kind as the input argument ebreak, containing the peak energy of the distribution.
The output value has the same physical units as the input ebreak.

Possible calling interfaces ⛓

use pm_distBand, only: getBandEpeak
 
epeak = getBandEpeak(alpha, beta, ebreak)

Warning

The condition 0 < ebreak must hold for the corresponding input arguments.
The condition alpha /= -2 must hold for the corresponding input arguments.
The condition beta < alpha must hold for the corresponding input arguments.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

The pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are pure in release build and impure in debug and testing builds.

Remarks

The procedures under discussion are elemental.

See also

getBandUDF
setBandUCDF
setBandMean
getBandZeta
getBandEpeak
getBandEbreak
setBandPhoton
setBandEnergy

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK
    use pm_distBand, only: getBandEpeak
    use pm_distBand, only: getBandEbreak
    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("getBandEpeak(alpha = -1., beta = -3., ebreak = 300.)")
    call disp%show( getBandEpeak(alpha = -1., beta = -3., ebreak = 300.) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getBandEbreak(alpha = -1., beta = -3., epeak = getBandEpeak(alpha = 1., beta = -3., ebreak = 300.))")
    call disp%show( getBandEbreak(alpha = -1., beta = -3., epeak = getBandEpeak(alpha = 1., beta = -3., ebreak = 300.)) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getBandEpeak(alpha = -1., beta = -2., ebreak = [real :: 100, 200, 300])")
    call disp%show( getBandEpeak(alpha = -1., beta = -2., ebreak = [real :: 100, 200, 300]) )
    call disp%skip()
 
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 ⛓

 
getBandEpeak(alpha = -1., beta = -3., ebreak = 300.)
+150.000000
 
 
getBandEbreak(alpha = -1., beta = -3., epeak = getBandEpeak(alpha = 1., beta = -3., ebreak = 300.))
+450.000000
 
 
getBandEpeak(alpha = -1., beta = -2., ebreak = [real :: 100, 200, 300])
+100.000000, +200.000000, +300.000000
 
 

Test:

test_pm_distBand

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, Oct 16, 2009, 11:14 AM, Michigan

Definition at line 237 of file pm_distBand.F90.

---

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

• src/fortran/main/pm_distBand.F90