Changeset d9e1d1 for doc/userguide/userguide.xml

Timestamp:

Apr 23, 2021, 8:34:11 PM (5 years ago)

Author:

Frederik Heber <frederik.heber@…>

Branches:

Candidate_v1.7.0, stable

Children:

ef0f8f

Parents:

addb51

git-author:

Frederik Heber <frederik.heber@…> (10/03/20 21:20:26)

git-committer:

Frederik Heber <frederik.heber@…> (04/23/21 20:34:11)

Message:

Extending PairCorrelation to correlate element and set of atoms.

• one may also correlate an element with a selected set of atoms.
• TEST: Added regression test case.

File:

• doc/userguide/userguide.xml (modified) (1 diff)

doc/userguide/userguide.xml

@@ -1743 +1743 @@
           of a hydrogen and an oxygen atom can be found within its distance
           interval. These data files can be used for plotting the distribution right away in order to check on the correlation between the elements.</para>
+          <para>The action may also be called with just a single element in the
+          option <emphasis>elements</emphasis>. This will then trigger a pair
+          correlation between all atoms of this element and the set of 
+          currently selected atoms.</para>
         </section>
         <section xml:id="analysis.dipole-correlation">