Skip to content

Commit

Permalink
More formatting fixes to the doc
Browse files Browse the repository at this point in the history
[update-doc]
  • Loading branch information
giacomofiorin committed Dec 4, 2023
1 parent fe793b7 commit 00eae35
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 23 deletions.
33 changes: 17 additions & 16 deletions doc/colvars-refman-main.tex
Original file line number Diff line number Diff line change
Expand Up @@ -458,7 +458,7 @@
\cvsubsec{LAMMPS keywords}{sec:colvars_mdengine_parameters}

To enable a Colvars-based calculation, the following line must be added to the LAMMPS configuration file:
\begin{mdexampleinput}{}
\begin{mdexampleinput}
fix~Colvars~all~colvars~\emph{configfile}~[\emph{keyword value pairs ...}]
\end{mdexampleinput}
where the fix ID is here set to the string ``\texttt{Colvars}'', because there can only be one instance of \texttt{fix colvars} in a LAMMPS run.
Expand Down Expand Up @@ -645,13 +645,13 @@
\begin{enumerate}

\item Provide an updated value for the \textbf{parameters of the fix} listed in \ref{sec:colvars_mdengine_parameters}: this behavior is similar to that of several other LAMMPS fix styles, and follows the same argument parsing rules. For example, multiple keywords can be provided together:
\begin{mdexampleinput}{%
}fix\_modify~Colvars~\texttt{seed}~111111~\texttt{tstat}~\texttt{NPT}
\begin{mdexampleinput}
\-fix\_modify~Colvars~\texttt{seed}~111111~\texttt{tstat}~\texttt{NPT}
\end{mdexampleinput}

\item Use one of the \textbf{scripting functions} described in this section; the arguments provided as strings are passed to Colvars. LAMMPS variables referenced by their string representation, ``\texttt{\$\{variable\}}'', will be expanded immediately. Additionally, variable expansion \emph{will also happen within quotes}, similar to what the \texttt{mdi} command provides in a LAMMPS script: this feature makes it possible to use the values of certain LAMMPS variables in Colvars configuration strings (see \ref{sec:cv_command_init}).
\begin{mdexampleinput}{%
}variable~freq~index~10000\\
\begin{mdexampleinput}
\-variable~freq~index~10000\\
\-dump~myDump~all~atom/zstd~\$\{freq\}~dump.atom.zstd\\
\-fix\_modify~Colvars~config~"colvarsTrajFrequency~\$\{freq\}"
\end{mdexampleinput}
Expand Down Expand Up @@ -739,7 +739,7 @@
The vast majority of the syntax in Colvars is backward-compatible, adding keywords when new features are introduced.
However, when using multiple versions simultaneously it may be useful to test within the script whether the version is recent enough to support the desired feature.
The ``\texttt{version}'' can be used to get the Colvars version for this use:
\begin{mdexampleinput}{}
\begin{mdexampleinput}
\-if~\{~[cv~version]~>=~"2020-02-25"~\}~\{\\
\-~~cv~config~"(use~a~recent~feature)"\\
\-\}
Expand All @@ -765,7 +765,7 @@
\-structure~newsystem.psf\\
\-reinitatoms~$<$snapshot$>$\\
\-cv~reset\\
\-cv~configfile~...\\
\-cv~configfile~$<$new\_config$>$\\
\-cv~load~$<$snapshot$>$
\end{mdexampleinput}
} % \cvnamdonly
Expand All @@ -775,6 +775,7 @@
Because not only a state file (used to continue simulations) but also other data files (used to analyze the trajectory) are written, it is generally recommended to call the \texttt{save} method using a prefix, rather than a complete file name:
\cvscriptexampleinputcv{save}{"$<$job$>$"}


\cvsubsubsec{Accessing atomic data}{sec:cv_command_atomic_data}

