Skip to content
Snippets Groups Projects
Commit ffaf2a97 authored by Giovanni Bussi's avatar Giovanni Bussi
Browse files

Added more doc

parent 7a58ea84
No related branches found
No related tags found
No related merge requests found
...@@ -36,7 +36,9 @@ namespace colvar{ ...@@ -36,7 +36,9 @@ namespace colvar{
Calculate the components of the position of an atom. Calculate the components of the position of an atom.
Notice that single components will not have the proper periodicity! Notice that single components will not have the proper periodicity!
See \ref DISTANCE for a possible hack. If you need the values to be consistent through PBC you should use SCALED_COMPONENTS,
which defines values that by construction are in the -0.5,0.5 domain. This is
similar to the equivalent flag for \ref DISTANCE.
Also notice that by default the minimal image distance from the Also notice that by default the minimal image distance from the
origin is considered (can be changed with NOPBC). origin is considered (can be changed with NOPBC).
...@@ -50,6 +52,16 @@ and cell size and shapes are fixed through the simulation. ...@@ -50,6 +52,16 @@ and cell size and shapes are fixed through the simulation.
If you are not in this situation and still want to use the absolute position of an atom you should first fix the reference frame. If you are not in this situation and still want to use the absolute position of an atom you should first fix the reference frame.
This can be done e.g. using \ref FIT_TO_TEMPLATE. This can be done e.g. using \ref FIT_TO_TEMPLATE.
\par Examples
\verbatim
# align to a template
FIT_TO_TEMPLATE REFERENCE=ref.pdb
p: POSITION ATOM=3
PRINT ARG=p.x,p.y,p.z
\endverbatim
(see also \ref FIT_TO_TEMPLATE)
*/ */
//+ENDPLUMEDOC //+ENDPLUMEDOC
......
...@@ -43,10 +43,24 @@ namespace generic{ ...@@ -43,10 +43,24 @@ namespace generic{
/* /*
This action is used to align a molecule to a template. This action is used to align a molecule to a template.
This can be used to move the coordinates stored in plumed
so as to be aligned with a provided template in pdb format. Pdb should contain
also weights for alignment (see the format of pdb files used e.g. for \ref RMSD).
Weights for displacement are ignored, since no displacement is computed here.
Notice that all atoms (not only those in the template) are aligned. Notice that all atoms (not only those in the template) are aligned.
To see what effect try To see what effect try
the \ref DUMPATOMS directive to output the atomic positions. the \ref DUMPATOMS directive to output the atomic positions.
Also notice that PLUMED propagate forces correctly so that you can add a bias on a CV computed
after alignment. For many CVs this has no effect, but in some case the alignment can
change the result. Examples are:
- \ref POSITION CV since it is affected by a rigid shift of the system.
- \ref DISTANCE CV with COMPONENTS. Since the alignment could involve a rotation (with TYPE=OPTIMAL) the actual components could be different
from the original ones.
- \ref CELL components for a similar reason.
In the present implementation only TYPE=SIMPLE is implemented. As a consequence, only \ref POSITION CV can be affected by the fit.
\attention \attention
This directive modifies the stored position at the precise moment This directive modifies the stored position at the precise moment
it is executed. This means that only collective variables it is executed. This means that only collective variables
...@@ -55,6 +69,20 @@ As a general rule, put it at the top of the input file. Also, unless you ...@@ -55,6 +69,20 @@ As a general rule, put it at the top of the input file. Also, unless you
know exactly what you are doing, leave the default stride (1), so that know exactly what you are doing, leave the default stride (1), so that
this action is performed at every MD step. this action is performed at every MD step.
\par Examples
Align the atomic position to a template then print them
\verbatim
# to see the effect, one could dump the atoms before alignment
DUMPATOMS FILE=dump-before.xyz ATOMS=1-20
FIT_TO_TEMPLATE STRIDE=1 REFERENCE=ref.pdb TYPE=SIMPLE
DUMPATOMS FILE=dump-after.xyz ATOMS=1-20
\endverbatim
(see also \ref DUMPATOMS)
*/ */
//+ENDPLUMEDOC //+ENDPLUMEDOC
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment