CLASSpp Manual
Cosmology reference and developer manual
Loading...
Searching...
No Matches
transfer.h File Reference
#include <string>
#include <vector>
#include "hyperspherical.h"
#include "nonlinear.h"

Go to the source code of this file.

Data Structures

struct  transfers
 
struct  TransferType
 
struct  TransferTimeSampling
 
struct  transfer_workspace
 

Typedefs

using radial_function_type = enum { SCALAR_TEMPERATURE_0, SCALAR_TEMPERATURE_1, SCALAR_TEMPERATURE_2, SCALAR_POLARISATION_E, VECTOR_TEMPERATURE_1, VECTOR_TEMPERATURE_2, VECTOR_POLARISATION_E, VECTOR_POLARISATION_B, TENSOR_TEMPERATURE_2, TENSOR_POLARISATION_E, TENSOR_POLARISATION_B, NC_RSD }
 

Enumerations

enum class  TransferTerm
 
enum class  TransferWindow { none , cmb_lensing , selection , integrated }
 
enum class  TransferSampling { from_perturbations , uniform , logarithmic }
 
enum class  TransferMethod { zero , limber , line_of_sight }
 

Detailed Description

Input data and shared types for transfer functions.


Data Structure Documentation

◆ transfers

struct transfers

Input parameters for transfer functions.

Computed transfer-function tables belong to TransferModule; this structure holds the shared configuration read by InputModule.

Data Fields
double lcmb_rescale = 1.

normally set to one, can be used exceptionally to rescale by hand the CMB lensing potential

double lcmb_tilt = 0.

normally set to zero, can be used exceptionally to tilt by hand the CMB lensing potential

double lcmb_pivot = 0.1

if lcmb_tilt non-zero, corresponding pivot scale

double selection_bias[_SELECTION_NUM_MAX_]

light-to-mass bias; element [0] default 1, rest 0

double selection_magnification_bias[_SELECTION_NUM_MAX_]

magnification bias; default 0

bool has_nz_file = false

Has dN/dz (selection function) input file?

bool has_nz_analytic

Use analytic form for dN/dz (selection function) distribution?

string nz_file_name

dN/dz (selection function) input file name

bool has_nz_evo_file = false

Has dN/dz (evolution function) input file?

bool has_nz_evo_analytic

Use analytic form for dN/dz (evolution function) distribution?

string nz_evo_file_name

dN/dz (evolution function) input file name

string selection_file_name

for selection=tabulated: file with the redshift z in the first column and the selection function dN/dz of each bin in the next ones

vector< double > selection_file_z

for selection=tabulated: redshifts of this file

vector< vector< double > > selection_file_dNdz

for selection=tabulated: selection function of each bin, selection_file_dNdz[bin][index_z]

vector< double > selection_z_min

for selection=tabulated: smallest redshift at which the selection function of each bin is non-zero (one tabulated point before the first non-zero value)

vector< double > selection_z_max

for selection=tabulated: largest redshift at which the selection function of each bin is non-zero (one tabulated point after the last non-zero value)

bool initialise_HIS_cache

only true if we are using CLASS for setting up a cache of HIS structures

short transfer_verbose

flag regulating the amount of information sent to standard output (none if set to zero)

◆ TransferType

struct TransferType

Everything that distinguishes a transfer type X, defined once for all in TransferModule::transfer_type_properties(). The transfer source is $ S^{Y(X)}(k(q),\tau) \, W^X(\tau) \, (k/k_{pivot})^{k_{power}} $ for every type.

Data Fields
TransferTerm term {}

physical contribution

int index_tp = -1

index of the perturbation source Y(X)

int bin = -1

redshift bin (-1 for CMB types)

int l_max = 0

largest multipole needed

radial_function_type radial_type = SCALAR_TEMPERATURE_0

radial function

TransferWindow window_type = TransferWindow::none

kind of window W(tau)

double k_power = 0.

power of the factor (k/k_pivot)

double k_pivot = 1.

pivot of the factor (k/k_pivot)

double l_limber = _HUGE_

the Limber approximation is used for l >= l_limber

double delta_k_neglect = _HUGE_

Delta_l(q)=0 for l < (q-delta_k_neglect) r_a(tau_rec)

double l_half_neglect

if > 0, the margin at l is delta_k_neglect sqrt(l/(l+l_half_neglect))

bool late_source_cut

sources at tau > tau_cut can be neglected for l > ppr->transfer_neglect_late_source

bool full_limber = false

also computed on the full-Limber grid q_limber

int index_ts = -1

index of its time sampling

vector< double > window

W(tau) on this time sampling

◆ TransferTimeSampling

struct TransferTimeSampling

A time sampling of the line-of-sight integrals, shared by all transfer types with an identical sampling, defined once for all in TransferModule::transfer_time_samplings().

Data Fields
vector< double > tau0_minus_tau

sampled values of (tau0-tau), in decreasing order

vector< double > w_trapz

weights of the trapezoidal integration rule

vector< int > index_tau_pt

for each sampled time, index of the perturbation time just before it, for linear interpolation of the perturbation sources

vector< double > weight_tau_pt

corresponding weight of the next perturbation time

double q_max_sampled

largest q at which the sampling resolves the Bessel functions with ppr->selection_sampling_bessel_min points per radian (evenly spaced samplings only); above it, the Limber approximation is used

