It is only available if you configure PLUMED with ./configure –enable-modules=mapping . Furthermore, this feature is still being developed so take care when using it and report any problems on the mailing list.
Path collective variables with a more flexible framework for the distance metric being used.
The Path Collective Variables developed by Branduardi and co-workers [24] allow one to compute the progress along a high-dimensional path and the distance from the high-dimensional path. The progress along the path (s) is computed using:
In these expressions \(N\) high-dimensional frames ( \(X_i\)) are used to describe the path in the high-dimensional space. The two expressions above are then functions of the distances from each of the high-dimensional frames \(R[X - X_i]\). Within PLUMED there are multiple ways to define the distance from a high-dimensional configuration. You could calculate the RMSD distance or you could calculate the amount by which a set of collective variables change. As such this implementation of the path CV allows one to use all the difference distance metrics that are discussed in Distances from reference configurations. This is as opposed to the alternative implementation of path (PATHMSD) which is a bit faster but which only allows one to use the RMSD distance.
The \(s\) and \(z\) variables are calculated using the above formulas by default. However, there is an alternative method of calculating these collective variables, which is detailed in [38]. This alternative method uses the tools of geometry (as opposed to algebra, which is used in the equations above). In this alternative formula the progress along the path \(s\) is calculated using:
where \(\mathbf{v}_1\) and \(\mathbf{v}_3\) are the vectors connecting the current position to the closest and second closest node of the path, respectfully and \(i_1\) and \(i_2\) are the projections of the closest and second closest frames of the path. \(\mathbf{v}_2\), meanwhile, is the vector connecting the closest frame to the second closest frame. The distance from the path, \(z\) is calculated using:
The symbols here are as they were for \(s\). If you would like to use these equations to calculate \(s\) and \(z\) then you should use the GPATH flag. The values of \(s\) and \(z\) can then be referenced using the gspath and gzpath labels.
Examples
In the example below the path is defined using RMSD distance from frames.
Click on the labels of the actions for more information on what each action computes
( default=off ) This should be setted if you want MSD instead of RMSD
REFERENCE
compulsory keyword
a file in pdb format containing the reference structure and the atoms involved in
the CV
=file.pdb
TYPE
compulsory keyword ( default=SIMPLE )
the manner in which RMSD alignment is performed.
=OPTIMAL The RMSD action with label p1_data calculates a single scalar valuep1_mindist: LOWEST
ARG
compulsory keyword
the values input to this function
=p1_dataThe LOWEST action with label p1_mindist calculates a single scalar valuep1_weights: CUSTOM
ARG
compulsory keyword
the values input to this function
=p1_data,p1_mindist
FUNC
compulsory keyword
the function you wish to evaluate
=exp(-(x-y)*500.0)
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The CUSTOM action with label p1_weights calculates a single scalar valuep1_denom: SUM
ARG
compulsory keyword
the values input to this function
=p1_weights
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The SUM action with label p1_denom calculates a single scalar valuep1_z: CUSTOM
ARG
compulsory keyword
the values input to this function
=p1_denom,p1_mindist
FUNC
compulsory keyword
the function you wish to evaluate
=y-log(x)/500.0
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The CUSTOM action with label p1_z calculates a single scalar valuep1_zpath: COMBINE
ARG
compulsory keyword
the values input to this function
=p1_z
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The COMBINE action with label p1_zpath calculates a single scalar valuep1_ind: CONSTANT
VALUES
the numbers that are in your constant value
=1,2,3 The CONSTANT action with label p1_ind calculates a single scalar valuep1_s_prod: CUSTOM
ARG
compulsory keyword
the values input to this function
=p1_weights,p1_ind
FUNC
compulsory keyword
the function you wish to evaluate
=x*y
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The CUSTOM action with label p1_s_prod calculates a single scalar valuep1_numer: SUM
ARG
compulsory keyword
the values input to this function
=p1_s_prod
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The SUM action with label p1_numer calculates a single scalar valuep1_s: CUSTOM
ARG
compulsory keyword
the values input to this function
=p1_numer,p1_denom
FUNC
compulsory keyword
the function you wish to evaluate
=x/y
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The CUSTOM action with label p1_s calculates a single scalar valuep1_spath: COMBINE
ARG
compulsory keyword
the values input to this function
=p1_s
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The COMBINE action with label p1_spath calculates a single scalar valuePRINT
ARG
compulsory keyword
the labels of the values that you would like to print to the file
=p1.spath,p1.zpath
STRIDE
compulsory keyword ( default=1 )
the frequency with which the quantities of interest should be output
=1
FILE
the name of the file on which to output these quantities
=colvar
FMT
the format that should be used to output real numbers
=%8.4f The PRINT action with label
The reference frames in the path are defined in the pdb file shown below. In this frame each configuration in the path is separated by a line containing just the word END.
ATOM 1 CL ALA 1 -3.171 0.295 2.045 1.00 1.00
ATOM 5 CLP ALA 1 -1.819 -0.143 1.679 1.00 1.00
ATOM 6 OL ALA 1 -1.177 -0.889 2.401 1.00 1.00
ATOM 7 NL ALA 1 -1.313 0.341 0.529 1.00 1.00
END
ATOM 1 CL ALA 1 -3.175 0.365 2.024 1.00 1.00
ATOM 5 CLP ALA 1 -1.814 -0.106 1.685 1.00 1.00
ATOM 6 OL ALA 1 -1.201 -0.849 2.425 1.00 1.00
ATOM 7 NL ALA 1 -1.296 0.337 0.534 1.00 1.00
END
ATOM 1 CL ALA 1 -2.990 0.383 2.277 1.00 1.00
ATOM 5 CLP ALA 1 -1.664 -0.085 1.831 1.00 1.00
ATOM 6 OL ALA 1 -0.987 -0.835 2.533 1.00 1.00
ATOM 7 NL ALA 1 -1.227 0.364 0.646 1.00 1.00
END
In the example below the path is defined using the values of two torsional angles (t1 and t2). In addition, the \(s\) and \(z\) are calculated using the geometric expressions described above rather than the algebraic expressions that are used by default.
Click on the labels of the actions for more information on what each action computes
compulsory keyword
the values input to this function
=pp_gpath.s
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The COMBINE action with label pp_gspath calculates a single scalar valuepp_gzpath: COMBINE
ARG
compulsory keyword
the values input to this function
=pp_gpath.z
PERIODIC
compulsory keyword
if the output of your function is periodic then you should specify the periodicity
of the function.
=NO The COMBINE action with label pp_gzpath calculates a single scalar valuePRINT
ARG
compulsory keyword
the labels of the values that you would like to print to the file
=pp.*
FILE
the name of the file on which to output these quantities
=colvar The PRINT action with label
Notice that the LAMBDA parameter is not required here as we are not calculating \(s\) and \(s\) using the algebraic formulas defined earlier. The positions of the frames in the path are defined in the file epath.pdb. An extract from this file looks as shown below.
REMARK ARG=t1,t2 t1=-4.25053 t2=3.88053
END
REMARK ARG=t1,t2 t1=-4.11 t2=3.75
END
REMARK ARG=t1,t2 t1=-3.96947 t2=3.61947
END
The remarks in this pdb file tell PLUMED the labels that are being used to define the position in the high dimensional space and the values that these arguments have at each point on the path.
Glossary of keywords and components
Description of components
By default this Action calculates the following quantities. These quantities can be referenced elsewhere in the input by using this Action's label followed by a dot and the name of the quantity required from the list below.
Quantity
Description
spath
the position along the path calculated
zpath
the distance from the path calculated
In addition the following quantities can be calculated by employing the keywords listed below
Quantity
Keyword
Description
gspath
GPATH
the position along the path calculated using the geometric formula
gzpath
GPATH
the distance from the path calculated using the geometric formula
Compulsory keywords
REFERENCE
a pdb file containing the set of reference configurations
TYPE
( default=OPTIMAL-FAST ) the manner in which distances are calculated. More information on the different metrics that are available in PLUMED can be found in the section of the manual on Distances from reference configurations
LAMBDA
the lambda parameter is needed for smoothing, is in the units of plumed
Options
NOPBC
( default=off ) ignore the periodic boundary conditions when calculating distances
NOSPATH
( default=off ) do not calculate the spath CV
NOZPATH
( default=off ) do not calculate the zpath CV
GPATH
( default=off ) calculate the trigonometric path
ARG
the list of arguments you would like to use in your definition of the path
COEFFICIENTS
the coefficients of the displacements along each argument that should be used when calculating the euclidean distance
PROPERTY
the property to be used in the index. This should be in the REMARK of the reference