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

Improved doc for COORDINATION and DHENERGY

parent 4cf0e392
No related branches found
No related tags found
No related merge requests found
...@@ -34,12 +34,19 @@ namespace colvar{ ...@@ -34,12 +34,19 @@ namespace colvar{
/* /*
Calculate coordination numbers. Calculate coordination numbers.
This keyword can be used to calculate the coordination numbers for atoms in your system. This keyword can be used to calculate the number of contacts between two groups of atoms
We use the following switching function to make the coordination number differentiable: and is defined as
\f[
\sum_{i\in A} \sum_{i\in B} s_{ij}
\f]
where \f$s_{ij}\f$ is 1 if the contact between atoms \f$i\f$ and \f$j\f$ is formed,
zero otherwise.
In practise, \f$s_{ij}\f$ is replaced with a switching function to make it differentiable.
The default switching function is:
\f[ \f[
s = \frac{ 1 - \left(\frac{r-d_0}{r_0}\right)^n } { 1 - \left(\frac{r-d_0}{r_0}\right)^m } s_{ij} = \frac{ 1 - \left(\frac{{\bf r}_{ij}-d_0}{r_0}\right)^n } { 1 - \left(\frac{{\bf r}_{ij}-d_0}{r_0}\right)^m }
\f] \f]
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.
......
...@@ -38,6 +38,14 @@ namespace colvar{ ...@@ -38,6 +38,14 @@ namespace colvar{
/* /*
Calculate Debye-Huckel interaction energy among GROUPA and GROUPB. Calculate Debye-Huckel interaction energy among GROUPA and GROUPB.
This variable calculates the electrostatic interaction among GROUPA and GROUPB
using a Debye-Huckel approximation defined as
\f[
\frac{1}{4\pi\epsilon_r\epsilon_0}
\sum_{i\in A} \sum_{j \in B} q_i q_j
\frac{e^{-\kappa |{\bf r}_{ij}|}}{|{\bf r}_{ij}|}
\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). The two atom groups should be disjointed. Notice that the value of the DHENERGY is returned in plumed units (see \ref UNITS).
......
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