Shortcut: CLUSTER_DISTRIBUTION

Module clusters
Description Usage
Calculate functions of the distribution of properties in your connected components. used in 1 tutorialsused in 4 eggs

Output components

This action can calculate the values in the following table when the associated keyword is included in the input for the action. These values can be referenced elsewhere in the input by using this Action's label followed by a dot and the name of the value required from the list below.

Name Type Keyword Description
lessthan scalar LESS_THAN the number of colvars that have a value less than a threshold
morethan scalar MORE_THAN the number of colvars that have a value more than a threshold
altmin scalar ALT_MIN the minimum value of the cv
min scalar MIN the minimum colvar
max scalar MAX the maximum colvar
between scalar BETWEEN the number of colvars that have a value that lies in a particular interval
highest scalar HIGHEST the largest of the colvars
lowest scalar LOWEST the smallest of the colvars
sum scalar SUM the sum of the colvars
mean scalar MEAN the mean of the colvars

Further details and examples

Calculate functions of the distribution of properties in your connected components.

This shortcut action is present to ensure that inputs for older PLUMED versions remain compatible. We STRONGLY encourage you to use the newer (and simpler) syntax for clustering calculations Look at the documentation for CLUSTER_WEIGHTS and the expanded version of the input below to see how this new input syntax operates.

The input provided below calculates the local q6 Steinhardt parameter on each atom. The coordination number that atoms with a high value for the local q6 Steinhardt parameter have with other atoms that have a high value for the local q6 Steinhardt parameter is then computed. A contact matrix is then computed that measures whether atoms atoms i and j have a high value for this coordination number and if they are within 3.6 nm of each other. The connected components of this matrix are then found using a depth first clustering algorithm on the corresponding graph. The number of components in this graph that contain more than 27 atoms is then computed. An input similar to this one was used to analyze the formation of a polycrystal of GeTe from amorphous GeTe in the paper cited below

Click on the labels of the actions for more information on what each action computes
tested on2.11
q6: Q6Calculate sixth order Steinhardt parameters. This action is a shortcut. More details SPECIESthe list of atoms for which the symmetry function is being calculated and the atoms that can be in the environments=1-300 SWITCHthe switching function that it used in the construction of the contact matrix. Options for this keyword are explained in the documentation for LESS_THAN.={GAUSSIAN D_0=5.29 R_0=0.01 D_MAX=5.3}
lq6: LOCAL_Q6Calculate the local degree of order around an atoms by taking the average dot product between the q_6 vector on the central atom and the q_6 vector on the atoms in the first coordination sphere. This action is a shortcut. More details SPECIESthe label of the action that computes the Steinhardt parameters for which you would like to calculate local steinhardt parameters=q6 SWITCHThis keyword is used if you want to employ an alternative to the continuous swiching function defined above={GAUSSIAN D_0=5.29 R_0=0.01 D_MAX=5.3}
flq6: MORE_THANUse a switching function to determine how many of the input variables are more than a certain cutoff. More details ARGthe values input to this function=lq6 SWITCHThis keyword is used if you want to employ an alternative to the continuous swiching function defined above={GAUSSIAN D_0=0.19 R_0=0.01 D_MAX=0.2}
cc: COORDINATIONNUMBERCalculate the coordination numbers of atoms so that you can then calculate functions of the distribution of This action is a shortcut. More details SPECIESthe list of atoms for which the symmetry function is being calculated and the atoms that can be in the environments=1-300 SWITCHthe switching function that it used in the construction of the contact matrix. Options for this keyword are explained in the documentation for LESS_THAN.={GAUSSIAN D_0=3.59 R_0=0.01 D_MAX=3.6}
fcc: MORE_THANUse a switching function to determine how many of the input variables are more than a certain cutoff. More details ARGthe values input to this function=cc SWITCHThis keyword is used if you want to employ an alternative to the continuous swiching function defined above={GAUSSIAN D_0=5.99 R_0=0.01 D_MAX=6.0}
mat: CONTACT_MATRIXAdjacency matrix in which two atoms are adjacent if they are within a certain cutoff. More details GROUPspecifies the list of atoms that should be assumed indistinguishable=1-300 SWITCHthe input for the switching function that acts upon the distance between each pair of atoms. Options for this keyword are explained in the documentation for LESS_THAN.={GAUSSIAN D_0=3.59 R_0=0.01 D_MAX=3.6}
dfs: DFSCLUSTERINGFind the connected components of the matrix using the depth first search clustering algorithm. More details ARGthe input matrix=mat
nclust: CLUSTER_DISTRIBUTIONCalculate functions of the distribution of properties in your connected components. This action is a shortcut. More details ...
   CLUSTERSthe label of the action that does the clustering=dfs WEIGHTSuse the vector of values calculated by this action as weights rather than giving each atom a unit weight=fcc
   MORE_THANcalculate the number of variables that are more than a certain target value. Options for this keyword are explained in the documentation for MORE_THAN.={GAUSSIAN D_0=26.99 R_0=0.01 D_MAX=27}
...
PRINTPrint quantities to a file. More details ARGthe labels of the values that you would like to print to the file=nclust.* FILEthe name of the file on which to output these quantities=colvar

Syntax

The following table describes the keywords and options that can be used with this action

Keyword Type Default Description
CLUSTERS compulsory none the label of the action that does the clustering
WEIGHTS optional not used use the vector of values calculated by this action as weights rather than giving each atom a unit weight
LESS_THAN optional not used calculate the number of variables that are less than a certain target value. Options for this keyword are explained in the documentation for LESS_THAN.
MORE_THAN optional not used calculate the number of variables that are more than a certain target value. Options for this keyword are explained in the documentation for MORE_THAN.
ALT_MIN optional not used calculate the minimum value
MIN optional not used calculate the minimum value
MAX optional not used calculate the maximum value
BETWEEN optional not used calculate the number of values that are within a certain range. Options for this keyword are explained in the documentation for BETWEEN.
HIGHEST optional false this flag allows you to recover the highest of these variables
HISTOGRAM optional not used calculate a discretized histogram of the distribution of values
LOWEST optional false this flag allows you to recover the lowest of these variables
SUM optional false calculate the sum of all the quantities
MEAN optional false calculate the mean of all the quantities