Skip to content

Commit b35dc7f

Browse files
author
Gareth Aneurin Tribello
committedJan 31, 2025·
Fixed a couple of small things in manual pages for symfunc actions
1 parent ee44f9a commit b35dc7f

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed
 

‎src/symfunc/CoordinationNumbers.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ one hundred atoms with themselves:
5656
5757
```plumed
5858
c: COORDINATIONNUMBER SPECIES=1-100 R_0=1.0
59-
DUMPXYZ ATOMS=c ARG=c FILE=coords.xyz
59+
DUMPATOMS ATOMS=c ARG=c FILE=coords.xyz
6060
```
6161
6262
This input will produce an output file called coords that contains the coordination numbers of the 100 input atoms. The cutoff

‎src/symfunc/Steinhardt.cpp

+12-12
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ As discussed on [this page](https://www.plumed-tutorials.org/lessons/23/001/data
5353
be used to measure the degree of order in the system in a variety of different ways. The
5454
simplest way of measuring whether or not the coordination sphere is ordered is to simply take the norm of the above vector i.e.
5555
56-
\f[
56+
$$
5757
Q_1(i) = \sqrt{ \sum_{m=-1}^1 q_{1m}(i)^{*} q_{1m}(i) }
58-
\f]
58+
$$
5959
6060
This norm is small when the coordination shell is disordered and larger when the coordination shell is ordered. Furthermore, in inputs like
6161
the one shown below where the keywords LESS_THAN, MIN, MAX, HISTOGRAM, MEAN and so on are used with it is the distribution of these normed quantities
@@ -92,7 +92,7 @@ atoms, columns 2-4 will then contain the x, y and z positions of the atoms, colu
9292
9393
```plumed
9494
q1: Q1 SPECIESA=1-64 SPECIESB=65-128 D_0=1.3 R_0=0.2 MEAN
95-
DUMPATOMS ATOMS=q1 ARG=q1_anorm FILE=q1.xyz
95+
DUMPATOMS ATOMS=q1 ARG=q1 FILE=q1.xyz
9696
```
9797
9898
*/
@@ -119,9 +119,9 @@ As discussed on [this page](https://www.plumed-tutorials.org/lessons/23/001/data
119119
be used to measure the degree of order in the system in a variety of different ways. The
120120
simplest way of measuring whether or not the coordination sphere is ordered is to simply take the norm of the above vector i.e.
121121
122-
\f[
122+
$$
123123
Q_3(i) = \sqrt{ \sum_{m=-3}^3 q_{3m}(i)^{*} q_{3m}(i) }
124-
\f]
124+
$$
125125
126126
This norm is small when the coordination shell is disordered and larger when the coordination shell is ordered. Furthermore, in inputs like
127127
the one shown below where the keywords LESS_THAN, MIN, MAX, HISTOGRAM, MEAN and so on are used with it is the distribution of these normed quantities
@@ -158,7 +158,7 @@ atoms, columns 2-4 will then contain the x, y and z positions of the atoms, colu
158158
159159
```plumed
160160
q3: Q3 SPECIESA=1-64 SPECIESB=65-128 D_0=1.3 R_0=0.2 MEAN
161-
DUMPATOMS ATOMS=q3 ARG=q3_anorm FILE=q3.xyz
161+
DUMPATOMS ATOMS=q3 ARG=q3 FILE=q3.xyz
162162
```
163163
164164
*/
@@ -185,9 +185,9 @@ As discussed on [this page](https://www.plumed-tutorials.org/lessons/23/001/data
185185
be used to measure the degree of order in the system in a variety of different ways. The
186186
simplest way of measuring whether or not the coordination sphere is ordered is to simply take the norm of the above vector i.e.
187187
188-
\f[
188+
$$
189189
Q_4(i) = \sqrt{ \sum_{m=-4}^4 q_{4m}(i)^{*} q_{4m}(i) }
190-
\f]
190+
$$
191191
192192
This norm is small when the coordination shell is disordered and larger when the coordination shell is ordered. Furthermore, in inputs like
193193
the one shown below where the keywords LESS_THAN, MIN, MAX, HISTOGRAM, MEAN and so on are used with it is the distribution of these normed quantities
@@ -224,7 +224,7 @@ atoms, columns 2-4 will then contain the x, y and z positions of the atoms, colu
224224
225225
```plumed
226226
q4: Q4 SPECIESA=1-64 SPECIESB=65-128 D_0=1.3 R_0=0.2 MEAN
227-
DUMPATOMS ATOMS=q4 ARG=q4_anorm FILE=q4.xyz
227+
DUMPATOMS ATOMS=q4 ARG=q4 FILE=q4.xyz
228228
```
229229
230230
*/
@@ -251,9 +251,9 @@ As discussed on [this page](https://www.plumed-tutorials.org/lessons/23/001/data
251251
be used to measure the degree of order in the system in a variety of different ways. The
252252
simplest way of measuring whether or not the coordination sphere is ordered is to simply take the norm of the above vector i.e.
253253
254-
\f[
254+
$$
255255
Q_6(i) = \sqrt{ \sum_{m=-6}^6 q_{6m}(i)^{*} q_{6m}(i) }
256-
\f]
256+
$$
257257
258258
This norm is small when the coordination shell is disordered and larger when the coordination shell is ordered. Furthermore, in inputs like
259259
the one shown below where the keywords LESS_THAN, MIN, MAX, HISTOGRAM, MEAN and so on are used with it is the distribution of these normed quantities
@@ -290,7 +290,7 @@ atoms, columns 2-4 will then contain the x, y and z positions of the atoms, colu
290290
291291
```plumed
292292
q6: Q6 SPECIESA=1-64 SPECIESB=65-128 D_0=1.3 R_0=0.2 MEAN
293-
DUMPATOMS ATOMS=q6 ARG=q6_anorm FILE=q6.xyz
293+
DUMPATOMS ATOMS=q6 ARG=q6 FILE=q6.xyz
294294
```
295295
296296
*/

1 commit comments

Comments
 (1)

PlumedBot commented on Jan 31, 2025

@PlumedBot
Contributor

Found broken examples in automatic/ANN.tmp
Found broken examples in automatic/CLASSICAL_MDS.tmp
Found broken examples in automatic/CONVERT_TO_FES.tmp
Found broken examples in automatic/DISTANCE_FROM_CONTOUR.tmp
Found broken examples in automatic/DUMPCUBE.tmp
Found broken examples in automatic/DUMPGRID.tmp
Found broken examples in automatic/EDS.tmp
Found broken examples in automatic/EMMI.tmp
Found broken examples in automatic/FIND_CONTOUR.tmp
Found broken examples in automatic/FIND_CONTOUR_SURFACE.tmp
Found broken examples in automatic/FIND_SPHERICAL_CONTOUR.tmp
Found broken examples in automatic/FUNNEL.tmp
Found broken examples in automatic/FUNNEL_PS.tmp
Found broken examples in automatic/GPROPERTYMAP.tmp
Found broken examples in automatic/HISTOGRAM.tmp
Found broken examples in automatic/INTERPOLATE_GRID.tmp
Found broken examples in automatic/MAZE_OPTIMIZER_BIAS.tmp
Found broken examples in automatic/MAZE_RANDOM_ACCELERATION_MD.tmp
Found broken examples in automatic/MAZE_SIMULATED_ANNEALING.tmp
Found broken examples in automatic/MAZE_STEERED_MD.tmp
Found broken examples in automatic/METATENSOR.tmp
Found broken examples in automatic/MULTICOLVARDENS.tmp
Found broken examples in automatic/PCA.tmp
Found broken examples in automatic/PCAVARS.tmp
Found broken examples in automatic/PIV.tmp
Found broken examples in automatic/PYCVINTERFACE.tmp
Found broken examples in automatic/PYTHONFUNCTION.tmp
Found broken examples in automatic/QUATERNION.tmp
Found broken examples in automatic/REWEIGHT_BIAS.tmp
Found broken examples in automatic/REWEIGHT_METAD.tmp
Found broken examples in automatic/SIZESHAPE_POSITION_LINEAR_PROJ.tmp
Found broken examples in automatic/SIZESHAPE_POSITION_MAHA_DIST.tmp
Found broken examples in AnalysisPP.md
Found broken examples in CollectiveVariablesPP.md
Found broken examples in MiscelaneousPP.md

Please sign in to comment.