Skip to content
Snippets Groups Projects
Commit 1beb610f authored by Giovanni Bussi's avatar Giovanni Bussi
Browse files

Improved doc for COORDINATION and DHENERGY

parent 5e251d8e
No related branches found
No related tags found
No related merge requests found
...@@ -51,11 +51,12 @@ but it can be changed using the optional SWITCH option. ...@@ -51,11 +51,12 @@ but it can be changed using the optional SWITCH option.
To make your calculation faster you can use a neighbor list, which makes it that only a To make your calculation faster you can use a neighbor list, which makes it that only a
relevant subset of the pairwise distance are calculated at every step. relevant subset of the pairwise distance are calculated at every step.
If GROUPB is empty, it will sum the N*(N-1)/2 pairs in GROUPA. This avoids computing If GROUPB is empty, it will sum the \f$\frac{N(N-1)}{2}\f$ pairs in GROUPA. This avoids computing
twice permuted indexes (e.g. pair (i,j) and (j,i)) thus running at twice the speed. twice permuted indexes (e.g. pair (i,j) and (j,i)) thus running at twice the speed.
Notice that if there are common atoms between GROUPA and GROUPB the switching function should be Notice that if there are common atoms between GROUPA and GROUPB the switching function should be
equal to one. These "self interactions" are discarded by plumed (since version 2.1). equal to one. These "self contacts" are discarded by plumed (since version 2.1),
so that they actually count as "zero".
\par Examples \par Examples
......
...@@ -38,7 +38,7 @@ void CoordinationBase::registerKeywords( Keywords& keys ){ ...@@ -38,7 +38,7 @@ void CoordinationBase::registerKeywords( Keywords& keys ){
keys.add("optional","NL_CUTOFF","The cutoff for the neighbour list"); keys.add("optional","NL_CUTOFF","The cutoff for the neighbour list");
keys.add("optional","NL_STRIDE","The frequency with which we are updating the atoms in the neighbour list"); keys.add("optional","NL_STRIDE","The frequency with which we are updating the atoms in the neighbour list");
keys.add("atoms","GROUPA","First list of atoms"); keys.add("atoms","GROUPA","First list of atoms");
keys.add("atoms","GROUPB","Second list of atoms"); keys.add("atoms","GROUPB","Second list of atoms (if empty, N*(N-1)/2 pairs in GROUPA are counted)");
} }
CoordinationBase::CoordinationBase(const ActionOptions&ao): CoordinationBase::CoordinationBase(const ActionOptions&ao):
......
...@@ -47,7 +47,13 @@ using a Debye-Huckel approximation defined as ...@@ -47,7 +47,13 @@ using a Debye-Huckel approximation defined as
\f] \f]
This collective variable can be used to analyze or induce electrostatically driven reactions \cite do13jctc. This collective variable can be used to analyze or induce electrostatically driven reactions \cite do13jctc.
The two atom groups should be disjointed. Notice that the value of the DHENERGY is returned in plumed units (see \ref UNITS). Notice that the value of the DHENERGY is returned in plumed units (see \ref UNITS).
If GROUPB is empty, it will sum the N*(N-1)/2 pairs in GROUPA. This avoids computing
twice permuted indexes (e.g. pair (i,j) and (j,i)) thus running at twice the speed.
Notice that if there are common atoms between GROUPA and GROUPB their interaction is discarded.
\par Examples \par Examples
\verbatim \verbatim
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment