git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / fix_lb_viscous.txt
blobb88700a136c5c9adc5c28761b626f379dde945b2
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 lb/viscous command :h3
11 [Syntax:]
13 fix ID group-ID lb/viscous :pre
15 ID, group-ID are documented in "fix"_fix.html command
16 lb/viscous = style name of this fix command :ul
18 [Examples:]
20 fix 1 flow lb/viscous
22 [Description:]
24 This fix is similar to the "fix viscous"_fix_viscous.html command, and
25 is to be used in place of that command when a lattice-Boltzmann fluid
26 is present, and the user wishes to integrate the particle motion using
27 one of the built in LAMMPS integrators.
29 This fix adds a force, F = - Gamma*(velocity-fluid_velocity), to each
30 atom, where Gamma is the force coupling constant described in the "fix
31 lb/fluid"_fix_lb_fluid.html command (which applies an equal and
32 opposite force to the fluid).
34 NOTE: This fix should only be used in conjunction with one of the
35 built in LAMMPS integrators; it should not be used with the "fix
36 lb/pc"_fix_lb_pc.html or "fix
37 lb/rigid/pc/sphere"_fix_lb_rigid_pc_sphere.html integrators, which
38 already include the hydrodynamic forces.  These latter fixes should
39 only be used if the force coupling constant has been set by the user
40 (instead of using the default value); if the default force coupling
41 value is used, then this fix provides the only method for adding the
42 hydrodynamic forces to the particles.
44 :line
46 For further details, as well as descriptions and results of several
47 test runs, see "Mackay et al."_#Mackay.  Please include a citation to
48 this paper if this fix is used in work contributing to published
49 research.
51 :line
53 [Restart, fix_modify, output, run start/stop, minimize info:]
55 As described in the "fix viscous"_fix_viscous.html documentation:
57 "No information about this fix is written to "binary restart
58 files"_restart.html.  None of the "fix_modify"_fix_modify.html options
59 are relevant to this fix.  No global or per-atom quantities are stored
60 by this fix for access by various "output
61 commands"_Section_howto.html#howto_15.  No parameter of this fix can
62 be used with the {start/stop} keywords of the "run"_run.html command.
64 The forces due to this fix are imposed during an energy minimization,
65 invoked by the "minimize"_minimize.html command.  This fix should only
66 be used with damped dynamics minimizers that allow for
67 non-conservative forces.  See the "min_style"_min_style.html command
68 for details."
70 [Restrictions:]
72 This fix is part of the USER-LB package.  It is only enabled if LAMMPS
73 was built with that package.  See the "Making
74 LAMMPS"_Section_start.html#start_3 section for more info.
76 Can only be used if a lattice-Boltzmann fluid has been created via the
77 "fix lb/fluid"_fix_lb_fluid.html command, and must come after this
78 command.
80 This fix should not be used if either the "fix lb/pc"_fix_lb_pc.html
81 or "fix lb/rigid/pc/sphere"_fix_lb_rigid_pc_sphere.html integrator is
82 used.
84 [Related commands:]
86 "fix lb/fluid"_fix_lb_fluid.html, "fix lb/pc"_fix_lb_pc.html, "fix
87 lb/rigid/pc/sphere"_fix_lb_rigid_pc_sphere.html
89 [Default:] none
91 :line
93 :link(Mackay)
94 [(Mackay et al.)] Mackay, F. E., Ollila, S.T.T., and Denniston, C., Hydrodynamic Forces Implemented into LAMMPS through a lattice-Boltzmann fluid, Computer Physics Communications 184 (2013) 2021-2031.