diff --git a/docs/io/configuration/components/plasma.rst b/docs/io/configuration/components/plasma.rst index bf0b5b3579d..448d0a48545 100644 --- a/docs/io/configuration/components/plasma.rst +++ b/docs/io/configuration/components/plasma.rst @@ -44,4 +44,15 @@ NLTE The NLTE configuration currently allows setting ``coronal_approximation``, which sets all :math:`J_\textrm{blue}` to 0. This is useful for debugging with :term:`chianti` for example. Furthermore, one can enable 'classical_nebular' to set all :math:`\beta_\textrm{Sobolev}` to 1. Both options are used for checking with other codes and should not be enabled in -normal operations. \ No newline at end of file +normal operations. + +NLTE Ionization +^^^^^^^^^^^^^^^ + +.. code-block:: yaml + + plasma: + nlte_ionization_species: [H I, H II, He I, He II] + +This option allows the user to specify which species should be included in the NLTE ionization treatment. Note that the +species must be present in the continuum interaction species as well. diff --git a/docs/physics/setup/plasma/index.rst b/docs/physics/setup/plasma/index.rst index 6d0c26ad7ff..06c4a2203c9 100644 --- a/docs/physics/setup/plasma/index.rst +++ b/docs/physics/setup/plasma/index.rst @@ -73,6 +73,9 @@ The next more complex class is `LTEPlasma` which will calculate the ionization b TARDIS also allows for NLTE treatments of specified species, as well as special NLTE treatments for Helium. +.. note:: + The NLTE treatment of specified species is currently incompatible with the NLTE treatment for helium and cannot be used simulataneously. + .. toctree:: :maxdepth: 2