#include <hmi.h>

Inheritance diagram for t_hmi:

Collaboration diagram for t_hmi:

Public Member Functions
const char *	chName () const

void	zero ()

void	comment (t_warnings &)

Public Member Functions inherited from module
	module ()

virtual	~module ()

Data Fields
double	H2_total

realnum	H2_total_f

double	HD_total

double	H2_rate_destroy

double	hmihet

double	hmitot

double	hmicol

realnum	H2Opacity

double	hmidep

double	h2dep

double	h2pdep

double	h3pdep

double	h2plus_heatcoef

double	h2plus_heat

double	h2plus_exc_frac

double	HMinus_photo_rate

realnum	HeatH2DexcMax

realnum	CoolH2DexcMax

realnum	h2dfrc

realnum	h2dtot

realnum	h2line_cool_frac

double	HMinus_induc_rec_cooling

double	HMinus_induc_rec_rate

double	HMinus_photo_heat

long int	iheh1

long int	iheh2

realnum	UV_Cont_rel2_Habing_TH85_face

realnum	UV_Cont_rel2_Habing_TH85_depth

realnum	UV_Cont_rel2_Habing_spec_depth

realnum	UV_Cont_rel2_Draine_DB96_face

realnum	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

double	HeatH2Dish_TH85

double	HeatH2Dish_BD96

double	HeatH2Dish_BHT90

double	HeatH2Dish_ELWERT

double	HeatH2Dexc_used

double	HeatH2Dexc_TH85

double	HeatH2Dexc_BD96

double	HeatH2Dexc_BHT90

double	HeatH2Dexc_ELWERT

realnum	deriv_HeatH2Dexc_used

realnum	deriv_HeatH2Dexc_TH85

realnum	deriv_HeatH2Dexc_BD96

realnum	deriv_HeatH2Dexc_BHT90

realnum	deriv_HeatH2Dexc_ELWERT

double	H2_forms_grains

double	H2_forms_hminus

double	H2star_forms_grains

double	H2star_forms_hminus

bool	lgH2_Thermal_BigH2

bool	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

double	rel_pop_LTE_Hmin

double	rel_pop_LTE_H2s

double	rel_pop_LTE_H2p

double	rel_pop_LTE_H2g

double	rel_pop_LTE_H3p

bool	lgLeiden_Keep_ipMH2s

bool	lgLeidenCRHack

Detailed Description

hmi.h - parameters dealing with hydrogen molecules

Definition at line 15 of file hmi.h.

Member Function Documentation

const char* t_hmi::chName ( ) const

inlinevirtual

Implements module.

Definition at line 16 of file hmi.h.

void t_hmi::comment ( t_warnings & )

inlinevirtual

Implements module.

Definition at line 22 of file hmi.h.

void t_hmi::zero ( void )

virtual

HeatH2Dexc_used is heating due to collisional deexcitation of vib-excited H2 actually used

these are derivative wrt temp for collisional processes within X

the Solomon process rate H2 dissociates into X continuum - actually used

set_NaN( H2_Solomon_dissoc_rate_used );

H2 + hnu => 2H from TH85

H2 + hnu => 2H actually used

Implements module.

Definition at line 7 of file hmi.cpp.

Here is the call graph for this function:

Field Documentation

char t_hmi::chGrainFormPump

method used for grain formation pumping

Definition at line 182 of file hmi.h.

Referenced by diatomics::init(), ParseSet(), and zero().

char t_hmi::chH2_small_model_type

the set h2 small model command tells code says which of the small model H2 to use. Default is Elwert

Definition at line 179 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), mole_h_reactions(), ParseSet(), and zero().

char t_hmi::chJura

the set h2 jura command tells code which treatment of H2 formation to use

Definition at line 185 of file hmi.h.

Referenced by mole_h2_grain_form(), ParseSet(), and zero().

realnum t_hmi::CoolH2DexcMax

the largest fraction of total cooling anywhere in model

Definition at line 57 of file hmi.h.

Referenced by IterStart(), lines_molecules(), PrtComment(), and zero().

realnum t_hmi::deriv_HeatH2Dexc_BD96

Definition at line 156 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), and zero().

realnum t_hmi::deriv_HeatH2Dexc_BHT90

Definition at line 156 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), and zero().

realnum t_hmi::deriv_HeatH2Dexc_ELWERT

Definition at line 156 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), and zero().

realnum t_hmi::deriv_HeatH2Dexc_TH85

Definition at line 156 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), mole_h_fixup(), and zero().

realnum t_hmi::deriv_HeatH2Dexc_used

these are derivative wrt temp for collisional processes within X

Definition at line 156 of file hmi.h.

Referenced by CoolEvaluate(), HeatSum(), IterRestart(), IterStart(), and zero().

double t_hmi::exphmi

Boltzmann factor for hmi

Definition at line 199 of file hmi.h.

Referenced by mole_h_reactions().

double t_hmi::H2_forms_grains

these are the H- and grain formation rates, added above and below a certain energy (2.6 eV) for production of H2 or H2* in small network

Definition at line 164 of file hmi.h.

Referenced by diatomics::mole_H2_form(), and mole_h_rate_diagnostics().

double t_hmi::H2_forms_hminus

Definition at line 164 of file hmi.h.

Referenced by frac_H2star_hminus(), diatomics::mole_H2_form(), and mole_h_rate_diagnostics().

double t_hmi::H2_frac_abund_set

this is set to zero, but to positive number with atom h2 fraction command this sets the H2 density by multiplying the hydrogen density to become the H2 density

Definition at line 196 of file hmi.h.

Referenced by diatomics::H2_LevelPops(), mole_h_fixup(), mole_solve(), ParseSet(), and zero().

double t_hmi::H2_H2g_to_H2s_rate_BD96

the Solomon process excitation, H2g -> H2*, rate for the Bertodi & Draine model

Definition at line 94 of file hmi.h.

Referenced by mole_h_reactions().

double t_hmi::H2_H2g_to_H2s_rate_BHT90

the Solomon process excitation, H2g -> H2*, rate from Burton et al. 1990

Definition at line 91 of file hmi.h.

Referenced by mole_h_reactions().

double t_hmi::H2_H2g_to_H2s_rate_ELWERT

the Solomon process excitation, H2g -> H2*, rate for Elwert et al. model in prep.

Definition at line 97 of file hmi.h.

Referenced by mole_h_reactions().

double t_hmi::H2_H2g_to_H2s_rate_TH85

the Solomon process excitation, H2g -> H2*, rate from Tielens & Hollenbach 85

Definition at line 88 of file hmi.h.

Referenced by mole_h_reactions().

double t_hmi::H2_H2g_to_H2s_rate_used

the Solomon process excitation, H2g -> H2*, - actually used

Definition at line 100 of file hmi.h.

Referenced by IterRestart(), IterStart(), and mole_h_reactions().

double t_hmi::H2_photodissoc_BHT90

Definition at line 124 of file hmi.h.

Referenced by mole_h_reactions(), and zero().

double t_hmi::H2_photodissoc_ELWERT_H2g

Definition at line 121 of file hmi.h.

Referenced by mole_h_reactions(), and zero().

double t_hmi::H2_photodissoc_ELWERT_H2s

Definition at line 122 of file hmi.h.

Referenced by mole_h_reactions(), and zero().

double t_hmi::H2_photodissoc_TH85

Definition at line 123 of file hmi.h.

Referenced by mole_h_reactions(), and zero().

double t_hmi::H2_photodissoc_used_H2g

the Solomon process rate H2 dissociates into X continuum - actually used double H2_Solomon_dissoc_rate_used; H2 + hnu => 2H from TH85 H2 + hnu => 2H actually used

Definition at line 119 of file hmi.h.

Referenced by IterRestart(), IterStart(), mole_h_reactions(), SaveDo(), and zero().

double t_hmi::H2_photodissoc_used_H2s

Definition at line 120 of file hmi.h.

Referenced by IterRestart(), IterStart(), mole_h_reactions(), and zero().

double t_hmi::H2_rate_destroy

rate ground of H2 is destroyed

Definition at line 30 of file hmi.h.

Referenced by diatomics::H2_LevelPops(), diatomics::H2_PunchDo(), mole_effects(), and mole_h_rate_diagnostics().

double t_hmi::H2_Solomon_dissoc_rate_BD96_H2g

Definition at line 106 of file hmi.h.

Referenced by diatomics::H2_PunchDo(), IonHydro(), mole_h_reactions(), and zero().

double t_hmi::H2_Solomon_dissoc_rate_BD96_H2s

Definition at line 112 of file hmi.h.

Referenced by diatomics::H2_PunchDo(), mole_h_reactions(), and zero().

double t_hmi::H2_Solomon_dissoc_rate_BHT90_H2g

Definition at line 105 of file hmi.h.

Referenced by mole_h_reactions(), and zero().

double t_hmi::H2_Solomon_dissoc_rate_BHT90_H2s

Definition at line 111 of file hmi.h.

Referenced by mole_h_reactions(), and zero().

double t_hmi::H2_Solomon_dissoc_rate_ELWERT_H2g

