2525// / @todo Come up with a better name?
2626namespace grackle ::impl::dust_gas_edot {
2727
28- // / update edot, in place, with contributions from Photo -electric heating by
28+ // / update edot, in place, with contributions from photo -electric heating by
2929// / UV-irradiated dust
3030// /
31+ // / Based on eqn 1 of
32+ // / [Wolfire+95](https://ui.adsabs.harvard.edu/abs/1995ApJ...443..152W/abstract):
33+ // / @code{unparsed}
34+ // / Γeff = ε * Γ
35+ // / Γ = (1e-24 * G₀) erg cm⁻³ s⁻¹
36+ // / @endcode
37+ // / where G₀ is the interstellar FUV radiation (in Habing units)
38+ // /
39+ // / The value of `photoelectric_heating` config parameter controls the
40+ // / meaning of @p gammah:
41+ // / - when the `photoelectric_heating` is 1, @p gammah directly holds Γ
42+ // / - otherwise, it holds: (Γ/G₀)
43+ // /
44+ // / `photoelectric_heating` also controls modeling of ε
45+ // /
46+ // / @note
3147// / Each of the 1D arrays is only valid for the specified @p idx_range
3248// /
3349// / @param [in,out] edot 1D array being used to accumulate the net rate of
@@ -41,7 +57,8 @@ namespace grackle::impl::dust_gas_edot {
4157// / @param[in] itmask Specifies the general iteration-mask of the @p idx_range
4258// / for this calculation.
4359// / @param[in] my_chemistry holds a number of configuration parameters.
44- // / @param[in] gammah Parameterizes the calculation
60+ // / @param[in] gammah Parameterizes the calculation. Precomputed by
61+ // / @ref gammah_rate.
4562// / @param[in] idx_range Specifies the current index-range
4663// / @param[in] dom_inv
4764// /
0 commit comments