For computational efficiency the Colvars module keeps internal copies of the numeric IDs, masses, charges, positions, and optionally total forces of the atoms requested for a Colvars computation.
Expand Down Expand Up @@ -892,7 +893,7 @@
\cvnamdonly{Another circumstance when ``\texttt{update}'' may be called e.g.{} as part of the function invoked by \refkey{scriptedColvarForces}{Colvars-global|scriptedColvarForces}, it is executed before any biasing forces are applied to the variables, thus allowing to modify them.
This use of ``\texttt{update}'' is often used e.g.{} in the definition of custom bias-exchange algorithms as part of the \MDENGINE{} script.
Because a restraint is a relatively light-weight object, the easiest way to change the configuration of an existing bias is deleting it and re-creating it:
\begin{mdexampleinput}{}
\begin{mdexampleinput}
\-{\bfseries\#~Delete~the~restraint~"harmonic\_xi"}\\
\-cv~bias~harmonic\_xi~delete\\
\-{\bfseries\#~Re-define~it,~but~using~an~updated~restraint~center}\\
Expand All @@ -905,7 +906,7 @@
\-cv~bias~harmonic\_xi~update
\end{mdexampleinput}
It is also possible to make the change subject to a condition on the energy of the new bias:
\begin{mdexampleinput}{}
\begin{mdexampleinput}
\-...\\
\-cv~bias~harmonic\_xi~update\\
\-if~\{~[cv~bias~harmonic\_xi~energy]~<~\$\{E\_accept\}~\}~\{\\
Expand Down Expand Up @@ -1069,16 +1070,16 @@

\cvlammpsonly{\cvsubsubsec{Restarting in LAMMPS.}{}
For continuing a Colvars-based simulation, the recommended method is using the standard LAMMPS \texttt{read\_restart} command, which reads the Colvars state data from the LAMMPS restart file (in binary format).
\begin{mdexampleinput}{}
\begin{mdexampleinput}
\-read\_restart~\emph{filename}
\end{mdexampleinput}
Alternatively, restarting from a Colvars-specific state file is also possible by providing the \texttt{input} keyword to the \texttt{fix colvars} command:
\begin{mdexampleinput}{}
\begin{mdexampleinput}
\-fix~Colvars~all~colvars~\emph{configfile}~input~\emph{input\_prefix}
\end{mdexampleinput}
When the ``\texttt{input}'' keyword is used, the contents of the file \texttt{$<$\emph{input\_prefix}$>$.colvar.state} override the information read from the LAMMPS restart file. Finally, a state file may also be loaded after initialization through the ``\texttt{fix\_modify}'' command:
\begin{mdexampleinput}{%
}fix\_modify~Colvars~\texttt{input}~\emph{new\_input\_prefix}
\begin{mdexampleinput}
\-fix\_modify~Colvars~\texttt{input}~\emph{new\_input\_prefix}
\end{mdexampleinput}
} % end \cvlammpsonly

Expand Down Expand Up @@ -3686,10 +3687,10 @@
Given a function of the Cartesian coordinates $\phi(\mathbf{x}) = \phi(x, y, z)$, a \texttt{mapTotal} collective variable component $\Phi(\mathbf{X})$ is defined as the sum of the values of the function $\phi(\mathbf{x})$ evaluated at the coordinates of each atom, $\mathbf{x}_{i}$:
\begin{equation}
\label{eq:cvc_map_total}
\Phi(\mathbf{X}) = \sum_{i=1}^{N} w_i \phi(\mathbf{x}_{i})
\Phi\left(\mathbf{X}\right) = \sum_{i=1}^{N} w_i \phi\left(\mathbf{x}_{i}\right)
\end{equation}
\noindent{}where $w_i$ are weights assigned to each variable (1 by default).
This formulation allows, for example, to ``count'' the number of atoms within a region of space by using a positive-valued function $\phi(\mathbf{x})$, such as for example the number of water molecules in a hydrophobic cavity \cite{Fiorin2020}.\\
This formulation allows, for example, to ``count'' the number of atoms within a region of space by using a positive-valued function $\phi\left(\mathbf{x}\right)$, such as for example the number of water molecules in a hydrophobic cavity \cite{Fiorin2020}.\\
Because the volumetric map itself and the atoms affected by it are defined externally to Colvars, this component has a very limited number of keywords.
Expand Down Expand Up @@ -3792,7 +3793,7 @@
The ``Multi-Map'' progress variable \cite{Fiorin2020} uses a weight sum of these components, using linearly-increasing weights:
\begin{equation}
\label{eq:cvc_multi_map}
\xi\left(\mathbf{X}\right) = \sum_{k=1}^{K} k \Phi_{k}(\mathbf{X}) = \sum_{k=1}^{K} k \sum_{i=1}^{N}\phi_{k}(\mathbf{x}_{i})
\xi\left(\mathbf{X}\right) = \sum_{k=1}^{K} k \Phi_{k}\left(\mathbf{X}\right) = \sum_{k=1}^{K} k \sum_{i=1}^{N}\phi_{k}\left(\mathbf{x}_{i}\right)
\end{equation}
\noindent{}where $K$ is the number of maps employed and each $\Phi_k$ is a \texttt{mapTotal} component.
Expand Down
20 changes: 13 additions & 7 deletions doc/colvars-refman.tex
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,10 @@

\definecolor{mdexample-border-color}{rgb}{1.0,0.6,0.1}
\definecolor{mdexample-background-color}{rgb}{1.0,0.96,0.9}
\newenvironment{mdexampleinput}[1]{%
\newenvironment{mdexampleinput}{%
\begin{mdframed}[%
linecolor=mdexample-border-color,linewidth=2pt,%
backgroundcolor=mdexample-background-color]
\textbf{#1}
\ifdefined\HCode\HCode{<pre>}\else\begin{ttfamily}\fi}{%
\ifdefined\HCode\HCode{</pre>}\else\end{ttfamily}\fi
\end{mdframed}
Expand All @@ -69,22 +68,29 @@
\end{mdframed}
}

% Note: the Python version is currently not built yet
\newcommand{\cvscriptexampleinputcv}[2]{%
% CLI interface
\def\cvscriptargsep{~}
\begin{mdexampleinput}{\ifdefined\cvscriptpyapi\textbf{With the ``\texttt{\cvscriptcmd{}}'' command:}\\\fi}%
\ifdefined\cvscriptpyapi%
\textbf{With the ``\texttt{\cvscriptcmd{}}'' command:}\\\fi
\begin{mdexampleinput}
\noindent\cvscriptcmd{}~#1~#2
\end{mdexampleinput}\ifdefined\cvscriptpyapi{%
\end{mdexampleinput}
% Python interface
\ifdefined\cvscriptpyapi%
\textbf{With the Python interface:}\\
\def\cvscriptargsep{,~}
\begin{mdexampleinput}{\textbf{With the Python interface:}\\}%
\begin{mdexampleinput}
from colvars import Colvarscript\\
cv = Colvarscript()\\
cv.#1(#2)
\end{mdexampleinput}}\fi
\end{mdexampleinput}\fi % end \ifdefined\cvscriptpyapi
}

\newcommand{\cvscriptexampleinputcolvar}[3]{%
\def\cvscriptargsep{~}
\begin{mdexampleinput}{}
\begin{mdexampleinput}
\noindent\cvscriptcmd{}~colvar~#3~#1~#2
\end{mdexampleinput}
}
Expand Down

0 comments on commit 00eae35

Please sign in to comment.