diff --git a/doc/PDF/colvars-refman-lammps.pdf b/doc/PDF/colvars-refman-lammps.pdf new file mode 100644 index 0000000000..133ef16f79 Binary files /dev/null and b/doc/PDF/colvars-refman-lammps.pdf differ diff --git a/doc/fix_colvars.html b/doc/fix_colvars.html index c622a6ff4f..5aa30bb707 100644 --- a/doc/fix_colvars.html +++ b/doc/fix_colvars.html @@ -44,30 +44,38 @@ module library which allows to calculate potentials of mean force (PMFs) for any set of colvars, using different sampling methods: currently implemented are the Adaptive Biasing Force (ABF) method, metadynamics, Steered Molecular Dynamics (SMD) and Umbrella Sampling -(US) via a flexible harmonic restraint bias. This documentation -describes only the colvars fix itself and LAMMPS specific parts of the -code. The documentation of the colvars implementation itself is -available as part of the NAMD online -documentation +(US) via a flexible harmonic restraint bias. The colvars library is +hosted at http://colvars.github.io/

-

There are example scripts for using this package with LAMMPS in -examples/USER/colvars. +

This documentation describes only the fix colvars command itself and +LAMMPS specific parts of the code. The full documentation of the +colvars library is available as this supplementary PDF document

-

The implementation of the portable collective variable library is also -documented in (Henin) +

A detailed discussion of the implementation of the portable collective +variable library is in (Fiorin). Additional information can +be found in (Henin). +

+

There are some example scripts for using this package with LAMMPS in the +examples/USER/colvars directory.


The only mandatory argument to the fix is the filename to the colvars -input file that contains all input that is independent from the MD +input file that contains the input that is independent from the MD program in which the colvars library has been integrated.

The group-ID entry is ignored. The collective variable module will -always apply to the entire system, i.e. use the group all. +always apply to the entire system and there can only be one instance +of the colvars fix at a time. The colvars fix will only communicate +the minimum information necessary and the colvars library supports +multiple, completely independent collective variables, so there is +no restriction to functionaliry by limiting the number of colvars fixes.

The input keyword allows to specify a state file that would contain -the information required in order to continue a calculation, e.g. -from a restart. Setting it to NULL will start a new colvars run. +the restart information required in order to continue a calculation from +a prerecorded state. Fix colvars records it state in binary restart +files, so when using the read_restart command, +this is usually not needed.

The output keyword allows to specify the output prefix. All output files generated will use this prefix followed by the ".colvars." and @@ -90,8 +98,10 @@ temperature.

Restart, fix_modify, output, run start/stop, minimize info:

-

No information about this fix is written to binary restart -files. +

This fix writes the current status of the colvars module into +binary restart files. This is in addition to the text +mode status file that is written by the colvars module itself and the +kind of information in both files is identical.

The fix_modify energy option is supported by this fix to add the energy change from the biasing force added by the fix @@ -109,10 +119,10 @@ calculated by this fix is "extensive". LAMMPS was built with that package. See the Making LAMMPS section for more info.

-

There can only be one colvars fix active at a time. Since the -colvars module itself can handle an arbitrary number of collective -variables and always applies to the entire system, this is not -really a deficit in practice. +

There can only be one colvars fix active at a time. Since the interface +communicates only the minimum amount of information and colvars module +itself can handle an arbitrary number of collective variables, this is +not a limitation of functionality.

Related commands:

@@ -125,9 +135,13 @@ and tstat = NULL.


+ + +

(Fiorin) Fiorin , Klein, Henin, Mol. Phys., DOI:10.1080/00268976.2013.813594 +

-

(Henin) Hénin, Fiorin, Chipot, Klein, J. Chem. Theory Comput., 6, +

(Henin) Henin, Fiorin, Chipot, Klein, J. Chem. Theory Comput., 6, 35-47 (2010)

