thermodynamics.h

Go to the documentation of this file.

 
#ifndef __THERMODYNAMICS__
#define __THERMODYNAMICS__
 
#include "background.h"
#include "evolver_ndf15.h"
#include "evolver_rkck.h"
#include "wrap_hyrec.h"
#include "wrap_recfast.h"
#include "injection.h"
 
enum recombination_algorithm {
                              recfast,
                              hyrec
};
 
enum reionization_parametrization {
                                   reio_none,       
                                   reio_camb,       
                                   reio_bins_tanh,  
                                   reio_half_tanh,  
                                   reio_many_tanh,  
                                   reio_inter       
};
 
enum reionization_z_or_tau {
                            reio_z,  
                            reio_tau 
};
 
#define f1(x) (-0.75*x*(x*x/3.-1.)+0.5)  
#define f2(x) (x*x*(0.5-x/3.)*6.)        
struct thermodynamics
{
 
  double YHe;  
  double bbn_alpha_sensitivity; 
  enum recombination_algorithm recombination; 
  enum recfast_photoion_modes recfast_photoion_mode; 
  enum reionization_parametrization reio_parametrization; 
  enum reionization_z_or_tau reio_z_or_tau; 
  double tau_reio; 
  double z_reio;   
  short compute_cb2_derivatives; 
  short compute_damping_scale; 
  short has_idm_b;    
  short has_idm_g;    
  short has_idm_dr;   
  double reionization_width; 
  double reionization_exponent; 
  double helium_fullreio_redshift; 
  double helium_fullreio_width; 
  int binned_reio_num; 
  double * binned_reio_z; 
  double * binned_reio_xe; 
  double binned_reio_step_sharpness; 
  int many_tanh_num; 
  double * many_tanh_z; 
  double * many_tanh_xe; 
  double many_tanh_width; 
  int reio_inter_num; 
  double * reio_inter_z; 
  double * reio_inter_xe; 
  short has_exotic_injection; 
  struct injection in; 
  double annihilation; 
  short has_on_the_spot; 
  double decay; 
  double annihilation_variation; 
  double annihilation_z; 
  double annihilation_zmax; 
  double annihilation_zmin; 
  double annihilation_f_halo; 
  double annihilation_z_halo; 
  short has_varconst; 
 
 
  int index_th_xe;            
  int index_th_dkappa;        
  int index_th_tau_d;         
  int index_th_ddkappa;       
  int index_th_dddkappa;      
  int index_th_exp_m_kappa;   
  int index_th_g;             
  int index_th_dg;            
  int index_th_ddg;           
  int index_th_T_idm;         
  int index_th_c2_idm;        
  int index_th_T_idr;         
  int index_th_dmu_idm_dr;    
  int index_th_ddmu_idm_dr;   
  int index_th_dddmu_idm_dr;  
  int index_th_dmu_idr;       
  int index_th_tau_idm_dr;    
  int index_th_tau_idr;       
  int index_th_g_idm_dr;      
  int index_th_dmu_idm_g;     
  int index_th_ddmu_idm_g;    
  int index_th_dddmu_idm_g;   
  int index_th_exp_mu_idm_g;  
  int index_th_R_idm_b;       
  int index_th_dR_idm_b;      
  int index_th_ddR_idm_b;     
  int index_th_Tb;            
  int index_th_dTb;           
  int index_th_wb;            
  int index_th_cb2;           
  int index_th_dcb2;          
  int index_th_ddcb2;         
  int index_th_rate;          
  int index_th_r_d;           
  int th_size;                
 
 
  int tt_size;                   
  double * z_table;              
  double * tau_table;            
  double * thermodynamics_table; 
 
 
  double * d2thermodynamics_dz2_table; 
 
 
  double z_rec;   
  double tau_rec; 
  double rs_rec;  
  double ds_rec;  
  double ra_rec;  
  double da_rec;  
  double rd_rec;  
  double z_star;  
  double tau_star;
  double rs_star; 
  double ds_star; 
  double ra_star;  
  double da_star;  
  double rd_star;  
  double z_d;     
  double tau_d;   
  double ds_d;    
  double rs_d;    
  double conf_time_reio; 
  double tau_cut; 
  double angular_rescaling;      
  double tau_free_streaming;     
  double tau_idr_free_streaming; 
  double tau_idr;                
  double tau_idm_dr;             
 
 
  double tau_ini; 
 
 
  double fHe;  
  double n_e;  
 
 
  double m_idm;          
  double a_idm_dr;       
  double b_idr;          
  double n_index_idm_dr; 
  double cross_idm_b;    
  int n_index_idm_b;     
  double n_coeff_idm_b;  
  double cross_idm_g;    
  double u_idm_g;        
  int n_index_idm_g;     
 
 
  short inter_normal;  
  short inter_closeby; 
 
 
  short thermodynamics_verbose; 
  short hyrec_verbose; 
  ErrorMsg error_message; 
  short is_allocated; 
 
};
 
struct thermo_vector {
 
