git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / fix_qeq_comb.txt
blob58a541cc9dd6d27a147272bad47c55cf4abb6f22
1 "LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
3 :link(lws,http://lammps.sandia.gov)
4 :link(ld,Manual.html)
5 :link(lc,Section_commands.html#comm)
7 :line
9 fix qeq/comb command :h3
10 fix qeq/comb/omp command :h3
12 [Syntax:]
14 fix ID group-ID qeq/comb Nevery precision keyword value ... :pre
16 ID, group-ID are documented in "fix"_fix.html command :ulb,l
17 qeq/comb = style name of this fix command :l
18 Nevery = perform charge equilibration every this many steps :l
19 precision = convergence criterion for charge equilibration :l
20 zero or more keyword/value pairs may be appended :l
21 keyword = {file} :l
22   {file} value = filename
23     filename = name of file to write QEQ equilibration info to :pre
24 :ule
26 [Examples:]
28 fix 1 surface qeq/comb 10 0.0001 :pre
30 [Description:]
32 Perform charge equilibration (QeQ) in conjunction with the COMB
33 (Charge-Optimized Many-Body) potential as described in
34 "(COMB_1)"_#COMB_1 and "(COMB_2)"_#COMB_2.  It performs the charge
35 equilibration portion of the calculation using the so-called QEq
36 method, whereby the charge on each atom is adjusted to minimize the
37 energy of the system.  This fix can only be used with the COMB
38 potential; see the "fix qeq/reax"_fix_qeq_reax.html command for a QeQ
39 calculation that can be used with any potential.
41 Only charges on the atoms in the specified group are equilibrated.
42 The fix relies on the pair style (COMB in this case) to calculate the
43 per-atom electronegativity (effective force on the charges).  An
44 electronegativity equalization calculation (or QEq) is performed in an
45 interative fashion, which in parallel requires communication at each
46 iteration for processors to exchange charge information about nearby
47 atoms with each other.  See "Rappe_and_Goddard"_#Rappe_and_Goddard and
48 "Rick_and_Stuart"_#Rick_and_Stuart for details.
50 During a run, charge equilibration is peformed every {Nevery} time
51 steps.  Charge equilibration is also always enforced on the first step
52 of each run.  The {precision} argument controls the tolerance for the
53 difference in electronegativity for all atoms during charge
54 equilibration.  {Precision} is a trade-off between the cost of
55 performing charge equilibration (more iterations) and accuracy.
57 If the {file} keyword is used, then information about each
58 equilibration calculation is written to the specifed file.
60 :line
62 Styles with a {gpu}, {intel}, {kk}, {omp}, or {opt} suffix are
63 functionally the same as the corresponding style without the suffix.
64 They have been optimized to run faster, depending on your available
65 hardware, as discussed in "Section 5"_Section_accelerate.html
66 of the manual.  The accelerated styles take the same arguments and
67 should produce the same results, except for round-off and precision
68 issues.
70 These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
71 USER-OMP and OPT packages, respectively.  They are only enabled if
72 LAMMPS was built with those packages.  See the "Making
73 LAMMPS"_Section_start.html#start_3 section for more info.
75 You can specify the accelerated styles explicitly in your input script
76 by including their suffix, or you can use the "-suffix command-line
77 switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
78 use the "suffix"_suffix.html command in your input script.
80 See "Section 5"_Section_accelerate.html of the manual for
81 more instructions on how to use the accelerated styles effectively.
83 :line
85 [Restart, fix_modify, output, run start/stop, minimize info:]
87 No information about this fix is written to "binary restart
88 files"_restart.html.
90 The "fix_modify"_fix_modify.html {respa} option is supported by this
91 fix. This allows to set at which level of the "r-RESPA"_run_style.html
92 integrator the fix is performing charge equilibration. Default is
93 the outermost level.
95 This fix produces a per-atom vector which can be accessed by various
96 "output commands"_Section_howto.html#howto_15.  The vector stores the
97 gradient of the charge on each atom.  The per-atom values be accessed
98 on any timestep.
100 No parameter of this fix can be used with the {start/stop} keywords of
101 the "run"_run.html command.
103 This fix can be invoked during "energy minimization"_minimize.html.
105 [Restrictions:]
107 This fix command currently only supports "pair style {comb}"_pair_comb.html.
109 [Related commands:]
111 "pair_style comb"_pair_comb.html
113 [Default:]
115 No file output is performed.
117 :line
119 :link(COMB_1)
120 [(COMB_1)] J. Yu, S. B. Sinnott, S. R. Phillpot, Phys Rev B, 75, 085311 (2007),
122 :link(COMB_2)
123 [(COMB_2)] T.-R. Shan, B. D. Devine, T. W. Kemper, S. B. Sinnott, S. R.
124 Phillpot, Phys Rev B, 81, 125328 (2010).
126 :link(Rappe_and_Goddard)
127 [(Rappe_and_Goddard)] A. K. Rappe, W. A. Goddard, J Phys Chem 95, 3358
128 (1991).
130 :link(Rick_and_Stuart)
131 [(Rick_and_Stuart)] S. W. Rick, S. J. Stuart, B. J. Berne, J Chem Phys
132 101, 16141 (1994).