git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / pair_lubricate.txt
blob5dbd7f4b80b0d482da2d9a53e67e3cf0e2dbe0df
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 lubricate command :h3
10 pair_style lubricate/omp command :h3
11 pair_style lubricate/poly command :h3
12 pair_style lubricate/poly/omp command :h3
14 [Syntax:]
16 pair_style style mu flaglog flagfld cutinner cutoff flagHI flagVF :pre
18 style = {lubricate} or {lubricate/poly}
19 mu = dynamic viscosity (dynamic viscosity units)
20 flaglog = 0/1 to exclude/include log terms in the lubrication approximation
21 flagfld = 0/1 to exclude/include Fast Lubrication Dynamics (FLD) effects
22 cutinner = inner cutoff distance (distance units)
23 cutoff = outer cutoff for interactions (distance units)
24 flagHI (optional) = 0/1 to exclude/include 1/r hydrodynamic interactions
25 flagVF (optional) = 0/1 to exclude/include volume fraction corrections in the long-range isotropic terms :ul
27 [Examples:] (all assume radius = 1)
29 pair_style lubricate 1.5 1 1 2.01 2.5
30 pair_coeff 1 1 2.05 2.8
31 pair_coeff * * :pre
33 pair_style lubricate 1.5 1 1 2.01 2.5
34 pair_coeff * *
35 variable mu equal ramp(1,2)
36 fix 1 all adapt 1 pair lubricate mu * * v_mu :pre
38 [Description:]
40 Styles {lubricate} and {lubricate/poly} compute hydrodynamic
41 interactions between mono-disperse finite-size spherical particles in
42 a pairwise fashion.  The interactions have 2 components.  The first is
43 Ball-Melrose lubrication terms via the formulas in "(Ball and
44 Melrose)"_#Ball
46 :c,image(Eqs/pair_lubricate.jpg)
48 which represents the dissipation W between two nearby particles due to
49 their relative velocities in the presence of a background solvent with
50 viscosity {mu}.  Note that this is dynamic viscosity which has units of
51 mass/distance/time, not kinematic viscosity.
53 The Asq (squeeze) term is the strongest and is included if {flagHI} is
54 set to 1 (default). It scales as 1/gap where gap is the separation
55 between the surfaces of the 2 particles. The Ash (shear) and Apu
56 (pump) terms are only included if {flaglog} is set to 1. They are the
57 next strongest interactions, and the only other singular interaction,
58 and scale as log(gap). Note that {flaglog} = 1 and {flagHI} = 0 is
59 invalid, and will result in a warning message, after which {flagHI} will
60 be set to 1. The Atw (twist) term is currently not included. It is
61 typically a very small contribution to the lubrication forces.
63 The {flagHI} and {flagVF} settings are optional.  Neither should be
64 used, or both must be defined.
66 {Cutinner} sets the minimum center-to-center separation that will be
67 used in calculations irrespective of the actual separation.  {Cutoff}
68 is the maximum center-to-center separation at which an interaction is
69 computed.  Using a {cutoff} less than 3 radii is recommended if
70 {flaglog} is set to 1.
72 The other component is due to the Fast Lubrication Dynamics (FLD)
73 approximation, described in "(Kumar)"_#Kumar, which can be
74 represented by the following equation
76 :c,image(Eqs/fld.jpg)
78 where U represents the velocities and angular velocities of the
79 particles, U^{infty} represents the velocity and the angular velocity
80 of the undisturbed fluid, and E^{infty} represents the rate of strain
81 tensor of the undisturbed fluid with viscosity {mu}. Again, note that
82 this is dynamic viscosity which has units of mass/distance/time, not
83 kinematic viscosity. Volume fraction corrections to R_FU are included
84 as long as {flagVF} is set to 1 (default).
86 NOTE: When using the FLD terms, these pair styles are designed to be
87 used with explicit time integration and a correspondingly small
88 timestep.  Thus either "fix nve/sphere"_fix_nve_sphere.html or "fix
89 nve/asphere"_fix_nve_asphere.html should be used for time integration.
90 To perform implicit FLD, see the "pair_style
91 lubricateU"_pair_lubricateU.html command.
93 Style {lubricate} requires monodisperse spherical particles; style
94 {lubricate/poly} allows for polydisperse spherical particles.
96 The viscosity {mu} can be varied in a time-dependent manner over the
97 course of a simluation, in which case in which case the pair_style
98 setting for {mu} will be overridden.  See the "fix adapt"_fix_adapt.html
99 command for details.
101 If the suspension is sheared via the "fix deform"_fix_deform.html
102 command then the pair style uses the shear rate to adjust the
103 hydrodynamic interactions accordingly. Volume changes due to fix
104 deform are accounted for when computing the volume fraction
105 corrections to R_FU.
107 When computing the volume fraction corrections to R_FU, the presence
108 of walls (whether moving or stationary) will affect the volume
109 fraction available to colloidal particles. This is currently accounted
110 for with the following types of walls: "wall/lj93"_fix_wall.html,
111 "wall/lj126"_fix_wall.html, "wall/colloid"_fix_wall.html, and
112 "wall/harmonic"_fix_wall.html.  For these wall styles, the correct
113 volume fraction will be used when walls do not coincide with the box
114 boundary, as well as when walls move and thereby cause a change in the
115 volume fraction. Other wall styles will still work, but they will
116 result in the volume fraction being computed based on the box
117 boundaries.
119 Since lubrication forces are dissipative, it is usually desirable to
120 thermostat the system at a constant temperature. If Brownian motion
121 (at a constant temperature) is desired, it can be set using the
122 "pair_style brownian"_pair_brownian.html command. These pair styles
123 and the brownian style should use consistent parameters for {mu},
124 {flaglog}, {flagfld}, {cutinner}, {cutoff}, {flagHI} and {flagVF}.
126 :line
128 The following coefficients must be defined for each pair of atoms
129 types via the "pair_coeff"_pair_coeff.html command as in the examples
130 above, or in the data file or restart files read by the
131 "read_data"_read_data.html or "read_restart"_read_restart.html
132 commands, or by mixing as described below:
134 cutinner (distance units)
135 cutoff (distance units) :ul
137 The two coefficients are optional.  If neither is specified, the two
138 cutoffs specified in the pair_style command are used.  Otherwise both
139 must be specified.
141 :line
143 Styles with a {gpu}, {intel}, {kk}, {omp}, or {opt} suffix are
144 functionally the same as the corresponding style without the suffix.
145 They have been optimized to run faster, depending on your available
146 hardware, as discussed in "this section"_Section_accelerate.html of
147 the manual.  The accelerated styles take the same arguments and should
148 produce the same results, except for round-off and precision issues.
150 These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
151 USER-OMP and OPT packages, respectively.  They are only enabled if
152 LAMMPS was built with those packages.  See the "Making
153 LAMMPS"_Section_start.html#start_3 section for more info.
155 You can specify the accelerated styles explicitly in your input script
156 by including their suffix, or you can use the "-suffix command-line
157 switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
158 use the "suffix"_suffix.html command in your input script.
160 See "this section"_Section_accelerate.html of the manual for more
161 instructions on how to use the accelerated styles effectively.
163 :line
165 [Mixing, shift, table, tail correction, restart, rRESPA info]:
167 For atom type pairs I,J and I != J, the two cutoff distances for this
168 pair style can be mixed.  The default mix value is {geometric}.  See
169 the "pair_modify" command for details.
171 This pair style does not support the "pair_modify"_pair_modify.html
172 shift option for the energy of the pair interaction.
174 The "pair_modify"_pair_modify.html table option is not relevant
175 for this pair style.
177 This pair style does not support the "pair_modify"_pair_modify.html
178 tail option for adding long-range tail corrections to energy and
179 pressure.
181 This pair style writes its information to "binary restart
182 files"_restart.html, so pair_style and pair_coeff commands do not need
183 to be specified in an input script that reads a restart file.
185 This pair style can only be used via the {pair} keyword of the
186 "run_style respa"_run_style.html command.  It does not support the
187 {inner}, {middle}, {outer} keywords.
189 :line
191 [Restrictions:]
193 These styles are part of the COLLOID package.  They are only enabled
194 if LAMMPS was built with that package.  See the "Making
195 LAMMPS"_Section_start.html#start_2_3 section for more info.
197 Only spherical monodisperse particles are allowed for pair_style
198 lubricate.
200 Only spherical particles are allowed for pair_style lubricate/poly.
202 These pair styles will not restart exactly when using the
203 "read_restart"_read_restart.html command, though they should provide
204 statistically similar results.  This is because the forces they
205 compute depend on atom velocities.  See the
206 "read_restart"_read_restart.html command for more details.
208 [Related commands:]
210 "pair_coeff"_pair_coeff.html, "pair_style
211 lubricateU"_pair_lubricateU.html
213 [Default:]
215 The default settings for the optional args are flagHI = 1 and flagVF =
218 :line
220 :link(Ball)
221 [(Ball)] Ball and Melrose, Physica A, 247, 444-472 (1997).
223 :link(Kumar)
224 [(Kumar)] Kumar and Higdon, Phys Rev E, 82, 051401 (2010).  See also
225 his thesis for more details: A. Kumar, "Microscale Dynamics in
226 Suspensions of Non-spherical Particles", Thesis, University of
227 Illinois Urbana-Champaign,
228 (2010). ("https://www.ideals.illinois.edu/handle/2142/16032"_https://www.ideals.illinois.edu/handle/2142/16032)