Definition at line 107 of file hmi.h.

Referenced by diatomics::H2_PunchDo(), mole_h_reactions(), and zero().

double t_hmi::H2_Solomon_dissoc_rate_ELWERT_H2s

Definition at line 113 of file hmi.h.

Referenced by mole_h_reactions(), and zero().

double t_hmi::H2_Solomon_dissoc_rate_TH85_H2g

Definition at line 104 of file hmi.h.

Referenced by diatomics::H2_PunchDo(), IonHydro(), mole_h_reactions(), and zero().

double t_hmi::H2_Solomon_dissoc_rate_TH85_H2s

Definition at line 110 of file hmi.h.

Referenced by diatomics::H2_PunchDo(), mole_h_reactions(), and zero().

double t_hmi::H2_Solomon_dissoc_rate_used_H2g

the Solomon process dissociate rate from Tielens & Hollenbach 85

Definition at line 103 of file hmi.h.

Referenced by IonHydro(), IterRestart(), IterStart(), mole_effects(), mole_h_rate_diagnostics(), mole_h_reactions(), SaveDo(), and zero().

double t_hmi::H2_Solomon_dissoc_rate_used_H2s

Definition at line 109 of file hmi.h.

Referenced by IterRestart(), IterStart(), mole_effects(), mole_h_reactions(), and zero().

double t_hmi::H2_total

the total H2 density [cm-3], NOT 2*n(H2), the sum of H2 and H2*

Definition at line 25 of file hmi.h.

Referenced by ConvBase(), ConvTempEdenIoniz(), CoolEvaluate(), CoolH2_GA08(), GrainCollHeating(), GrainMakeDiffuse(), GrnStdDpth(), diatomics::H2_X_sink_and_source(), HeatSum(), ColliderList::init(), IonHydro(), iter_end_check(), IterRestart(), map_do(), t_mean::MeanInc(), mole_effects(), mole_h_fixup(), mole_h_rate_diagnostics(), OpacityAddTotal(), PrtZone(), radius_first(), radius_increment(), radius_next(), SaveDo(), ScaleAllDensities(), and zero().

realnum t_hmi::H2_total_f

Definition at line 26 of file hmi.h.

Referenced by diatomics::H2_X_coll_rate_evaluate(), IterRestart(), mole_effects(), mole_h_fixup(), and zero().

double t_hmi::h2dep

Definition at line 42 of file hmi.h.

Referenced by mole_effects(), mole_h_rate_diagnostics(), PrtZone(), and zero().

realnum t_hmi::h2dfrc

Definition at line 57 of file hmi.h.

Referenced by IterStart(), lines_molecules(), and PrtComment().

realnum t_hmi::h2dtot

Definition at line 57 of file hmi.h.

Referenced by IterStart(), lines_molecules(), and PrtComment().

realnum t_hmi::h2line_cool_frac

fraqction of cooling carried by H2 lines

Definition at line 57 of file hmi.h.

Referenced by IterStart(), lines_molecules(), and PrtComment().

realnum t_hmi::H2Opacity

mean cross section (cm-2) for H2 Lyman absorption

Definition at line 38 of file hmi.h.

Referenced by mole_h_fixup(), mole_h_reactions(), radius_first(), and zero().

double t_hmi::h2pdep

Definition at line 42 of file hmi.h.

Referenced by mole_effects(), mole_h_rate_diagnostics(), PrtZone(), and zero().

double t_hmi::h2plus_exc_frac

fraction of H2+ in excited states

Definition at line 50 of file hmi.h.

Referenced by mole_h_fixup(), OpacityAddTotal(), and zero().

double t_hmi::h2plus_heat

Definition at line 48 of file hmi.h.

Referenced by CoolEvaluate(), IterRestart(), IterStart(), lines_molecules(), mole_effects(), mole_h_fixup(), and zero().

double t_hmi::h2plus_heatcoef

heating due to photo dissoc of H2+

Definition at line 48 of file hmi.h.

Referenced by mole_effects(), mole_h_fixup(), and zero().

realnum t_hmi::h2pmax

largest local fraction heating due to dissoc of H2+

Definition at line 131 of file hmi.h.

Referenced by IterStart(), lines_molecules(), and PrtComment().

double t_hmi::H2star_forms_grains

Definition at line 164 of file hmi.h.

Referenced by diatomics::mole_H2_form(), and mole_h_rate_diagnostics().

double t_hmi::H2star_forms_hminus

Definition at line 164 of file hmi.h.

Referenced by frac_H2star_hminus(), diatomics::mole_H2_form(), and mole_h_rate_diagnostics().

