distortions.h

Go to the documentation of this file.

 
#ifndef __DISTORTIONS__
#define __DISTORTIONS__
 
#include "arrays.h"
#include "background.h"
#include "thermodynamics.h"
#include "perturbations.h"
#include "primordial.h"
#include "noninjection.h"
 
#define _MAX_DETECTOR_NAME_LENGTH_ 100
typedef char DetectorName[_MAX_DETECTOR_NAME_LENGTH_];
typedef char DetectorFileName[_FILENAMESIZE_+_MAX_DETECTOR_NAME_LENGTH_+256];
 
enum br_approx {bra_sharp_sharp,bra_sharp_soft,bra_soft_soft,bra_soft_soft_cons,bra_exact};
 
enum reio_approx {sd_reio_Nozawa, sd_reio_Chluba};
 
struct distortions
{
 
  int sd_branching_approx;                      
  int sd_PCA_size;                              
  DetectorFileName sd_detector_file_name;       
  DetectorName sd_detector_name;                
  double sd_detector_nu_min;                    
  double sd_detector_nu_max;                    
  double sd_detector_nu_delta;                  
  int sd_detector_bin_number;                   
  double sd_detector_delta_Ic;                  
  enum reio_approx sd_reio_type;                
  double sd_add_y;                              
  double sd_add_mu;                             
 
 
  /* Parameters related to redshift (z) sampling */
  double z_muy;                              
  double z_th;                               
  double z_min;                              
  double z_max;                              
  int z_size;                                
  double z_delta;                            
  double * z;                                
  double * z_weights;                        
  /* Can be specified if no noisefile */
  double x_min;                              
  double x_max;                              
  double x_delta;                            
  /* Will always be specified */
  int x_size;                                
  double * x;                                
  double * x_weights;                        
  /* Unit conversions */
  double x_to_nu;                            
  double DI_units;                           
  /* File names for the PCA */
  char sd_detector_noise_file[2*_FILENAMESIZE_+_MAX_DETECTOR_NAME_LENGTH_+256];              
  DetectorFileName sd_PCA_file_generator;               
  DetectorFileName sd_detector_list_file;               
  /* Tables storing branching ratios, distortions amplitudes and spectral distoritons for all types of distortios */
  double ** br_table;              
  double * sd_parameter_table;     
  double ** sd_shape_table;        
  double ** sd_table;              
  /* indices for the type of distortion */
  int index_type_g;                
  int index_type_mu;               
  int index_type_y;                
  int index_type_PCA;              
  int type_size;                   
  /* Total distortion amplitude for residual distortions */
  double epsilon;
 
  /* Total heating function */
  double * dQrho_dz_tot;
 
  /* Total heating rate */
  double Drho_over_rho;
 
  /* Total spectral distortion */
  double * DI;                               
  /* Variables to read, allocate and interpolate external file branching_ratios_exact.dat */
  double * br_exact_z;                       
  int br_exact_Nz;                           
  double * f_g_exact;                        
  double * ddf_g_exact;                      
  double * f_y_exact;                        
  double * ddf_y_exact;                      
  double * f_mu_exact;                       
  double * ddf_mu_exact;                     
  double * E_vec;                            
  double * ddE_vec;                          
  int E_vec_size;                            
  /* Variable to read, allocate and interpolate external file PCA_distortions_schape.dat */
  double * PCA_nu;                           
  int PCA_Nnu;                               
  double * PCA_G_T;                          
  double * ddPCA_G_T;                        
  double * PCA_Y_SZ;                         
  double * ddPCA_Y_SZ;                       
  double * PCA_M_mu;                         
  double * ddPCA_M_mu;                       
  double * S_vec;                            
  double * ddS_vec;                          
  int S_vec_size;                            
  double * delta_Ic_array;                   
 
 
 