  int ti_size;          
  int index_ti_x_H;     
  int index_ti_x_He;    
  int index_ti_D_Tmat;  
  int index_ti_T_idm;   
  double * y;           
  double * dy;          
  int * used_in_output; 
};
 
struct thermo_diffeq_workspace {
 
  double x_H;        
  double x_He;       
  double x_noreio;   
  double x_reio;     
  double x;          
  double Tmat;       
  double R_idm_b;       
  double T_idm;         
  double T_idm_prime;   
  double dmu_idm_g;     
  double c2_idm;        
  double dmu_idm_dr;    
  double dmu_idr;       
  double Sinv_idm_dr;   
  /* index of approximation schemes for the thermal history */
  int index_ap_idmtca;
  int index_ap_brec;  
  int index_ap_He1;   
  int index_ap_He1f;  
  int index_ap_He2;   
  int index_ap_H;     
  int index_ap_frec;  
  int index_ap_reio;  
  int ap_current;     
  int ap_size;        
  int ap_size_loaded; 
  double * ap_z_limits;       
  double * ap_z_limits_delta; 
  int require_H;  
  int require_He; 
  struct thermo_vector * ptv;       
  struct thermohyrec * phyrec;     
  struct thermorecfast * precfast; 
};
 
struct thermo_reionization_parameters{
 
  /* parameters used by reio_camb */
 
  int index_re_reio_redshift;  
  int index_re_reio_exponent;  
  int index_re_reio_width;     
  int index_re_xe_before; 
  int index_re_xe_after;  
  int index_re_helium_fullreio_fraction; 
  int index_re_helium_fullreio_redshift; 
  int index_re_helium_fullreio_width;    
  /* parameters used by reio_bins_tanh, reio_many_tanh, reio_inter */
 
  int re_z_size;                
  int index_re_first_z;        
  int index_re_first_xe;       
  int index_re_step_sharpness; 
  /* parameters used by all schemes */
 
  int index_re_reio_start;     
  double * reionization_parameters; 
  int re_size;              
};
 
struct thermo_workspace {
 
  /* Number of z values */
  int Nz_reco_lin;             
  int Nz_reco_log;             
  int Nz_reco;                 
  int Nz_reio;                 
  int Nz_tot;                  
  /* Most important and useful parameters of evolution */
  double YHe;          
  double fHe;          
  double SIunit_H0;    
  double SIunit_nH0;   
  double Tcmb;         
  /* Most important and useful constants */
  double const_NR_numberdens;  
  double const_Tion_H;         
  double const_Tion_HeI;       
  double const_Tion_HeII;      
  short has_ap_idmtca;         
  double z_ap_idmtca;          
  double reionization_optical_depth; 
  int last_index_back; 
  struct thermo_diffeq_workspace * ptdw;        
  struct thermo_reionization_parameters * ptrp; 
};
 
struct thermodynamics_parameters_and_workspace {
 
  /* structures containing fixed input parameters (indices, ...) */
  struct background * pba;
  struct precision * ppr;
  struct thermodynamics * pth;
 
  /* workspace */
  struct thermo_workspace * ptw;
  double * pvecback;
};
 
/**************************************************************/
/* @cond INCLUDE_WITH_DOXYGEN */
/*
 * Boilerplate for C++
 */
