Skip to content

Commit

Permalink
Merge pull request #122 from brittonsmith/issue95
Browse files Browse the repository at this point in the history
Add documentation for CaseBRecombination parameter.
  • Loading branch information
brittonsmith committed Dec 5, 2022
2 parents 202f0b8 + 59e25e0 commit 1344750
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions doc/source/Parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,20 @@ For all on/off integer flags, 0 is off and 1 is on.
the dust grains for the calculation of the dust temperature.
Default: 1.7.

.. c:var:: int CaseBRecombination
Flag to use the Case B recombination rates (and associated cooling
rates) for H\ :sup:`+`, He\ :sup:`+`, and He\ :sup:`++` instead of
the Case A rates. Set to 1 for Case B and 0 for Case A. The Case A
rates include recombinations directly to the ground state (which
would result in emission of an ionizing photon) as well as
recombinations to excited states (which eventually reach the ground
state through lower energy transitions). The Case B rates exclude
recombinations directly to the ground state under the assumption
that the ionizing photon is reabsorbed. Hence, the Case B rates are
slightly lower than the Case A rates.
Default: 0.

.. c:var:: int Compton_xray_heating
Flag to enable Compton heating from an X-ray background following
Expand Down
2 changes: 1 addition & 1 deletion doc/source/RateFunctions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Example 2
""""""""""

The rate coefficient ``reHII`` can be calculated via two different methods depending on the
status of the ``CaseBRecombination`` parameter within the ``chemistry_data`` struct (named
status of the :c:data:`CaseBRecombination` parameter within the ``chemistry_data`` struct (named
``my_chemistry`` in this example), which can take values of either 0 or 1. Suppose we wish to compare
the results of each calculation method over an arbitrary temperature range, we can achieve this by
the following:
Expand Down

0 comments on commit 1344750

Please sign in to comment.