Skip to content

Commit dbf7279

Browse files
committed
doc: Document handling of boundary conditions
1 parent 145bf83 commit dbf7279

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/colvars-refman-main.tex

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1495,15 +1495,16 @@
14951495

14961496
\cvsubsec{Treatment of periodic boundary conditions}{sec:cvc_pbcs}
14971497

1498-
In all colvar components described below, the following rules apply concerning periodic boundary
1499-
conditions (PBCs):
1498+
When copying over atomic coordinates from \MDENGINE, Colvars also copies its boundary conditions and unit cell vectors. Periodic or non-periodic boundary conditions are supported for each direction independently, thus allowing for mixed-periodicity conditions if \MDENGINE{} allows them. When using triclinic unit cells, tilt factors up to 1/2 are supported by looping over one additional layer of adjacent periodic images around the simulation cell to find the minimum image. The use of tilt factors beyond 1/2 is \emph{not recommended}, and may lead to slower performance\cvlammpsonly{ (LAMMPS will also print warnings to that sense)}.
1499+
1500+
For all colvar components implemented by Colvars internal code, the following rules apply:
15001501
\begin{enumerate}
15011502
\item Distance vectors between two coordinates
15021503
$\mathbf{d}_{i,j} = \left(\mathbf{x}_1 - \mathbf{x}_2\right)$, are calculated following the
15031504
minimum-image convention by default, unless \refkey{forceNoPBC}{colvar|cvc|forceNoPBC} is enabled.
15041505
($\mathbf{x}_1$ and $\mathbf{x}_2$ may be either individual atomic coordinates, or centers of mass
15051506
of two groups.)
1506-
\item For all other functions of individual atomic coordinates,
1507+
\item For all other functions of multiple atomic coordinates,
15071508
$f\left(\mathbf{x}_1, \mathbf{x}_2, \ldots\right)$, it is assumed that all atoms that are part of
15081509
the same group are in the same periodic unit cell (see \ref{sec:colvar_atom_groups_wrapping}).
15091510
\end{enumerate}
@@ -8211,6 +8212,9 @@
82118212
The legacy keyword \texttt{disableForces} for atom groups is now deprecated and will be discontinued in a future release.
82128213
Atom groups now have an automated way to save computation if forces are not used, and enabling this option otherwise would lead to incorrect behavior.
82138214
8215+
\item \textbf{Colvars version 2026-XX-XX or later.}\\
8216+
Periodic boundary conditions are handled internally, rather than using code by \MDENGINE{} to compute the minimum-image convention (see \ref{sec:cvc_pbcs}).
8217+
82148218
\end{itemize}
82158219
82168220

0 commit comments

Comments
 (0)