#ifdef __cplusplus
extern "C" {
#endif
 
  /* external functions of the module*/
 
  int thermodynamics_at_z(struct background * pba,
                          struct thermodynamics * pth,
                          double z,
                          enum interpolation_method inter_mode,
                          int * last_index,
                          double * pvecback,
                          double * pvecthermo);
 
  int thermodynamics_init(struct precision * ppr,
                          struct background * pba,
                          struct thermodynamics * pth);
 
  int thermodynamics_free(struct thermodynamics * pth);
 
  int thermodynamics_free_input(struct thermodynamics * pth);
 
  /* internal functions of the module */
 
  int thermodynamics_helium_from_bbn(struct precision * ppr,
                                     struct background * pba,
                                     struct thermodynamics * pth);
 
  int thermodynamics_checks(struct precision * ppr,
                            struct background* pba,
                            struct thermodynamics * pth);
 
  int thermodynamics_workspace_init(struct precision * ppr,
                                    struct background * pba,
                                    struct thermodynamics * pth,
                                    struct thermo_workspace * ptw);
 
  int thermodynamics_indices(struct background * pba,
                             struct thermodynamics * pth,
                             struct thermo_workspace* ptw);
 
  int thermodynamics_lists(struct precision * ppr,
                           struct background* pba,
                           struct thermodynamics* pth,
                           struct thermo_workspace* ptw);
 
  int thermodynamics_set_parameters_reionization(struct precision * ppr,
                                                 struct background * pba,
                                                 struct thermodynamics * pth,
                                                 struct thermo_reionization_parameters * preio);
 
  int thermodynamics_solve(struct precision * ppr,
                           struct background * pba,
                           struct thermodynamics * pth,
                           struct thermo_workspace* ptw,
                           double * pvecback);
 
  int thermodynamics_calculate_remaining_quantities(struct precision * ppr,
                                                    struct background * pba,
                                                    struct thermodynamics* pth,
                                                    double* pvecback);
 
  int thermodynamics_output_summary(struct background* pba,
                                    struct thermodynamics* pth);
 
  int thermodynamics_workspace_free(struct thermodynamics* pth, struct thermo_workspace * ptw);
 
  int thermodynamics_vector_init(struct precision * ppr,
                                 struct background * pba,
                                 struct thermodynamics * pth,
                                 double z,
                                 struct thermo_workspace * ptw);
 
  int thermodynamics_reionization_evolve_with_tau(struct thermodynamics_parameters_and_workspace * tpaw,
                                                  double mz_ini,
                                                  double mz_end,
                                                  double * mz_output,
                                                  int Nz);
 
  int thermodynamics_derivs(
                            double mz,
                            double * y,
                            double * dy,
                            void * parameters_and_workspace,
                            ErrorMsg error_message
                            );
 
  int thermodynamics_timescale(double z,
                               void * thermo_parameters_and_workspace,
                               double * timescale,
                               ErrorMsg error_message);
 
  int thermodynamics_sources(double mz,
                             double * y,
                             double * dy,
                             int index_z,
                             void * thermo_parameters_and_workspace,
                             ErrorMsg error_message);
 
  int thermodynamics_reionization_get_tau(struct precision * ppr,
                                          struct background * pba,
                                          struct thermodynamics * pth,
                                          struct thermo_workspace * ptw);
 
  int thermodynamics_vector_free(struct thermo_vector * tv);
 
 
  int thermodynamics_calculate_conformal_drag_time(struct background* pba,
                                                   struct thermodynamics* pth,
                                                   double* pvecback);
 
  int thermodynamics_calculate_damping_scale(struct background* pba,
                                             struct thermodynamics* pth,
                                             double* pvecback);
 
  int thermodynamics_calculate_opticals(struct precision* ppr,
                                        struct thermodynamics* pth);
 
  int thermodynamics_calculate_recombination_quantities(struct precision* ppr,
                                                        struct background * pba,
                                                        struct thermodynamics* pth,
                                                        double* pvecback);
 
  int thermodynamics_calculate_drag_quantities(struct precision* ppr,
                                               struct background * pba,
                                               struct thermodynamics* pth,
                                               double* pvecback);
 
  int thermodynamics_ionization_fractions(
                                          double z,
                                          double * y,
                                          struct background * pba,
                                          struct thermodynamics * pth,
                                          struct thermo_workspace * ptw,
                                          int current_ap
                                          );
 
  int thermodynamics_reionization_function(double z,
                                           struct thermodynamics * pth,
                                           struct thermo_reionization_parameters * preio,
                                           double * x);
 
  int thermodynamics_obtain_z_ini(
                                  struct precision * ppr,
                                  struct background *pba,
                                  struct thermodynamics *pth,
                                  struct thermo_workspace * ptw
                                  );
 
  int thermodynamics_output_titles(struct background * pba,
                                   struct thermodynamics *pth,
                                   char titles[_MAXTITLESTRINGLENGTH_]);
 
  int thermodynamics_output_data(struct background * pba,
                                 struct thermodynamics *pth,
                                 int number_of_titles,
                                 double *data);
 
  int thermodynamics_calculate_idm_and_idr_quantities(struct precision * ppr,
                                                      struct background * pba,
                                                      struct thermodynamics * pth,
                                                      double* pvecback);
 
  int thermodynamics_idm_quantities(struct background * pba,
                                    double z,
                                    double * y,
                                    double * dy,
                                    struct thermodynamics * pth,
                                    struct thermo_workspace * ptw,
                                    double * pvecback);
 
  int thermodynamics_idm_initial_temperature(struct background* pba,
                                             struct thermodynamics* pth,
                                             double z_ini,
                                             struct thermo_diffeq_workspace * ptdw);
 
#ifdef __cplusplus
}
#endif
 
/**************************************************************/
 
 
#define _YHE_BBN_ -1 
 
 
#define _m_e_ 9.10938215e-31  
#define _m_p_ 1.672621637e-27 
#define _m_H_ 1.673575e-27    
#define _not4_ 3.9715         
#define _sigma_ 6.6524616e-29 
#define _RECFAST_INTEG_SIZE_ 3
 
 
 
#define _s_over_Mpc_ 9.71561189e-15  
#define _Mpc_over_GeV_ 1.56373832e38  
#define _GeV_over_kg_ 1.78266191e-27  
#define _GeVcm3_over_Mpc2_ 94.7024726  
#define _Jm3_over_Mpc2_ 0.0151730087  
#define _Sun_mass_ 1.98855e30 
#define _eV_over_Kelvin_ 8.61733034e-5   
#define _eV_over_joules_ 6.24150647996e+18 
 
/* @endcond */
 
 
#define _YHE_BIG_ 0.5      
#define _YHE_SMALL_ 0.01   
#define _Z_REC_MAX_ 2000.
#define _Z_REC_MIN_ 500.
 
 
#endif