doc/src/fix_qmmm.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 qmmm command :h3
  10
  11 [Syntax:]
  12
  13 fix ID group-ID qmmm  :pre
  14
  15 ID, group-ID are documented in "fix"_fix.html command
  16 qmmm = style name of this fix command :ul
  17
  18 [Examples:]
  19
  20 fix 1 qmol qmmm
  21
  22 [Description:]
  23
  24 This fix provides functionality to enable a quantum
  25 mechanics/molecular mechanice (QM/MM) coupling of LAMMPS to a quantum
  26 mechanical code.  The current implementation only supports an ONIOM
  27 style mechanical coupling to the "Quantum ESPRESSO"_espresso plane
  28 wave DFT package.  Electrostatic coupling is in preparation and the
  29 interface has been written in a manner that coupling to other QM codes
  30 should be possible without changes to LAMMPS itself.
  31
  32 :link(espresso,http://www.quantum-espresso.org)
  33
  34 The interface code for this is in the lib/qmmm directory of the LAMMPS
  35 distribution and is being made available at this early stage of
  36 development in order to encourage contributions for interfaces to
  37 other QM codes.  This will allow the LAMMPS side of the implementation
  38 to be adapted if necessary before being finalized.
  39
  40 Details about how to use this fix are currently documented in the
  41 description of the QM/MM interface code itself in lib/qmmm/README.
  42
  43 [Restart, fix_modify, output, run start/stop, minimize info:]
  44
  45 No information about this fix is written to "binary restart
  46 files"_restart.html.  None of the "fix_modify"_fix_modify.html options
  47 are relevant to this fix.  No global scalar or vector or per-atom
  48 quantities are stored by this fix for access by various "output
  49 commands"_Section_howto.html#howto_15.  No parameter of this fix can
  50 be used with the {start/stop} keywords of the "run"_run.html command.
  51 This fix is not invoked during "energy minimization"_minimize.html.
  52
  53 [Restrictions:]
  54
  55 This fix is part of the USER-QMMM package.  It is only enabled if
  56 LAMMPS was built with that package. It also requires building a
  57 library provided with LAMMPS.  See the "Making
  58 LAMMPS"_Section_start.html#start_3 section for more info.
  59
  60 The fix is only functional when LAMMPS is built as a library and
  61 linked with a compatible QM program and a QM/MM frontend into a QM/MM
  62 executable.  See the lib/qmmm/README file for details.
  63
  64 [Related commands:] none
  65
  66 [Default:] none