diff --git a/doc/fix_colvars.txt b/doc/fix_colvars.txt index caf04c14a9..7e8f35922d 100644 --- a/doc/fix_colvars.txt +++ b/doc/fix_colvars.txt @@ -36,30 +36,38 @@ module library which allows to calculate potentials of mean force (PMFs) for any set of colvars, using different sampling methods: currently implemented are the Adaptive Biasing Force (ABF) method, metadynamics, Steered Molecular Dynamics (SMD) and Umbrella Sampling -(US) via a flexible harmonic restraint bias. This documentation -describes only the colvars fix itself and LAMMPS specific parts of the -code. The documentation of the colvars implementation itself is -available as part of the "NAMD online -documentation"_http://www.ks.uiuc.edu/Research/namd/2.8/ug/node53.html +(US) via a flexible harmonic restraint bias. The colvars library is +hosted at "http://colvars.github.io/"_http://colvars.github.io/ -There are example scripts for using this package with LAMMPS in -examples/USER/colvars. +This documentation describes only the fix colvars command itself and +LAMMPS specific parts of the code. The full documentation of the +colvars library is available as "this supplementary PDF document"_PDF/colvars-refman-lammps.pdf -The implementation of the portable collective variable library is also -documented in "(Henin)"_#Henin +A detailed discussion of the implementation of the portable collective +variable library is in "(Fiorin)"_#Fiorin. Additional information can +be found in "(Henin)"_#Henin. + +There are some example scripts for using this package with LAMMPS in the +examples/USER/colvars directory. :line The only mandatory argument to the fix is the filename to the colvars -input file that contains all input that is independent from the MD +input file that contains the input that is independent from the MD program in which the colvars library has been integrated. The {group-ID} entry is ignored. The collective variable module will -always apply to the entire system, i.e. use the group {all}. +always apply to the entire system and there can only be one instance +of the colvars fix at a time. The colvars fix will only communicate +the minimum information necessary and the colvars library supports +multiple, completely independent collective variables, so there is +no restriction to functionaliry by limiting the number of colvars fixes. The {input} keyword allows to specify a state file that would contain -the information required in order to continue a calculation, e.g. -from a restart. Setting it to NULL will start a new colvars run. +the restart information required in order to continue a calculation from +a prerecorded state. Fix colvars records it state in "binary restart"_restart.html +files, so when using the "read_restart"_read_restart.html command, +this is usually not needed. The {output} keyword allows to specify the output prefix. All output files generated will use this prefix followed by the ".colvars." and @@ -82,8 +90,10 @@ temperature. [Restart, fix_modify, output, run start/stop, minimize info:] -No information about this fix is written to "binary restart -files"_restart.html. +This fix writes the current status of the colvars module into +"binary restart files"_restart.html. This is in addition to the text +mode status file that is written by the colvars module itself and the +kind of information in both files is identical. The "fix_modify"_fix_modify.html {energy} option is supported by this fix to add the energy change from the biasing force added by the fix @@ -101,10 +111,10 @@ This fix is part of the USER-COLVARS package. It is only enabled if LAMMPS was built with that package. See the "Making LAMMPS"_Section_start.html#start_3 section for more info. -There can only be one colvars fix active at a time. Since the -colvars module itself can handle an arbitrary number of collective -variables and always applies to the entire system, this is not -really a deficit in practice. +There can only be one colvars fix active at a time. Since the interface +communicates only the minimum amount of information and colvars module +itself can handle an arbitrary number of collective variables, this is +not a limitation of functionality. [Related commands:] @@ -117,7 +127,10 @@ and tstat = NULL. :line +:link(Fiorin) +[(Fiorin)] Fiorin , Klein, Henin, Mol. Phys., DOI:10.1080/00268976.2013.813594 + :link(Henin) -[(Henin)] Hénin, Fiorin, Chipot, Klein, J. Chem. Theory Comput., 6, +[(Henin)] Henin, Fiorin, Chipot, Klein, J. Chem. Theory Comput., 6, 35-47 (2010) diff --git a/doc/group2ndx.html b/doc/group2ndx.html new file mode 100644 index 0000000000..3fb0670fcd --- /dev/null +++ b/doc/group2ndx.html @@ -0,0 +1,58 @@ + +
LAMMPS WWW Site - LAMMPS Documentation - LAMMPS Commands +
+ + + + + + +
+ +

group2ndx command +

+

Syntax: +

+
group2ndx file group-ID ... 
+
+ +

Examples: +

+
group2ndx allindex.ndx
+group2ndx someindex.ndx upper lower mobile 
+
+

Description: +

+

Write a Gromacs style index file in text format that associates atom IDs +with the corresponding group definitions. This index file can be used +with in combination with Gromacs analysis tools or to import group +definitions into the fix colvars input file. +

+

Without specifying any group IDs, all groups will be written to the index +file. When specifying group IDs, only those groups will be written to the +index file. In order to follow the Gromacs conventions, the group all +will be renamed to System in the index file. +

+
+ +

Restrictions: +

+

This command requires that atoms have atom IDs, since this is the +information that is written to the index file. +

+

This fix is part of the USER-COLVARS package. It is only enabled if +LAMMPS was built with that package. See the Making +LAMMPS section for more info. +

+

Related commands: +

+

group, dump, fix colvars +

+

Default: none +

+ diff --git a/doc/group2ndx.txt b/doc/group2ndx.txt new file mode 100644 index 0000000000..d40d4399f9 --- /dev/null +++ b/doc/group2ndx.txt @@ -0,0 +1,51 @@ +"LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c + +:link(lws,http://lammps.sandia.gov) +:link(ld,Manual.html) +:link(lc,Section_commands.html#comm) + +:line + +group2ndx command :h3 + +[Syntax:] + +group2ndx file group-ID ... :pre + +file = name of index file to write out :ulb,l +zero or more group IDs may be appended :l +:ule + +[Examples:] + +group2ndx allindex.ndx +group2ndx someindex.ndx upper lower mobile :pre + +[Description:] + +Write a Gromacs style index file in text format that associates atom IDs +with the corresponding group definitions. This index file can be used +with in combination with Gromacs analysis tools or to import group +definitions into the "fix colvars"_fix_colvars.html input file. + +Without specifying any group IDs, all groups will be written to the index +file. When specifying group IDs, only those groups will be written to the +index file. In order to follow the Gromacs conventions, the group {all} +will be renamed to {System} in the index file. + +:line + +[Restrictions:] + +This command requires that atoms have atom IDs, since this is the +information that is written to the index file. + +This fix is part of the USER-COLVARS package. It is only enabled if +LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. + +[Related commands:] + +"group"_group.html, "dump"_dump.html, "fix colvars"_fix_colvars.html + +[Default:] none