Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update plasma configuration documentation #2459

Merged
merged 4 commits into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .mailmap
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Alexander Holas <[email protected]>
Alexander Holas <[email protected]>
Alexander Holas <[email protected]> AlexHls <[email protected]>
Alexander Holas <[email protected]> AlexHls <[email protected]>
Alexander Holas <[email protected]>

Alice Harpole <[email protected]>
Alice Harpole <[email protected]> Alice Harpole <[email protected]>
Expand Down
23 changes: 21 additions & 2 deletions docs/io/configuration/components/plasma.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ ionization equilibrium and level population calculations (see :ref:`plasma` for
The radiative rates describe how to calculate the :math:`J_\textrm{blue}` needed for the :ref:`nlte` calculations and
:ref:`macroatom` calculations. There are three options for ``radiative_rates_type``:

1) ``lte``, in which
1) ``blackbody``, in which
:math:`J_\textrm{blue} = \textrm{Blackbody}(T_\textrm{rad})`

2) ``nebular`` in which
2) ``dilute-blackbody`` in which
:math:`J_\textrm{blue} = W \times \textrm{Blackbody}(T_\textrm{rad})`

3) ``detailed`` in which the :math:`J_\textrm{blue}`
Expand All @@ -32,6 +32,25 @@ version of ``macroatom`` in which only downward transitions are allowed (see :re
Finally, ``w_epsilon`` describes the dilution factor to use to calculate :math:`J_\textrm{blue}` that are 0, which
causes problems with the code (so :math:`J_\textrm{blue}` are set to a very small number).

Continuum Interaction
^^^^^^^^^^^^^^^^^^^^^

.. code-block:: yaml

plasma:
link_t_rad_t_electron: 1.0
continuum_interaction:
species:
- H I
- H II
- He I
- He II
enable_adiabatic_cooling: True

This will add continuum interactions for all specified species. Setting :math:`T_\textrm{rad} = T_\textrm{electron}` through
``link_t_rad_t_electron: 1.0`` is recommended to enforce LTE (unless the simulation uses NLTE treatment).
``enable_adiabatic_cooling`` enables adiabatic cooling.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sonachitchyan / @chvogl Could you maybe add some more context for the enable_adiabatic_cooling option and generally check that what I wrote here is not completely wrong? Any additional explanations are welcome!


NLTE
^^^^

Expand Down
Loading