vector< int > types

the transfer types using this sampling

◆ transfer_workspace

struct transfer_workspace

Structure containing all the quantities that each thread needs to know for computing transfer functions (but that can be forgotten once the transfer functions are known, otherwise they would be stored in the transfer module)

Data Fields
HyperInterpStruct HIS

structure containing all hyperspherical bessel functions (flat case) or all hyperspherical bessel functions for a given value of beta=q/sqrt(|K|) (non-flat case). HIS = Hyperspherical Interpolation Structure.

const HyperInterpStruct * pBIS

pointer to structure containing all the spherical bessel functions of the flat case (used even in the non-flat case, for approximation schemes). pBIS = pointer to Bessel Interpolation Structure.

vector< vector< double > > interpolated_sources

interpolated_sources[index_ic*tp_size+index_tp][index_tau]: perturbation sources interpolated at the current k, on the time sampling of the perturbation module (only allocated for the sources used by some type)

vector< char > is_interpolated

has the previous source been interpolated at the current k?

vector< double > sources

sources[index_n*tau_size_max+index_tau]: transfer source of the n-th (initial condition, type) pair using the current time sampling

vector< TransferMethod > method

method[index_n] for the current l

vector< int > index_tau_max

index_tau_max[index_n]: last sampled time contributing to the line-of-sight integral

vector< char > bessel_truncation

bessel_truncation[index_n]: is the integral truncated by the lower cut of the Bessel function?

vector< double > chi

chi[index_tau]: value of argument of bessel function: k(tau0-tau) (flat case) or sqrt(|K|)(tau0-tau) (non-flat case)

vector< double > cscKgen

cscKgen[index_tau]: useful trigonometric function

vector< double > cotKgen

cotKgen[index_tau]: useful trigonometric function

int bessel_size

Bessel functions of the current (q, l) at the first bessel_size times of the current sampling, interpolated once for all types by transfer_bessel_interpolate(), in reverse order (order of increasing argument): the value at index_tau is at bessel_size-1-index_tau. Buffers of size tau_size_max, allocated once per wavenumber. number of times at which they have been interpolated

double rescale_argument

rescaling of their argument in the flat rescaling approximation (curved space)

vector< double > Phi

Bessel function

vector< double > dPhi

first derivative of Bessel function

vector< double > d2Phi

second derivative of Bessel function

vector< double > chireverse

their argument (curved space)

vector< double > rescale_function

amplitude rescaling of the flat rescaling approximation (curved space)

vector< double > radial_function

radial_function[index_tau]: output of transfer_radial_function

vector< double > chi_full_reverse

workspace: reversed chi array

vector< int > last_nonzero_source

per (initial condition, type) of a time sampling: the last time index at or before i with a nonzero source, or -1

HermiteLocations bessel_location

flat case: where each chi_full_reverse falls in the Bessel table, found once per wavenumber and time sampling and shared by every multipole

double K

curvature parameter (see background module for details)

int sgnK

0 (flat), 1 (positive curvature, spherical, closed), -1 (negative curvature, hyperbolic, open)

double tau0_minus_tau_cut

critical value of (tau0-tau) in time cut approximation for the wavenumber at hand

Typedef Documentation

◆ radial_function_type

using radial_function_type = enum { SCALAR_TEMPERATURE_0, SCALAR_TEMPERATURE_1, SCALAR_TEMPERATURE_2, SCALAR_POLARISATION_E, VECTOR_TEMPERATURE_1, VECTOR_TEMPERATURE_2, VECTOR_POLARISATION_E, VECTOR_POLARISATION_B, TENSOR_TEMPERATURE_2, TENSOR_POLARISATION_E, TENSOR_POLARISATION_B, NC_RSD }

enumeration of possible radial function types (Bessel function or combination of its derivatives) convolved with the transfer source, see transfer_radial_function()

Enumeration Type Documentation

◆ TransferTerm

enum class TransferTerm
strong

The physical contribution carried by a transfer type: a CMB term, or one term of the number counts (see the CLASSgal paper arXiv:1307.1459) or of the galaxy lensing potential in a given redshift bin.

◆ TransferWindow

enum class TransferWindow
strong

The window function W(tau) multiplying the perturbation source of a transfer type.

Enumerator
none 

W=1 (CMB temperature and polarisation)

cmb_lensing 

CMB lensing kernel, with support [tau_rec, tau0]

selection 

selection function of a bin times a function of the background, with the support of the bin

integrated 

selection function of a bin convolved with a kernel, with support [tau_min of the bin, tau0]

◆ TransferSampling

enum class TransferSampling
strong

The ways of sampling a line-of-sight integral in time.

Enumerator
from_perturbations 

the times of the perturbation module larger than tau_min

uniform 

tau_size evenly spaced times between tau_min and tau_max (just tau_min if tau_size=1)

logarithmic 

the times of the perturbation module larger than tau_min as long as their step is smaller than (tau0-tau)*log_step; then this logarithmic step until tau_max; then tau0

◆ TransferMethod

enum class TransferMethod
strong

The ways of computing a transfer function at a given (q, l).

Enumerator
zero 

it vanishes or can be neglected

limber 

Limber approximation

line_of_sight 

line-of-sight integral of the transfer source times a radial function