git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / pair_awpmd.txt
blobfe0e3c952a759234f79234c60d825524b8984023
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 pair_style awpmd/cut command :h3
11 [Syntax:]
13 pair_style awpmd/cut Rc keyword value ... :pre
15 Rc = global cutoff, -1 means cutoff of half the shortest box length :ulb,l
16 zero or more keyword/value pairs may be appended :l
17 keyword = {hartree} or {dproduct} or {uhf} or {free} or {pbc} or {fix} or {harm} or {ermscale} or {flex_press} :l
18   {hartree} value = none
19   {dproduct} value = none
20   {uhf} value = none
21   {free} value = none
22   {pbc} value = Plen
23     Plen = periodic width of electron = -1 or positive value (distance units)
24   {fix} value = Flen
25     Flen = fixed width of electron = -1 or positive value (distance units)
26   {harm} value = width
27     width = harmonic width constraint
28   {ermscale} value = factor
29     factor = scaling between electron mass and width variable mass
30   {flex_press} value = none :pre
31 :ule
34 [Examples:]
36 pair_style awpmd/cut -1
37 pair_style awpmd/cut 40.0 uhf free
38 pair_coeff * *
39 pair_coeff 2 2 20.0 :pre
41 [Description:]
43 This pair style contains an implementation of the Antisymmetrized Wave
44 Packet Molecular Dynamics (AWPMD) method.  Need citation here.  Need
45 basic formulas here.  Could be links to other documents.
47 Rc is the cutoff.
49 The pair_style command allows for several optional keywords
50 to be specified.
52 The {hartree}, {dproduct}, and {uhf} keywords specify the form of the
53 initial trial wave function for the system.  If the {hartree} keyword
54 is used, then a Hartree multielectron trial wave function is used.  If
55 the {dproduct} keyword is used, then a trial function which is a
56 product of two determinants for each spin type is used.  If the {uhf}
57 keyword is used, then an unrestricted Hartree-Fock trial wave function
58 is used.
60 The {free}, {pbc}, and {fix} keywords specify a width constraint on
61 the electron wavepackets.  If the {free} keyword is specified, then there is no
62 constraint.  If the {pbc} keyword is used and {Plen} is specified as
63 -1, then the maximum width is half the shortest box length.  If {Plen}
64 is a positive value, then the value is the maximum width.  If the
65 {fix} keyword is used and {Flen} is specified as -1, then electrons
66 have a constant width that is read from the data file.  If {Flen} is a
67 positive value, then the constant width for all electrons is set to
68 {Flen}.
70 The {harm} keyword allow oscillations in the width of the
71 electron wavepackets.  More details are needed.
73 The {ermscale} keyword specifies a unitless scaling factor
74 between the electron masses and the width variable mass.  More
75 details needed.
77 If the {flex_press} keyword is used, then a contribution from the
78 electrons is added to the total virial and pressure of the system.
80 This potential is designed to be used with "atom_style
81 wavepacket"_atom_style.html definitions, in order to handle the
82 description of systems with interacting nuclei and explicit electrons.
84 The following coefficients must be defined for each pair of atoms
85 types via the "pair_coeff"_pair_coeff.html command as in the examples
86 above, or in the data file or restart files read by the
87 "read_data"_read_data.html or "read_restart"_read_restart.html
88 commands, or by mixing as described below:
90 cutoff (distance units) :ul
92 For {awpmd/cut}, the cutoff coefficient is optional.  If it is not
93 used (as in some of the examples above), the default global value
94 specified in the pair_style command is used.
96 :line
98 [Mixing, shift, table, tail correction, restart, rRESPA info]:
100 The "pair_modify"_pair_modify.html mix, shift, table, and tail options
101 are not relevant for this pair style.
103 This pair style writes its information to "binary restart
104 files"_restart.html, so pair_style and pair_coeff commands do not need
105 to be specified in an input script that reads a restart file.
107 This pair style can only be used via the {pair} keyword of the
108 "run_style respa"_run_style.html command.  It does not support the
109 {inner}, {middle}, {outer} keywords.
111 :line
113 [Restrictions:] none
115 [Related commands:]
117 "pair_coeff"_pair_coeff.html
119 [Default:]
121 These are the defaults for the pair_style keywords: {hartree} for the
122 initial wavefunction, {free} for the wavepacket width.