doc/src/fix_mscg.txt

   1 "LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
   2
   3 :link(lws,http://lammps.sandia.gov)
   4 :link(ld,Manual.html)
   5 :link(lc,Section_commands.html#comm)
   6
   7 :line
   8
   9 fix mscg command :h3
  10
  11 [Syntax:]
  12
  13 fix ID group-ID mscg N keyword args ... :pre
  14
  15 ID, group-ID are documented in "fix"_fix.html command :ulb,l
  16 mscg = style name of this fix command :l
  17 N = envoke this fix every this many timesteps :l
  18 zero or more keyword/value pairs may be appended :l
  19 keyword = {range} or {name} or {max} :l
  20   {range} arg = {on} or {off}
  21     {on} = range finding functionality is performed
  22     {off} = force matching functionality is performed
  23   {name} args = name1 ... nameN
  24     name1,...,nameN = string names for each atom type (1-Ntype)
  25   {max} args = maxb maxa maxd
  26     maxb,maxa,maxd = maximum bonds/angles/dihedrals per atom :pre
  27 :ule
  28
  29 [Examples:]
  30
  31 fix 1 all mscg 1
  32 fix 1 all mscg 1 range name A B
  33 fix 1 all mscg 1 max 4 8 20 :pre
  34
  35 [Description:]
  36
  37 This fix applies the Multi-Scale Coarse-Graining (MSCG) method to
  38 snapshots from a dump file to generate potentials for coarse-grained
  39 simulations from all-atom simulations, using a force-matching
  40 technique ("Izvekov"_#Izvekov, "Noid"_#Noid).
  41
  42 It makes use of the MS-CG library, written and maintained by Greg
  43 Voth's group at the University of Chicago, which is freely available
  44 on their "MS-CG GitHub
  45 site"_https://github.com/uchicago-voth/MSCG-release.  See instructions
  46 on obtaining and installing the MS-CG library in the src/MSCG/README
  47 file, which must be done before you build LAMMPS with this fix command
  48 and use the command in a LAMMPS input script.
  49
  50 An example script using this fix is provided the examples/mscg
  51 directory.
  52
  53 The general workflow for using LAMMPS in conjunction with the MS-CG
  54 library to create a coarse-grained model and run coarse-grained
  55 simulations is as follows:
  56
  57 Perform all-atom simulations on the system to be coarse grained.
  58 Generate a trajectory mapped to the coarse-grained model.
  59 Create input files for the MS-CG library.
  60 Run the range finder functionality of the MS-CG library.
  61 Run the force matching functionality of the MS-CG library.
  62 Check the results of the force matching.
  63 Run coarse-grained simulations using the new coarse-grained potentials. :ol
  64
  65 This fix can perform the range finding and force matching steps 4 and
  66 5 of the above workflow when used in conjunction with the
  67 "rerun"_rerun.html command.  It does not perform steps 1-3 and 6-7.
  68
  69 Step 2 can be performed using a Python script (what is the name?)
  70 provided with the MS-CG library which defines the coarse-grained model
  71 and converts a standard LAMMPS dump file for an all-atom simulation
  72 (step 1) into a LAMMPS dump file which has the positions of and forces
  73 on the coarse-grained beads.
  74
  75 In step 3, an input file named "control.in" is needed by the MS-CG
  76 library which sets parameters for the range finding and force matching
  77 functionalities.  See the examples/mscg/control.in file as an example.
  78 And see the documentation provided with the MS-CG library for more
  79 info on this file.
  80
  81 When this fix is used to perform steps 4 and 5, the MS-CG library also
  82 produces additional output files.  The range finder functionality
  83 (step 4) outputs files defining pair and bonded interaction ranges.
  84 The force matching functionality (step 5) outputs tabulated force
  85 files for every interaction in the system. Other diagnostic files can
  86 also be output depending on the paramters in the MS-CG library input
  87 script.  Again, see the documentation provided with the MS-CG library
  88 for more info.
  89
  90 :line
  91
  92 The {range} keyword specifies which MS-CG library functionality should
  93 be invoked. If {on}, the step 4 range finder functionality is invoked.
  94 {off}, the step 5 force matching functionality is invoked.
  95
  96 If the {name} keyword is used, string names are defined to associate
  97 with the integer atom types in LAMMPS.  {Ntype} names must be
  98 provided, one for each atom type (1-Ntype).
  99
 100 The {max} keyword specifies the maximum number of bonds, angles, and
 101 dihedrals a bead can have in the coarse-grained model.
 102
 103 [Restrictions:]
 104
 105 This fix is part of the MSCG package. It is only enabled if LAMMPS was
 106 built with that package.  See the "Making
 107 LAMMPS"_Section_start.html#start_3 section for more info.
 108
 109 The MS-CG library uses C++11, which may not be supported by older
 110 compilers. The MS-CG library also has some additional numeric library
 111 dependencies, which are describd in its documentation.
 112
 113 Currently, the MS-CG library is not setup to run in parallel with MPI,
 114 so this fix can only be used in a serial LAMMPS build and run
 115 on a single processor.
 116
 117 [Related commands:] none
 118
 119 [Default:]
 120
 121 The default keyword settings are range off, max 4 12 36.
 122
 123 :line
 124
 125 :link(Izvekov)
 126 [(Izvekov)] Izvekov, Voth, J Chem Phys 123, 134105 (2005).
 127
 128 :link(Noid)
 129 [(Noid)] Noid, Chu, Ayton, Krishna, Izvekov, Voth, Das, Andersen, J
 130 Chem Phys 128, 134105 (2008).