double t_hmi::h3pdep

Definition at line 42 of file hmi.h.

Referenced by mole_effects(), PrtZone(), and zero().

double t_hmi::HD_total

Definition at line 27 of file hmi.h.

Referenced by CoolEvaluate(), IterRestart(), mole_effects(), PrtZone(), and zero().

double t_hmi::HeatH2Dexc_BD96

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), and zero().

double t_hmi::HeatH2Dexc_BHT90

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), and zero().

double t_hmi::HeatH2Dexc_ELWERT

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), and zero().

double t_hmi::HeatH2Dexc_TH85

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), diatomics::H2_PunchDo(), mole_effects(), mole_h_fixup(), and zero().

double t_hmi::HeatH2Dexc_used

HeatH2Dexc_used is heating due to collisional deexcitation of vib-excited H2 actually used

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), CoolSave(), HeatSum(), IterRestart(), IterStart(), lines_molecules(), radius_next(), SaveDo(), and zero().

realnum t_hmi::HeatH2DexcMax

the largest fraction of total heat anywhere in model

Definition at line 57 of file hmi.h.

Referenced by IterStart(), lines_molecules(), PrtComment(), and zero().

double t_hmi::HeatH2Dish_BD96

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), and zero().

double t_hmi::HeatH2Dish_BHT90

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), and zero().

double t_hmi::HeatH2Dish_ELWERT

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), mole_effects(), and zero().

double t_hmi::HeatH2Dish_TH85

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), diatomics::H2_PunchDo(), mole_effects(), mole_h_fixup(), and zero().

double t_hmi::HeatH2Dish_used

HeatH2Dish_used is heating due to H2 dissociation actually used

Definition at line 140 of file hmi.h.

Referenced by CoolEvaluate(), IterRestart(), IterStart(), lines_molecules(), radius_next(), SaveDo(), and zero().

double t_hmi::hmicol

Definition at line 33 of file hmi.h.

Referenced by CoolEvaluate(), CoolSave(), lines_molecules(), mole_h_fixup(), mole_h_rate_diagnostics(), and mole_h_reactions().

double t_hmi::hmidep

these are departure coef for H-, H2, H2+, and HeH, defined in hmole

Definition at line 42 of file hmi.h.

Referenced by lgCheckMonitors(), mole_effects(), mole_h_fixup(), mole_h_rate_diagnostics(), OpacityAddTotal(), PrtZone(), RT_tau_inc(), and zero().

double t_hmi::hmihet

hminus heating, free bound

Definition at line 33 of file hmi.h.

Referenced by CoolEvaluate(), IterRestart(), IterStart(), lines_molecules(), mole_effects(), mole_h_fixup(), mole_h_rate_diagnostics(), and zero().

double t_hmi::HMinus_induc_rec_cooling

Definition at line 65 of file hmi.h.

Referenced by mole_effects(), mole_h_rate_diagnostics(), and mole_h_reactions().

double t_hmi::HMinus_induc_rec_rate

Definition at line 65 of file hmi.h.

Referenced by mole_h_rate_diagnostics(), and mole_h_reactions().

double t_hmi::HMinus_photo_heat

Definition at line 65 of file hmi.h.

Referenced by mole_effects(), and mole_h_reactions().

double t_hmi::HMinus_photo_rate

H- photo dissoc rate

Definition at line 53 of file hmi.h.

Referenced by CoolEvaluate(), mole_h_rate_diagnostics(), mole_h_reactions(), and RT_OTS().

double t_hmi::hmitot

Definition at line 33 of file hmi.h.

Referenced by IterRestart(), IterStart(), lines_molecules(), PrtComment(), and zero().

long int t_hmi::iheh1

Definition at line 69 of file hmi.h.

Referenced by ContCreatePointers().

long int t_hmi::iheh2

Definition at line 69 of file hmi.h.

Referenced by ContCreatePointers().

long int t_hmi::iphmin

continuum array index for H minus threshold

Definition at line 128 of file hmi.h.

Referenced by ContCreatePointers(), mole_h_reactions(), OpacityAddTotal(), OpacityCreateAll(), RT_diffuse(), and RT_tau_inc().

bool t_hmi::lgH2_Chemistry_BigH2

say how to do chemistry (formation and destruction), if true (default) use results of large molecule, if false use TH85 approximations

Definition at line 171 of file hmi.h.

Referenced by frac_H2star_hminus(), mole_h_reactions(), ParseDatabaseH2(), and zero().

bool t_hmi::lgH2_Thermal_BigH2

say how to do thermal solution, if true (default) use results of large molecule, if false use TH85 approximations

