Skip to content

Commit ed76495

Browse files
committed
add docstring for gammah_rate
1 parent 4948375 commit ed76495

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

src/clib/rate_functions.c

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1436,11 +1436,10 @@ double comp_rate(double units, chemistry_data *my_chemistry)
14361436
return 5.65e-36 / units;
14371437
}
14381438

1439-
//Calculation of gammah.
14401439
double gammah_rate(double units, chemistry_data *my_chemistry)
14411440
{
1442-
//Default is 8.5e-26 for epsilon=0.05, G_0=1.7 (rate in erg s^-1 cm^-3).
14431441
if (my_chemistry->photoelectric_heating <= 1) {
1442+
// Default: 8.5e-26 for epsilon=0.05, G_0=1.7 (rate in erg s^-1 cm^-3)
14441443
return my_chemistry->photoelectric_heating_rate / units;
14451444
} else { //photoelectric_heating set to 2 or 3
14461445
//User to specify G_0, epsilon set to 0.05 or calculated directly.

src/include/grackle_rate_functions.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,13 @@ double regr_rate(double T, double units, chemistry_data *my_chemistry);
111111
double grain_growth_rate(double T, double units, chemistry_data *my_chemistry);
112112

113113
double comp_rate(double units, chemistry_data *my_chemistry);
114+
115+
/// Calculate quantity closely related to Γ for photo-electric heating from
116+
/// photo-electric heating by dust-grains
117+
///
118+
/// For added context, we currently use equation 1 (and possibly eqn 2) of
119+
/// [Wolfire+95](https://ui.adsabs.harvard.edu/abs/1995ApJ...443..152W/abstract)
120+
/// to implement photo-electric heating
114121
double gammah_rate(double units, chemistry_data *my_chemistry);
115122
double gamma_isrf_rate(double units, chemistry_data *my_chemistry);
116123
double gamma_isrf2_rate(double units, chemistry_data *my_chemistry);

0 commit comments

Comments
 (0)