  int has_distortions;                      
  int has_user_defined_detector;            
  int has_user_defined_name;                
  int has_detector_file;                    
  int has_SZ_effect;                        
  int include_only_exotic;                  
  int include_g_distortion;                 
  int has_noninjected;                      
  struct noninjection ni;                   
  short distortions_verbose;                
  ErrorMsg error_message;    
 
};
 
/*************************************************************************************************************/
/* @cond INCLUDE_WITH_DOXYGEN */
/*
 * Boilerplate for C++
 */
#ifdef __cplusplus
extern "C" {
#endif
 
  /* Main functions */
  int distortions_init(struct precision * ppr,
                       struct background * pba,
                       struct thermodynamics * pth,
                       struct perturbations * ppt,
                       struct primordial * ppm,
                       struct distortions * psd);
 
  int distortions_constants(struct precision* ppr,
                            struct background * pba,
                            struct thermodynamics * pth,
                            struct distortions * psd);
 
  int distortions_free(struct distortions * psd);
 
  /* PCA decomposition (branching ratios and spectral shapes) for unknown detector */
  int distortions_generate_detector(struct precision * ppr,
                                    struct distortions * psd);
 
  int distortions_set_detector(struct precision * ppr,
                               struct distortions* psd);
 
  int distortions_read_detector_noisefile(struct precision * ppr,
                                          struct distortions * psd);
 
  /* Indices and lists */
  int distortions_indices(struct distortions * psd);
 
  int distortions_get_xz_lists(struct precision * ppr,
                               struct background* pba,
                               struct thermodynamics* pth,
                               struct distortions* psd);
 
  /* The main computation methods */
  int distortions_compute_branching_ratios(struct precision * ppr,
                                           struct distortions* psd);
 
  int distortions_compute_heating_rate(struct precision* ppr,
                                       struct background* pba,
                                       struct thermodynamics * pth,
                                       struct perturbations * ppt,
                                       struct primordial * ppm,
                                       struct distortions * psd);
 
  int distortions_compute_spectral_shapes(struct precision * ppr,
                                          struct background * pba,
                                          struct thermodynamics * pth,
                                          struct distortions * psd);
 
  /* Additional sources of distortions due to recombination and LSS formation */
  int distortions_add_effects_reio(struct background * pba,
                                   struct thermodynamics * pth,
                                   struct distortions * psd,
                                   double T_e,
                                   double Dtau,
                                   double beta,
                                   double beta_z,
                                   double x,
                                   double * y_reio,
                                   double * DI);
 
  /* PCA decomposition (branching ratios and spectral shapes) for known detector */
  int distortions_read_br_data(struct precision * ppr,
                               struct distortions * psd);
  int distortions_spline_br_data(struct distortions* psd);
  int distortions_interpolate_br_data(struct distortions* psd,
                                      double z,
                                      double* f_g,
                                      double* f_y,
                                      double* f_mu,
                                      double* E,
                                      int * last_index);
  int distortions_free_br_data(struct distortions * psd);
 
  int distortions_read_sd_data(struct precision * ppr,
                               struct distortions * psd);
  int distortions_spline_sd_data(struct distortions* psd);
  int distortions_interpolate_sd_data(struct distortions* psd,
                                      double nu,
                                      double * G_T,
                                      double * Y_SZ,
                                      double * M_mu,
                                      double * S,
                                      int * index);
  int distortions_free_sd_data(struct distortions * psd);
 
  /* Output */
  int distortions_output_heat_titles(struct distortions * psd, char titles[_MAXTITLESTRINGLENGTH_]);
  int distortions_output_heat_data(struct distortions * psd,
                                   int number_of_titles,
                                   double * data);
 
  int distortions_output_sd_titles(struct distortions * psd, char titles[_MAXTITLESTRINGLENGTH_]);
  int distortions_output_sd_data(struct distortions * psd,
                                 int number_of_titles,
                                 double * data);
 
#ifdef __cplusplus
}
#endif
 
/**************************************************************/
 
 
#endif
/* @endcond */