Skip to content

Commit

Permalink
Added documentation to many actions to fix problems higlighted by ccp…
Browse files Browse the repository at this point in the history
…check
  • Loading branch information
Gareth Aneurin Tribello authored and Gareth Aneurin Tribello committed Jan 28, 2024
1 parent 28e01c0 commit f8fa5c8
Show file tree
Hide file tree
Showing 122 changed files with 1,575 additions and 92 deletions.
3 changes: 2 additions & 1 deletion src/adjmat/AdjacencyMatrixBase.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ AdjacencyMatrixBase::AdjacencyMatrixBase(const ActionOptions& ao):
read_one_group(false),
neighbour_list_updated(false),
linkcells(comm),
threecells(comm)
threecells(comm),
natoms_per_list(0)
{
std::vector<unsigned> shape(2); std::vector<AtomNumber> t; parseAtomList("GROUP", t );
if( t.size()==0 ) {
Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/Bridge.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@
#include "core/ActionShortcut.h"
#include "core/ActionRegister.h"

//+PLUMEDOC MCOLVAR BRIDGE
/*
Calculate a matrix with elements equal to one if there is a bridging atom between the two atoms
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/Determinent.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@
#include "core/ActionRegister.h"
#include "core/ActionShortcut.h"

//+PLUMEDOC MCOLVAR DETERMINANT
/*
Calculate the determinant of a matrix
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/DiagonalizeMatrix.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@
#include "MatrixOperationBase.h"
#include "core/ActionRegister.h"

//+PLUMEDOC ANALYSIS DIAGONALIZE
/*
Calculate the eigenvalues and eigenvectors of a square matrix
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
63 changes: 63 additions & 0 deletions src/adjmat/FunctionOfMatrix.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,69 @@
#include "function/Custom.h"
#include "function/Combine.h"

//+PLUMEDOC COLVAR SUM_MATRIX
/*
Sum all the elements in a matrix
\par Examples
*/
//+ENDPLUMEDOC

//+PLUMEDOC COLVAR LESS_THAN_MATRIX
/*
Transform all the elements of a matrix using a switching function that is one when the input value is smaller than a threshold
\par Examples
*/
//+ENDPLUMEDOC

//+PLUMEDOC COLVAR MORE_THAN_MATRIX
/*
Transform all the elements of a matrix using a switching function that is one when the input value is larger than a threshold
\par Examples
*/
//+ENDPLUMEDOC

//+PLUMEDOC COLVAR BETWEEN_MATRIX
/*
Transform all the elements of a matrix using a switching function that is oen when the input value is within a particular range
\par Examples
*/
//+ENDPLUMEDOC

//+PLUMEDOC COLVAR CUSTOM_MATRIX
/*
Calculate an arbitrary function piecewise for one or multiple input matrices.
\par Examples
*/
//+ENDPLUMEDOC

//+PLUMEDOC COLVAR MATHEVAL_MATRIX
/*
Calculate an arbitrary function piecewise for one or multiple input matrices.
\par Examples
*/
//+ENDPLUMEDOC

//+PLUMEDOC COLVAR COMBINE_MATRIX
/*
Calculate the sum of a number of matrices
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/InvertMatrix.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@
#include "core/ActionSetup.h"
#include "core/ActionRegister.h"

//+PLUMEDOC MCOLVAR INVERT_MATRIX
/*
Calculate the inverse of the input matrix
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/MatrixTimesMatrix.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@
#include "AdjacencyMatrixBase.h"
#include "core/ActionRegister.h"

//+PLUMEDOC MCOLVAR MATRIX_PRODUCT
/*
Calculate the product of two matrices
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/MatrixTimesVector.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@
#include "ActionWithMatrix.h"
#include "core/ActionRegister.h"

//+PLUMEDOC MCOLVAR MATRIX_VECTOR_PRODUCT
/*
Calculate the product of the matrix and the vector
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/Neighbors.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@
#include "ActionWithMatrix.h"
#include "core/ActionRegister.h"

//+PLUMEDOC MCOLVAR NEIGHBORS
/*
Build a matrix with ones in for the N nearest neighbours of an atom
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/OuterProduct.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@
#include "core/ActionRegister.h"
#include "tools/LeptonCall.h"

//+PLUMEDOC COLVAR OUTER_PRODUCT
/*
Calculate the outer product matrix of two vectors
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
2 changes: 1 addition & 1 deletion src/adjmat/TopologyMatrix.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ class TopologyMatrix : public AdjacencyMatrixBase {
SwitchingFunction switchingFunction;
SwitchingFunction cylinder_sw;
SwitchingFunction low_sf;
double beadrad, lsfmax, binw_mat;
double binw_mat;
SwitchingFunction threshold_switch;
public:
static void registerKeywords( Keywords& keys );
Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/TorsionsMatrix.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@
#include "core/ActionRegister.h"
#include "tools/Torsion.h"

//+PLUMEDOC MCOLVAR TORSIONS_MATRIX
/*
Calculate the matrix of torsions between two vectors of molecules
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/TransposeMatrix.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@
#include "MatrixOperationBase.h"
#include "core/ActionRegister.h"

//+PLUMEDOC MCOLVAR TRANSPOSE
/*
Calculate the transpose of a matrix
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/adjmat/VStack.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,15 @@
#include "ActionWithMatrix.h"
#include "core/ActionRegister.h"

//+PLUMEDOC MCOLVAR VSTACK
/*
Create a matrix by stacking vectors together
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace adjmat {

Expand Down
9 changes: 9 additions & 0 deletions src/analysis/Accumulate.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@
#include "core/ActionSet.h"
#include "gridtools/ActionWithGrid.h"

//+PLUMEDOC GRIDCALC ACCUMULATE
/*
Sum the elements of this value over the course of the trajectory
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace analysis {

Expand Down
9 changes: 9 additions & 0 deletions src/analysis/Collect.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@
#include "core/ActionSet.h"
#include "gridtools/ActionWithGrid.h"

//+PLUMEDOC ANALYSIS COLLECT
/*
Collect data from the trajectory for later analysis
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace analysis {

Expand Down
10 changes: 10 additions & 0 deletions src/analysis/GatherReplicas.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@
#include "core/ActionRegister.h"
#include "tools/Communicator.h"

//+PLUMEDOC ANALYSIS GATHER_REPLICAS
/*
Create a vector that contains the copies of the input quantities from all replicas
\par Examples
*/
//+ENDPLUMEDOC

namespace PLMD {
namespace analysis {

Expand Down
10 changes: 10 additions & 0 deletions src/bias/LWalls.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,16 @@ PRINT ARG=uwall.bias,lwall.bias
*/
//+ENDPLUMEDOC

//+PLUMEDOC BIAS LOWER_WALLS_SCALAR
/*
Defines a wall for the value of one or more collective variables,
which limits the region of the phase space accessible during the simulation.
\par Examples
*/
//+ENDPLUMEDOC

class LWalls : public Bias {
std::vector<double> at;
std::vector<double> kappa;
Expand Down
9 changes: 9 additions & 0 deletions src/bias/Restraint.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,15 @@ PRINT ARG=restraint.bias
*/
//+ENDPLUMEDOC

//+PLUMEDOC BIAS RESTRAINT_SCALAR
/*
Adds harmonic and/or linear restraints on one or more scalar variables.
\par Examples
*/
//+ENDPLUMEDOC

class Restraint : public Bias {
std::vector<double> at;
std::vector<double> kappa;
Expand Down
10 changes: 10 additions & 0 deletions src/bias/UWalls.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@ PRINT ARG=uwall.bias,lwall.bias
*/
//+ENDPLUMEDOC

//+PLUMEDOC BIAS UPPER_WALLS_SCALAR
/*
Defines a wall for the value of one or more collective variables,
which limits the region of the phase space accessible during the simulation.
\par Examples
*/
//+ENDPLUMEDOC

class UWalls : public Bias {
std::vector<double> at;
std::vector<double> kappa;
Expand Down
14 changes: 11 additions & 3 deletions src/clusters/ClusterDistribution.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -62,16 +62,24 @@ PRINT ARG=nclust.* FILE=colvar
*/
//+ENDPLUMEDOC

//+PLUMEDOC CONCOMP CLUSTER_DISTRIBUTION_CALC
/*
Calculate functions of the distribution of properties in your connected components.
See \ref CLUSTER_DISTRIBUTION
\par Examples
*/
//+ENDPLUMEDOC


namespace PLMD {
namespace clusters {

class ClusterDistribution :
public ActionWithArguments,
public ActionWithValue {
private:
/// The cluster we are looking for
unsigned clustr;
public:
/// Create manual
static void registerKeywords( Keywords& keys );
Expand Down
Loading

1 comment on commit f8fa5c8

@PlumedBot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found broken examples in automatic/a-masterclass-22-09.txt
Found broken examples in automatic/a-masterclass-22-11.txt
Found broken examples in automatic/a-masterclass-22-12.txt
Found broken examples in automatic/aaaa-lugano-2.txt
Found broken examples in automatic/aaaa-lugano-6a.txt
Found broken examples in automatic/performance-optimization.txt
Found broken examples in automatic/a-trieste-2.txt
Found broken examples in automatic/a-trieste-3.txt
Found broken examples in automatic/a-trieste-6.txt
Found broken examples in automatic/munster.txt
Found broken examples in automatic/ves-lugano2017-01-metad.txt
Found broken examples in automatic/ANGLES.tmp
Found broken examples in automatic/ANN.tmp
Found broken examples in automatic/AROUND.tmp
Found broken examples in automatic/CAVITY.tmp
Found broken examples in automatic/CLUSTER_DIAMETER.tmp
Found broken examples in automatic/CLUSTER_DISTRIBUTION.tmp
Found broken examples in automatic/CLUSTER_PROPERTIES.tmp
Found broken examples in automatic/CONSTANT.tmp
Found broken examples in automatic/CONTACT_MATRIX.tmp
Found broken examples in automatic/CONVERT_TO_FES.tmp
Found broken examples in automatic/COORDINATIONNUMBER.tmp
Found broken examples in automatic/DFSCLUSTERING.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/ENVIRONMENTSIMILARITY.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/FOURIER_TRANSFORM.tmp
Found broken examples in automatic/FUNCPATHGENERAL.tmp
Found broken examples in automatic/FUNCPATHMSD.tmp
Found broken examples in automatic/FUNNEL.tmp
Found broken examples in automatic/FUNNEL_PS.tmp
Found broken examples in automatic/GHBFIX.tmp
Found broken examples in automatic/HBOND_MATRIX.tmp
Found broken examples in automatic/HISTOGRAM.tmp
Found broken examples in automatic/INCLUDE.tmp
Found broken examples in automatic/INCYLINDER.tmp
Found broken examples in automatic/INENVELOPE.tmp
Found broken examples in automatic/INSPHERE.tmp
Found broken examples in automatic/INTERPOLATE_GRID.tmp
Found broken examples in automatic/LOCAL_AVERAGE.tmp
Found broken examples in automatic/LOCAL_Q3.tmp
Found broken examples in automatic/LOCAL_Q4.tmp
Found broken examples in automatic/LOCAL_Q6.tmp
Found broken examples in automatic/MAZE_MEMETIC_SAMPLING.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_RANDOM_WALK.tmp
Found broken examples in automatic/MAZE_SIMULATED_ANNEALING.tmp
Found broken examples in automatic/MAZE_STEERED_MD.tmp
Found broken examples in automatic/MULTICOLVARDENS.tmp
Found broken examples in automatic/OUTPUT_CLUSTER.tmp
Found broken examples in automatic/PAMM.tmp
Found broken examples in automatic/PARABETARMSD.tmp
Found broken examples in automatic/PIV.tmp
Found broken examples in automatic/PLUMED.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/SPRINT.tmp
Found broken examples in automatic/TETRAHEDRALPORE.tmp
Found broken examples in automatic/TORSION.tmp
Found broken examples in automatic/TORSIONS.tmp
Found broken examples in automatic/WHAM_HISTOGRAM.tmp
Found broken examples in automatic/WHAM_WEIGHTS.tmp
Found broken examples in AnalysisPP.md
Found broken examples in CollectiveVariablesPP.md
Found broken examples in MiscelaneousPP.md

Please sign in to comment.