git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / fix_enforce2d.txt
blob1dce620033c74ca1389609484c545df6f6e4db1f
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 enforce2d command :h3
11 [Syntax:]
13 fix ID group-ID enforce2d :pre
15 ID, group-ID are documented in "fix"_fix.html command
16 enforce2d = style name of this fix command :ul
18 [Examples:]
20 fix 5 all enforce2d :pre
22 [Description:]
24 Zero out the z-dimension velocity and force on each atom in the group.
25 This is useful when running a 2d simulation to insure that atoms do
26 not move from their initial z coordinate.
28 :line
30 Styles with a suffix are functionally the same as the corresponding
31 style without the suffix.  They have been optimized to run faster,
32 depending on your available hardware, as discussed in
33 "Section 5"_Section_accelerate.html of the manual.  The
34 accelerated styles take the same arguments and should produce the same
35 results, except for round-off and precision issues.
37 These accelerated styles are part of the GPU, USER-INTEL, KOKKOS,
38 USER-OMP and OPT packages, respectively.  They are only enabled if
39 LAMMPS was built with those packages.  See the "Making
40 LAMMPS"_Section_start.html#start_3 section for more info.
42 You can specify the accelerated styles explicitly in your input script
43 by including their suffix, or you can use the "-suffix command-line
44 switch"_Section_start.html#start_7 when you invoke LAMMPS, or you can
45 use the "suffix"_suffix.html command in your input script.
47 See "Section 5"_Section_accelerate.html of the manual for
48 more instructions on how to use the accelerated styles effectively.
50 :line
52 [Restart, fix_modify, output, run start/stop, minimize info:]
54 No information about this fix is written to "binary restart
55 files"_restart.html.  None of the "fix_modify"_fix_modify.html options
56 are relevant to this fix.  No global or per-atom quantities are stored
57 by this fix for access by various "output
58 commands"_Section_howto.html#howto_15.  No parameter of this fix can
59 be used with the {start/stop} keywords of the "run"_run.html command.
61 The forces due to this fix are imposed during an energy minimization,
62 invoked by the "minimize"_minimize.html command.
64 [Restrictions:] none
66 [Related commands:] none
68 [Default:] none