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

document the Debye-Huckel screening #1723

Merged
merged 2 commits into from
Jan 27, 2025
Merged
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
16 changes: 16 additions & 0 deletions Docs/source/screening.rst
Original file line number Diff line number Diff line change
@@ -94,6 +94,22 @@ The options are:
weak screening regime, :math:`\Gamma < 0.1`, and strong screening regime,
:math:`1 \lesssim \Gamma \lesssim 160`.

.. index:: screening.enable_debye_huckel_skip, screening.debye_huckel_skip_threshold

* ``debye_huckel`` :

This is just the Debye-Hückel weak-screening limit from
:cite:`chugunov:2009`.

While it can be used on its own (by building with
``SCREEN_METHOD=debye_huckel``, it is really meant to be used as a
test to determine whether a more extensive screening approximation
should be used. By setting ``screening.enable_debye_huckel_skip``,
we first compute this weak-screening approximation and then, if it
is larger than ``screening.debye_huckel_skip_threshold``, the full
screening factor is computed (using the method specified via
``SCREEN_METHOD``).

* ``null`` :

This disables screening by always returning 1 for the screening