Skip to content

Commit c3e4566

Browse files
authored
document the Debye-Huckel screening (#1723)
1 parent e3b281a commit c3e4566

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

Docs/source/screening.rst

+16
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,22 @@ The options are:
9494
weak screening regime, :math:`\Gamma < 0.1`, and strong screening regime,
9595
:math:`1 \lesssim \Gamma \lesssim 160`.
9696

97+
.. index:: screening.enable_debye_huckel_skip, screening.debye_huckel_skip_threshold
98+
99+
* ``debye_huckel`` :
100+
101+
This is just the Debye-Hückel weak-screening limit from
102+
:cite:`chugunov:2009`.
103+
104+
While it can be used on its own (by building with
105+
``SCREEN_METHOD=debye_huckel``, it is really meant to be used as a
106+
test to determine whether a more extensive screening approximation
107+
should be used. By setting ``screening.enable_debye_huckel_skip``,
108+
we first compute this weak-screening approximation and then, if it
109+
is larger than ``screening.debye_huckel_skip_threshold``, the full
110+
screening factor is computed (using the method specified via
111+
``SCREEN_METHOD``).
112+
97113
* ``null`` :
98114

99115
This disables screening by always returning 1 for the screening

0 commit comments

Comments
 (0)