Shortcut: CLUSTER_DISTRIBUTION
Module |
clusters |
Description |
Usage |
Calculate functions of the distribution of properties in your connected components. |
  |
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
q6The Q6 action with label q6 calculates the following quantities: Quantity | Type | Description |
q6 | vector | the norms of the vectors of spherical harmonic coefficients |
: 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}
# q6: Q6 SPECIES=1-300 SWITCH={GAUSSIAN D_0=5.29 R_0=0.01 D_MAX=5.3}
q6_grpThe GROUP action with label q6_grp calculates the following quantities: Quantity | Type | Description |
q6_grp | atoms | indices of atoms specified in GROUP |
: GROUPDefine a group of atoms so that a particular list of atoms can be referenced with a single label in definitions of CVs or virtual atoms. More details ATOMSthe numerical indexes for the set of atoms in the group=1-300
q6_matThe CONTACT_MATRIX action with label q6_mat calculates the following quantities: Quantity | Type | Description |
q6_mat.w | matrix | a matrix containing the weights for the bonds between each pair of atoms |
q6_mat.x | matrix | the projection of the bond on the x axis |
q6_mat.y | matrix | the projection of the bond on the y axis |
q6_mat.z | matrix | the projection of the bond on the z axis |
: 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=5.29 R_0=0.01 D_MAX=5.3} COMPONENTS also calculate the components of the vectors connecting the atoms in the contact matrix
q6_shThe SPHERICAL_HARMONIC action with label q6_sh calculates the following quantities: Quantity | Type | Description |
q6_sh.rm-n6 | matrix | the real parts of the spherical harmonic values with the m value given This is the n6th of these quantities |
q6_sh.rm-n5 | matrix | the real parts of the spherical harmonic values with the m value given This is the n5th of these quantities |
q6_sh.rm-n4 | matrix | the real parts of the spherical harmonic values with the m value given This is the n4th of these quantities |
q6_sh.rm-n3 | matrix | the real parts of the spherical harmonic values with the m value given This is the n3th of these quantities |
q6_sh.rm-n2 | matrix | the real parts of the spherical harmonic values with the m value given This is the n2th of these quantities |
q6_sh.rm-n1 | matrix | the real parts of the spherical harmonic values with the m value given This is the n1th of these quantities |
q6_sh.rm-0 | matrix | the real parts of the spherical harmonic values with the m value given This is the 0th of these quantities |
q6_sh.rm-p1 | matrix | the real parts of the spherical harmonic values with the m value given This is the p1th of these quantities |
q6_sh.rm-p2 | matrix | the real parts of the spherical harmonic values with the m value given This is the p2th of these quantities |
q6_sh.rm-p3 | matrix | the real parts of the spherical harmonic values with the m value given This is the p3th of these quantities |
q6_sh.rm-p4 | matrix | the real parts of the spherical harmonic values with the m value given This is the p4th of these quantities |
q6_sh.rm-p5 | matrix | the real parts of the spherical harmonic values with the m value given This is the p5th of these quantities |
q6_sh.rm-p6 | matrix | the real parts of the spherical harmonic values with the m value given This is the p6th of these quantities |
q6_sh.im-n6 | matrix | the real parts of the spherical harmonic values with the m value given This is the n6th of these quantities |
q6_sh.im-n5 | matrix | the real parts of the spherical harmonic values with the m value given This is the n5th of these quantities |
q6_sh.im-n4 | matrix | the real parts of the spherical harmonic values with the m value given This is the n4th of these quantities |
q6_sh.im-n3 | matrix | the real parts of the spherical harmonic values with the m value given This is the n3th of these quantities |
q6_sh.im-n2 | matrix | the real parts of the spherical harmonic values with the m value given This is the n2th of these quantities |
q6_sh.im-n1 | matrix | the real parts of the spherical harmonic values with the m value given This is the n1th of these quantities |
q6_sh.im-0 | matrix | the real parts of the spherical harmonic values with the m value given This is the 0th of these quantities |
q6_sh.im-p1 | matrix | the real parts of the spherical harmonic values with the m value given This is the p1th of these quantities |
q6_sh.im-p2 | matrix | the real parts of the spherical harmonic values with the m value given This is the p2th of these quantities |
q6_sh.im-p3 | matrix | the real parts of the spherical harmonic values with the m value given This is the p3th of these quantities |
q6_sh.im-p4 | matrix | the real parts of the spherical harmonic values with the m value given This is the p4th of these quantities |
q6_sh.im-p5 | matrix | the real parts of the spherical harmonic values with the m value given This is the p5th of these quantities |
q6_sh.im-p6 | matrix | the real parts of the spherical harmonic values with the m value given This is the p6th of these quantities |
: SPHERICAL_HARMONICCalculate the values of all the spherical harmonic funtions for a particular value of l. More details ARGthe values input to this function=q6_mat.x,q6_mat.y,q6_mat.z,q6_mat.w Lthe value of the angular momentum=6
q6_denom_onesThe CONSTANT action with label q6_denom_ones calculates the following quantities: Quantity | Type | Description |
q6_denom_ones | vector | the constant value that was read from the plumed input |
: ONESCreate a constant vector with all elements equal to one More details SIZEthe number of ones that you would like to create=300
q6_denomThe MATRIX_VECTOR_PRODUCT action with label q6_denom calculates the following quantities: Quantity | Type | Description |
q6_denom | vector | the vector that is obtained by taking the product between the matrix and the vector that were input |
: MATRIX_VECTOR_PRODUCTCalculate the product of the matrix and the vector More details ARGthe label for the matrix and the vector/scalar that are being multiplied=q6_mat.w,q6_denom_ones
q6_spThe MATRIX_VECTOR_PRODUCT action with label q6_sp calculates the following quantities: Quantity | Type | Description |
q6_sp.rm-n6 | vector | the product of the matrix q6_sh.rm-n6 and the vector q6_denom_ones |
q6_sp.rm-n5 | vector | the product of the matrix q6_sh.rm-n5 and the vector q6_denom_ones |
q6_sp.rm-n4 | vector | the product of the matrix q6_sh.rm-n4 and the vector q6_denom_ones |
q6_sp.rm-n3 | vector | the product of the matrix q6_sh.rm-n3 and the vector q6_denom_ones |
q6_sp.rm-n2 | vector | the product of the matrix q6_sh.rm-n2 and the vector q6_denom_ones |
q6_sp.rm-n1 | vector | the product of the matrix q6_sh.rm-n1 and the vector q6_denom_ones |
q6_sp.rm-0 | vector | the product of the matrix q6_sh.rm-0 and the vector q6_denom_ones |
q6_sp.rm-p1 | vector | the product of the matrix q6_sh.rm-p1 and the vector q6_denom_ones |
q6_sp.rm-p2 | vector | the product of the matrix q6_sh.rm-p2 and the vector q6_denom_ones |
q6_sp.rm-p3 | vector | the product of the matrix q6_sh.rm-p3 and the vector q6_denom_ones |
q6_sp.rm-p4 | vector | the product of the matrix q6_sh.rm-p4 and the vector q6_denom_ones |
q6_sp.rm-p5 | vector | the product of the matrix q6_sh.rm-p5 and the vector q6_denom_ones |
q6_sp.rm-p6 | vector | the product of the matrix q6_sh.rm-p6 and the vector q6_denom_ones |
q6_sp.im-n6 | vector | the product of the matrix q6_sh.im-n6 and the vector q6_denom_ones |
q6_sp.im-n5 | vector | the product of the matrix q6_sh.im-n5 and the vector q6_denom_ones |
q6_sp.im-n4 | vector | the product of the matrix q6_sh.im-n4 and the vector q6_denom_ones |
q6_sp.im-n3 | vector | the product of the matrix q6_sh.im-n3 and the vector q6_denom_ones |
q6_sp.im-n2 | vector | the product of the matrix q6_sh.im-n2 and the vector q6_denom_ones |
q6_sp.im-n1 | vector | the product of the matrix q6_sh.im-n1 and the vector q6_denom_ones |
q6_sp.im-0 | vector | the product of the matrix q6_sh.im-0 and the vector q6_denom_ones |
q6_sp.im-p1 | vector | the product of the matrix q6_sh.im-p1 and the vector q6_denom_ones |
q6_sp.im-p2 | vector | the product of the matrix q6_sh.im-p2 and the vector q6_denom_ones |
q6_sp.im-p3 | vector | the product of the matrix q6_sh.im-p3 and the vector q6_denom_ones |
q6_sp.im-p4 | vector | the product of the matrix q6_sh.im-p4 and the vector q6_denom_ones |
q6_sp.im-p5 | vector | the product of the matrix q6_sh.im-p5 and the vector q6_denom_ones |
q6_sp.im-p6 | vector | the product of the matrix q6_sh.im-p6 and the vector q6_denom_ones |
: MATRIX_VECTOR_PRODUCTCalculate the product of the matrix and the vector More details ARGthe label for the matrix and the vector/scalar that are being multiplied=q6_sh.*,q6_denom_ones
q6_norm2The COMBINE action with label q6_norm2 calculates the following quantities: Quantity | Type | Description |
q6_norm2 | vector | the vector obtained by doing an element-wise application of a linear compbination to the input vectors |
: COMBINECalculate a polynomial combination of a set of other variables. More details PERIODICif the output of your function is periodic then you should specify the periodicity of the function=NO POWERS the powers to which you are raising each of the arguments in your function=2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2 ARGthe values input to this function=q6_sp.rm-n6,q6_sp.im-n6,q6_sp.rm-n5,q6_sp.im-n5,q6_sp.rm-n4,q6_sp.im-n4,q6_sp.rm-n3,q6_sp.im-n3,q6_sp.rm-n2,q6_sp.im-n2,q6_sp.rm-n1,q6_sp.im-n1,q6_sp.rm-0,q6_sp.im-0,q6_sp.rm-p1,q6_sp.im-p1,q6_sp.rm-p2,q6_sp.im-p2,q6_sp.rm-p3,q6_sp.im-p3,q6_sp.rm-p4,q6_sp.im-p4,q6_sp.rm-p5,q6_sp.im-p5,q6_sp.rm-p6,q6_sp.im-p6
q6_normThe CUSTOM action with label q6_norm calculates the following quantities: Quantity | Type | Description |
q6_norm | vector | the vector obtained by doing an element-wise application of an arbitrary function to the input vectors |
: CUSTOMCalculate a combination of variables using a custom expression. More details ARGthe values input to this function=q6_norm2 FUNCthe function you wish to evaluate=sqrt(x) PERIODICif the output of your function is periodic then you should specify the periodicity of the function=NO
q6The CUSTOM action with label q6 calculates the following quantities: Quantity | Type | Description |
q6 | vector | the vector obtained by doing an element-wise application of an arbitrary function to the input vectors |
: CUSTOMCalculate a combination of variables using a custom expression. More details ARGthe values input to this function=q6_norm,q6_denom FUNCthe function you wish to evaluate=x/y PERIODICif the output of your function is periodic then you should specify the periodicity of the function=NO
# --- End of included input --- lq6The LOCAL_Q6 action with label lq6 calculates the following quantities: Quantity | Type | Description |
lq6 | vector | the values of the local steinhardt parameters for the input atoms |
: 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}
# lq6: LOCAL_Q6 SPECIES=q6 SWITCH={GAUSSIAN D_0=5.29 R_0=0.01 D_MAX=5.3}
lq6_uvecThe CONSTANT action with label lq6_uvec calculates the following quantities: Quantity | Type | Description |
lq6_uvec | vector | the constant value that was read from the plumed input |
: ONESCreate a constant vector with all elements equal to one More details SIZEthe number of ones that you would like to create=26
lq6_grpThe GROUP action with label lq6_grp calculates the following quantities: Quantity | Type | Description |
lq6_grp | atoms | indices of atoms specified in GROUP |
: GROUPDefine a group of atoms so that a particular list of atoms can be referenced with a single label in definitions of CVs or virtual atoms. More details ATOMSthe numerical indexes for the set of atoms in the group=q6
lq6_nmatThe OUTER_PRODUCT action with label lq6_nmat calculates the following quantities: Quantity | Type | Description |
lq6_nmat | matrix | a matrix containing the outer product of the two input vectors that was obtained using the function that was input |
: OUTER_PRODUCTCalculate the outer product matrix of two vectors More details ARGthe labels of the two vectors from which the outer product is being computed=q6_norm,lq6_uvec
lq6_uvecsThe VSTACK action with label lq6_uvecs calculates the following quantities: Quantity | Type | Description |
lq6_uvecs | matrix | a matrix that contains the input vectors in its columns |
: VSTACKCreate a matrix by stacking vectors together More details ARGthe values that you would like to stack together to construct the output matrix=q6_sp.rm-n6,q6_sp.im-n6,q6_sp.rm-n5,q6_sp.im-n5,q6_sp.rm-n4,q6_sp.im-n4,q6_sp.rm-n3,q6_sp.im-n3,q6_sp.rm-n2,q6_sp.im-n2,q6_sp.rm-n1,q6_sp.im-n1,q6_sp.rm-0,q6_sp.im-0,q6_sp.rm-p1,q6_sp.im-p1,q6_sp.rm-p2,q6_sp.im-p2,q6_sp.rm-p3,q6_sp.im-p3,q6_sp.rm-p4,q6_sp.im-p4,q6_sp.rm-p5,q6_sp.im-p5,q6_sp.rm-p6,q6_sp.im-p6
lq6_vecsThe CUSTOM action with label lq6_vecs calculates the following quantities: Quantity | Type | Description |
lq6_vecs | matrix | the matrix obtained by doing an element-wise application of an arbitrary function to the input matrix |
: CUSTOMCalculate a combination of variables using a custom expression. More details ARGthe values input to this function=lq6_uvecs,lq6_nmat FUNCthe function you wish to evaluate=x/y PERIODICif the output of your function is periodic then you should specify the periodicity of the function=NO
lq6_vecsTThe TRANSPOSE action with label lq6_vecsT calculates the following quantities: Quantity | Type | Description |
lq6_vecsT | matrix | the transpose of the input matrix |
: TRANSPOSECalculate the transpose of a matrix More details ARGthe label of the vector or matrix that should be transposed=lq6_vecs
lq6_cmapThe CONTACT_MATRIX action with label lq6_cmap calculates the following quantities: Quantity | Type | Description |
lq6_cmap | matrix | a matrix containing the weights for the bonds between each pair of atoms |
: 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=q6 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=5.29 R_0=0.01 D_MAX=5.3}
lq6_dpmatThe MATRIX_PRODUCT action with label lq6_dpmat calculates the following quantities: Quantity | Type | Description |
lq6_dpmat | matrix | the product of the two input matrices |
: MATRIX_PRODUCTCalculate the product of two matrices More details ARGthe label of the two matrices from which the product is calculated=lq6_vecs,lq6_vecsT
lq6_prodThe CUSTOM action with label lq6_prod calculates the following quantities: Quantity | Type | Description |
lq6_prod | matrix | the matrix obtained by doing an element-wise application of an arbitrary function to the input matrix |
: CUSTOMCalculate a combination of variables using a custom expression. More details ARGthe values input to this function=lq6_cmap,lq6_dpmat FUNCthe function you wish to evaluate=x*y PERIODICif the output of your function is periodic then you should specify the periodicity of the function=NO
lq6_onesThe CONSTANT action with label lq6_ones calculates the following quantities: Quantity | Type | Description |
lq6_ones | vector | the constant value that was read from the plumed input |
: ONESCreate a constant vector with all elements equal to one More details SIZEthe number of ones that you would like to create=300
lq6The MATRIX_VECTOR_PRODUCT action with label lq6 calculates the following quantities: Quantity | Type | Description |
lq6 | vector | the vector that is obtained by taking the product between the matrix and the vector that were input |
: MATRIX_VECTOR_PRODUCTCalculate the product of the matrix and the vector More details ARGthe label for the matrix and the vector/scalar that are being multiplied=lq6_prod,lq6_ones
lq6_denomThe MATRIX_VECTOR_PRODUCT action with label lq6_denom calculates the following quantities: Quantity | Type | Description |
lq6_denom | vector | the vector that is obtained by taking the product between the matrix and the vector that were input |
: MATRIX_VECTOR_PRODUCTCalculate the product of the matrix and the vector More details ARGthe label for the matrix and the vector/scalar that are being multiplied=lq6_cmap,lq6_ones
lq6_avThe CUSTOM action with label lq6_av calculates the following quantities: Quantity | Type | Description |
lq6_av | vector | the vector obtained by doing an element-wise application of an arbitrary function to the input vectors |
: CUSTOMCalculate a combination of variables using a custom expression. More details ARGthe values input to this function=lq6,lq6_denom FUNCthe function you wish to evaluate=x/y PERIODICif the output of your function is periodic then you should specify the periodicity of the function=NO
# --- End of included input --- flq6The MORE_THAN action with label flq6 calculates the following quantities: Quantity | Type | Description |
flq6 | vector | the vector obtained by doing an element-wise application of a function that is one if the if the input is more than a threshold to the input vectors |
: 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}
ccThe COORDINATIONNUMBER action with label cc calculates the following quantities: Quantity | Type | Description |
cc | vector | the coordination numbers of the specified atoms |
: 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}
# cc: COORDINATIONNUMBER SPECIES=1-300 SWITCH={GAUSSIAN D_0=3.59 R_0=0.01 D_MAX=3.6}
cc_grpThe GROUP action with label cc_grp calculates the following quantities: Quantity | Type | Description |
cc_grp | atoms | indices of atoms specified in GROUP |
: GROUPDefine a group of atoms so that a particular list of atoms can be referenced with a single label in definitions of CVs or virtual atoms. More details ATOMSthe numerical indexes for the set of atoms in the group=1-300
cc_matThe CONTACT_MATRIX action with label cc_mat calculates the following quantities: Quantity | Type | Description |
cc_mat | matrix | a matrix containing the weights for the bonds between each pair of atoms |
: 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}
cc_onesThe CONSTANT action with label cc_ones calculates the following quantities: Quantity | Type | Description |
cc_ones | vector | the constant value that was read from the plumed input |
: ONESCreate a constant vector with all elements equal to one More details SIZEthe number of ones that you would like to create=300
ccThe MATRIX_VECTOR_PRODUCT action with label cc calculates the following quantities: Quantity | Type | Description |
cc | vector | the vector that is obtained by taking the product between the matrix and the vector that were input |
: MATRIX_VECTOR_PRODUCTCalculate the product of the matrix and the vector More details ARGthe label for the matrix and the vector/scalar that are being multiplied=cc_mat,cc_ones
cc_caverageThe MEAN action with label cc_caverage calculates the following quantities: Quantity | Type | Description |
cc_caverage | scalar | the mean of all the elements in the input vector |
: MEANCalculate the arithmetic mean of the elements in a vector More details ARGthe values input to this function=cc PERIODICif the output of your function is periodic then you should specify the periodicity of the function=NO
# --- End of included input --- fccThe MORE_THAN action with label fcc calculates the following quantities: Quantity | Type | Description |
fcc | vector | the vector obtained by doing an element-wise application of a function that is one if the if the input is more than a threshold to the input vectors |
: 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}
matThe CONTACT_MATRIX action with label mat calculates the following quantities: Quantity | Type | Description |
mat | matrix | a matrix containing the weights for the bonds between each pair of atoms |
: 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}
dfsThe DFSCLUSTERING action with label dfs calculates the following quantities: Quantity | Type | Description |
dfs | vector | vector with length that is equal to the number of rows in the input matrix. Elements of this vector are equal to the cluster that each node is a part of |
: DFSCLUSTERINGFind the connected components of the matrix using the depth first search clustering algorithm. More details ARGthe input matrix=mat
nclustThe CLUSTER_DISTRIBUTION action with label nclust calculates the following quantities: Quantity | Type | Description |
nclust_morethan | scalar | the number of colvars that have a value more than a threshold |
: 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}
...
# nclust: CLUSTER_DISTRIBUTION ...
nclust_mtThe MORE_THAN action with label nclust_mt calculates the following quantities: Quantity | Type | Description |
nclust_mt | vector | the vector obtained by doing an element-wise application of a function that is one if the if the input is more than a threshold to the input vectors |
: 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=nclust SWITCHThis keyword is used if you want to employ an alternative to the continuous swiching function defined above={GAUSSIAN D_0=26.99 R_0=0.01 D_MAX=27}
nclust_morethanThe SUM action with label nclust_morethan calculates the following quantities: Quantity | Type | Description |
nclust_morethan | scalar | the sum of all the elements in the input vector |
: SUMCalculate the sum of the arguments More details ARGthe values input to this function=nclust_mt PERIODICif the output of your function is periodic then you should specify the periodicity of the function=NO
# --- End of included input --- 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 |