Definition at line 171 of file hmi.h.

Referenced by CoolEvaluate(), ParseDatabaseH2(), and zero().

bool t_hmi::lgLeiden_Keep_ipMH2s

hack to kill effects of H2* in chemistry network "set leiden hack h2* off

Definition at line 219 of file hmi.h.

Referenced by diatomics::H2_Calc_Average_Rates(), diatomics::H2_LevelPops(), diatomics::H2_Solomon_rate(), diatomics::H2_X_sink_and_source(), diatomics::init(), t_mole_global::make_species(), diatomics::Mol_Photo_Diss_Rates(), mole_create_react(), diatomics::mole_H2_form(), ParseSet(), and zero().

bool t_hmi::lgLeidenCRHack

Definition at line 220 of file hmi.h.

Referenced by mole_h_reactions(), ParseSet(), diatomics::SolveExcitedElectronicLevels(), diatomics::SolveSomeGroundElectronicLevels(), and zero().

double t_hmi::rate_h2_form_grains_set

H2 formation rate as set with set h2 rate command units S^-1, actual depl

Definition at line 192 of file hmi.h.

Referenced by mole_h2_grain_form(), and ParseSet().

double t_hmi::rel_pop_LTE_H2g

related to the LTE population of H2 in ground, following is n(H2) / [n(H) n(H) ], units cm3

Definition at line 211 of file hmi.h.

Referenced by mole_effects(), mole_h_rate_diagnostics(), and mole_h_reactions().

double t_hmi::rel_pop_LTE_H2p

LTE population for H2+, following is n(H2+) / [n(H) n(p) ], units cm3

Definition at line 211 of file hmi.h.

Referenced by mole_effects(), and mole_h_reactions().

double t_hmi::rel_pop_LTE_H2s

related to the LTE population of H2s, following is n(H2s) / [n(H) n(H) ], units cm3

Definition at line 199 of file hmi.h.

Referenced by mole_h_rate_diagnostics(), and mole_h_reactions().

double t_hmi::rel_pop_LTE_H3p

related to population of H3+

Definition at line 211 of file hmi.h.

Referenced by mole_effects(), and mole_h_reactions().

double t_hmi::rel_pop_LTE_Hmin

related to the LTE populations of H-, H2, and H2+ each is a constant with temperature dependence, and needs to be multiplied by the densities of the separated components to become the LTE density. following is n(H-) / [ n(e) n(H) ], units cm3

Definition at line 199 of file hmi.h.

Referenced by mole_effects(), mole_h_rate_diagnostics(), and mole_h_reactions().

realnum t_hmi::ScaleJura

this is a scale factor to multiply the Jura rate, default is unity, changed with the set jura scale command

Definition at line 189 of file hmi.h.

Referenced by mole_h2_grain_form(), ParseSet(), and zero().

realnum t_hmi::Tad

binding energy for change in H2 population while on grain surface, set with "set h2 Tad " command

Definition at line 135 of file hmi.h.

Referenced by mole_h2_grain_form(), ParseSet(), and zero().

realnum t_hmi::UV_Cont_rel2_Draine_DB96_depth

Definition at line 84 of file hmi.h.

Referenced by diatomics::H2_PunchDo(), IterRestart(), IterStart(), mole_h_reactions(), SaveDo(), and zero().

realnum t_hmi::UV_Cont_rel2_Draine_DB96_face

UV flux relative to Habing value, used for some simple molecular photodissociation rates, as defined by Draine & Bertoldi 1996 -0 we try to do this the way they describe, since they say that this will agree with their large H2 molecule, first define field at the illuminated face, then get value at depth using their form of the extinction and shielding, rather than our exact calculation

Definition at line 84 of file hmi.h.

Referenced by IterRestart(), IterStart(), mole_effects(), mole_h_reactions(), PrtFinal(), and zero().

realnum t_hmi::UV_Cont_rel2_Habing_spec_depth

the special version of g0 with adjustable bounds

Definition at line 74 of file hmi.h.

Referenced by diatomics::H2_PunchDo(), and mole_h_reactions().

realnum t_hmi::UV_Cont_rel2_Habing_TH85_depth

Definition at line 74 of file hmi.h.

Referenced by GrainDrive(), GrainTemperature(), diatomics::H2_PunchDo(), mole_h_reactions(), SaveDo(), and zero().

realnum t_hmi::UV_Cont_rel2_Habing_TH85_face

UV flux relative to Habing value, used for some simple molecular photodissociation rates, as defined by Tielens & Hollenbach 1985

Definition at line 74 of file hmi.h.