hmi.h

Go to the documentation of this file.

/* This file is part of Cloudy and is copyright (C)1978-2025 by Gary J. Ferland and
 * others.  For conditions of distribution and use see copyright notice in license.txt */
 
#ifndef HMI_H_
#define HMI_H_
 
#include "module.h"

double hmirat(double te);

struct t_hmi : public module {
        const char *chName() const
        {
                return "hmi";
        }
 
        void zero();
        void comment(t_warnings&) {}

        double H2_total;
        realnum H2_total_f; // single-precision version of above
        double HD_total;

        double H2_rate_destroy;

        double hmihet, 
          hmitot, 
          hmicol;

        realnum H2Opacity;

        double hmidep, 
          h2dep, 
          h2pdep, 
          h3pdep;

        double h2plus_heatcoef, h2plus_heat;
        double h2plus_exc_frac;

        double HMinus_photo_rate;
 
        realnum 
          HeatH2DexcMax,
          CoolH2DexcMax,
          h2dfrc, 
          h2dtot,
          h2line_cool_frac;
 
        double HMinus_induc_rec_cooling,
          HMinus_induc_rec_rate,
          HMinus_photo_heat;
 
        long int iheh1, 
          iheh2;

        realnum UV_Cont_rel2_Habing_TH85_face,
          UV_Cont_rel2_Habing_TH85_depth,
          UV_Cont_rel2_Habing_spec_depth;

        realnum UV_Cont_rel2_Draine_DB96_face , 
                UV_Cont_rel2_Draine_DB96_depth;

        double H2_H2g_to_H2s_rate_TH85;

        double H2_H2g_to_H2s_rate_BHT90;
        
        double H2_H2g_to_H2s_rate_BD96;
        
        double H2_H2g_to_H2s_rate_ELWERT;
        
        double H2_H2g_to_H2s_rate_used;

        double H2_Solomon_dissoc_rate_used_H2g;
        double H2_Solomon_dissoc_rate_TH85_H2g;
        double H2_Solomon_dissoc_rate_BHT90_H2g;
        double H2_Solomon_dissoc_rate_BD96_H2g;
        double H2_Solomon_dissoc_rate_ELWERT_H2g;
 
        double H2_Solomon_dissoc_rate_used_H2s;
        double H2_Solomon_dissoc_rate_TH85_H2s;
        double H2_Solomon_dissoc_rate_BHT90_H2s;
        double H2_Solomon_dissoc_rate_BD96_H2s;
        double H2_Solomon_dissoc_rate_ELWERT_H2s;

        double H2_photodissoc_used_H2g;
        double H2_photodissoc_used_H2s;
        double H2_photodissoc_ELWERT_H2g;
        double H2_photodissoc_ELWERT_H2s;
        double H2_photodissoc_TH85;
        double H2_photodissoc_BHT90;
 

        long int iphmin;

        realnum h2pmax;

        realnum Tad;
 
        double 

          HeatH2Dish_used, 
          HeatH2Dish_TH85, 
          HeatH2Dish_BD96 ,
          HeatH2Dish_BHT90, 
          HeatH2Dish_ELWERT ,

          HeatH2Dexc_used,
          HeatH2Dexc_TH85,
          HeatH2Dexc_BD96,
          HeatH2Dexc_BHT90,
          HeatH2Dexc_ELWERT;

        realnum 
                deriv_HeatH2Dexc_used,
                deriv_HeatH2Dexc_TH85 ,
                deriv_HeatH2Dexc_BD96 ,
                deriv_HeatH2Dexc_BHT90 ,
                deriv_HeatH2Dexc_ELWERT;

        double H2_forms_grains ,
                H2_forms_hminus,
                H2star_forms_grains,
                H2star_forms_hminus;

        bool lgH2_Thermal_BigH2,
          lgH2_Chemistry_BigH2;

        char chH2_small_model_type;

        char chGrainFormPump;

        char chJura;

        realnum ScaleJura;

        double rate_h2_form_grains_set;  

        double H2_frac_abund_set;

        double exphmi,
          rel_pop_LTE_Hmin,
          rel_pop_LTE_H2s;
        double rel_pop_LTE_H2p,
          rel_pop_LTE_H2g,
          rel_pop_LTE_H3p;

        bool lgLeiden_Keep_ipMH2s;
        bool lgLeidenCRHack;
 
};
extern t_hmi hmi;
 
#endif /* HMI_H_ */