git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / pair_colloid.txt
blob4b78206f12243ae5a2a159ab2549478ad31922ee
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 colloid command :h3
10 pair_style colloid/gpu command :h3
11 pair_style colloid/omp command :h3
13 [Syntax:]
15 pair_style colloid cutoff :pre
17 cutoff = global cutoff for colloidal interactions (distance units) :ul
19 [Examples:]
21 pair_style colloid 10.0
22 pair_coeff * *  25 1.0 10.0 10.0
23 pair_coeff 1 1 144 1.0 0.0 0.0 3.0
24 pair_coeff 1 2  75.398 1.0 0.0 10.0 9.0
25 pair_coeff 2 2  39.478 1.0 10.0 10.0 25.0 :pre
27 [Description:]
29 Style {colloid} computes pairwise interactions between large colloidal
30 particles and small solvent particles using 3 formulas.  A colloidal
31 particle has a size > sigma; a solvent particle is the usual
32 Lennard-Jones particle of size sigma.
34 The colloid-colloid interaction energy is given by
36 :c,image(Eqs/pair_colloid_cc.jpg)
38 where A_cc is the Hamaker constant, a1 and a2 are the radii of the two
39 colloidal particles, and Rc is the cutoff.  This equation results from
40 describing each colloidal particle as an integrated collection of
41 Lennard-Jones particles of size sigma and is derived in
42 "(Everaers)"_#Everaers.
44 The colloid-solvent interaction energy is given by
46 :c,image(Eqs/pair_colloid_cs.jpg)
48 where A_cs is the Hamaker constant, a is the radius of the colloidal
49 particle, and Rc is the cutoff.  This formula is derived from the
50 colloid-colloid interaction, letting one of the particle sizes go to
51 zero.
53 The solvent-solvent interaction energy is given by the usual
54 Lennard-Jones formula
56 :c,image(Eqs/pair_colloid_ss.jpg)
58 with A_ss set appropriately, which results from letting both particle
59 sizes go to zero.
61 When used in combination with "pair_style
62 yukawa/colloid"_pair_colloid.html, the two terms become the so-called
63 DLVO potential, which combines electrostatic repulsion and van der
64 Waals attraction.
66 The following coefficients must be defined for each pair of atoms
67 types via the "pair_coeff"_pair_coeff.html command as in the examples
68 above, or in the data file or restart files read by the
69 "read_data"_read_data.html or "read_restart"_read_restart.html
70 commands, or by mixing as described below:
72 A (energy units)
73 sigma (distance units)
74 d1 (distance units)
75 d2 (distance units)
76 cutoff (distance units) :ul
78 A is the Hamaker energy prefactor and should typically be set as
79 follows:
81 A_cc = colloid/colloid = 4 pi^2 = 39.5
82 A_cs = colloid/solvent = sqrt(A_cc*A_ss)
83 A_ss = solvent/solvent = 144 (assuming epsilon = 1, so that 144/36 = 4) :ul
85 Sigma is the size of the solvent particle or the constituent particles
86 integrated over in the colloidal particle and should typically be set
87 as follows:
89 Sigma_cc = colloid/colloid = 1.0
90 Sigma_cs = colloid/solvent = arithmetic mixing between colloid sigma and solvent sigma
91 Sigma_ss = solvent/solvent = 1.0 or whatever size the solvent particle is :ul
93 Thus typically Sigma_cs = 1.0, unless the solvent particle's size !=
94 1.0.
96 D1 and d2 are particle diameters, so that d1 = 2*a1 and d2 = 2*a2 in
97 the formulas above.  Both d1 and d2 must be values >= 0.  If d1 > 0
98 and d2 > 0, then the pair interacts via the colloid-colloid formula
99 above.  If d1 = 0 and d2 = 0, then the pair interacts via the
100 solvent-solvent formula.  I.e. a d value of 0 is a Lennard-Jones
101 particle of size sigma.  If either d1 = 0 or d2 = 0 and the other is
102 larger, then the pair interacts via the colloid-solvent formula.
104 Note that the diameter of a particular particle type may appear in
105 multiple pair_coeff commands, as it interacts with other particle
106 types.  You should insure the particle diameter is specified
107 consistently each time it appears.
109 The last coefficient is optional.  If not specified, the global cutoff
110 specified in the pair_style command is used.  However, you typically
111 want different cutoffs for interactions between different particle
112 sizes.  E.g. if colloidal particles of diameter 10 are used with
113 solvent particles of diameter 1, then a solvent-solvent cutoff of 2.5
114 would correspond to a colloid-colloid cutoff of 25.  A good
115 rule-of-thumb is to use a colloid-solvent cutoff that is half the big
116 diameter + 4 times the small diameter.  I.e. 9 = 5 + 4 for the
117 colloid-solvent cutoff in this case.
119 NOTE: When using pair_style colloid for a mixture with 2 (or more)
120 widely different particles sizes (e.g. sigma=10 colloids in a
121 background sigma=1 LJ fluid), you will likely want to use these
122 commands for efficiency: "neighbor multi"_neighbor.html and
123 "comm_modify multi"_comm_modify.html.
125 :line
127 Styles with a {gpu}, {intel}, {kk}, {omp}, or {opt} suffix are
128 functionally the same as the corresponding style without the suffix.
129 They have been optimized to run faster, depending on your available
130 hardware, as discussed in "Section 5"_Section_accelerate.html
131 of the manual.  The accelerated styles take the same arguments and
132 should produce the same results, except for round-off and precision
133 issues.
135 These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
136 USER-OMP and OPT packages, respectively.  They are only enabled if
137 LAMMPS was built with those packages.  See the "Making
138 LAMMPS"_Section_start.html#start_3 section for more info.
140 You can specify the accelerated styles explicitly in your input script
141 by including their suffix, or you can use the "-suffix command-line
142 switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
143 use the "suffix"_suffix.html command in your input script.
145 See "Section 5"_Section_accelerate.html of the manual for
146 more instructions on how to use the accelerated styles effectively.
148 :line
150 [Mixing, shift, table, tail correction, restart, rRESPA info]:
152 For atom type pairs I,J and I != J, the A, sigma, d1, and d2
153 coefficients and cutoff distance for this pair style can be mixed.  A
154 is an energy value mixed like a LJ epsilon.  D1 and d2 are distance
155 values and are mixed like sigma.  The default mix value is
156 {geometric}.  See the "pair_modify" command for details.
158 This pair style supports the "pair_modify"_pair_modify.html shift
159 option for the energy of the pair interaction.
161 The "pair_modify"_pair_modify.html table option is not relevant
162 for this pair style.
164 This pair style does not support the "pair_modify"_pair_modify.html
165 tail option for adding long-range tail corrections to energy and
166 pressure.
168 This pair style writes its information to "binary restart
169 files"_restart.html, so pair_style and pair_coeff commands do not need
170 to be specified in an input script that reads a restart file.
172 This pair style can only be used via the {pair} keyword of the
173 "run_style respa"_run_style.html command.  It does not support the
174 {inner}, {middle}, {outer} keywords.
176 :line
178 [Restrictions:]
180 This style is part of the COLLOID package.  It is only enabled if
181 LAMMPS was built with that package.  See the "Making
182 LAMMPS"_Section_start.html#start_3 section for more info.
184 Normally, this pair style should be used with finite-size particles
185 which have a diameter, e.g. see the "atom_style
186 sphere"_atom_style.html command.  However, this is not a requirement,
187 since the only definition of particle size is via the pair_coeff
188 parameters for each type.  In other words, the physical radius of the
189 particle is ignored.  Thus you should insure that the d1,d2 parameters
190 you specify are consistent with the physical size of the particles of
191 that type.
193 Per-particle polydispersity is not yet supported by this pair style;
194 only per-type polydispersity is enabled via the pair_coeff parameters.
196 [Related commands:]
198 "pair_coeff"_pair_coeff.html
200 [Default:] none
202 :line
204 :link(Everaers)
205 [(Everaers)] Everaers, Ejtehadi, Phys Rev E, 67, 041710 (2003).