git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / fix_append_atoms.txt
blob27070c9be53f3d725e5f4492a1d35ce1deffead2
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 append/atoms command :h3
11 [Syntax:]
13 fix ID group-ID append/atoms face ... keyword value ... :pre
15 ID, group-ID are documented in "fix"_fix.html command :ulb,l
16 append/atoms = style name of this fix command :l
17 face = {zhi} :l
18 zero or more keyword/value pairs may be appended :l
19 keyword = {basis} or {size} or {freq} or {temp} or {random} or {units}  :l
20   {basis} values = M itype
21     M = which basis atom
22     itype = atom type (1-N) to assign to this basis atom
23   {size} args = Lz
24     Lz = z size of lattice region appended in a single event(distance units)
25   {freq} args = freq
26     freq = the number of timesteps between append events
27   {temp} args = target damp seed extent
28     target = target temperature for the region between zhi-extent and zhi (temperature units)
29     damp = damping parameter (time units)
30     seed = random number seed for langevin kicks
31     extent = extent of thermostated region (distance units)
32   {random} args = xmax ymax zmax seed
33     {xmax}, {ymax}, {zmax} = maximum displacement in particular direction (distance units)
34     {seed} = random number seed for random displacement
35   {units} value = {lattice} or {box}
36     {lattice} = the wall position is defined in lattice units
37     {box} = the wall position is defined in simulation box units :pre
38 :ule
40 [Examples:]
42 fix 1 all append/atoms zhi size 5.0 freq 295 units lattice
43 fix 4 all append/atoms zhi size 15.0 freq 5 units box
44 fix A all append/atoms zhi size 1.0 freq 1000 units lattice :pre
46 [Description:]
48 This fix creates atoms on a lattice, appended on the zhi edge of the
49 system box.  This can be useful when a shock or wave is propagating
50 from zlo.  This allows the system to grow with time to accommodate an
51 expanding wave.  A simulation box must already exist, which is
52 typically created via the "create_box"_create_box.html command.
53 Before using this command, a lattice must also be defined using the
54 "lattice"_lattice.html command.
56 This fix will automatically freeze atoms on the zhi edge of the
57 system, so that overlaps are avoided when new atoms are appended.
59 The {basis} keyword specifies an atom type that will be assigned to
60 specific basis atoms as they are created.  See the
61 "lattice"_lattice.html command for specifics on how basis atoms are
62 defined for the unit cell of the lattice.  By default, all created
63 atoms are assigned type = 1 unless this keyword specifies differently.
65 The {size} keyword defines the size in z of the chunk of material to
66 be added.
68 The {random} keyword will give the atoms random displacements around
69 their lattice points to simulate some initial temperature.
71 The {temp} keyword will cause a region to be thermostated with a
72 Langevin thermostat on the zhi boundary.  The size of the region is
73 measured from zhi and is set with the {extent} argument.
75 The {units} keyword determines the meaning of the distance units used
76 to define a wall position, but only when a numeric constant is used.
77 A {box} value selects standard distance units as defined by the
78 "units"_units.html command, e.g. Angstroms for units = real or metal.
79 A {lattice} value means the distance units are in lattice spacings.
80 The "lattice"_lattice.html command must have been previously used to
81 define the lattice spacings.
83 :line
85 [Restart, fix_modify, output, run start/stop, minimize info:]
87 No information about this fix is written to "binary restart
88 files"_restart.html.  None of the "fix_modify"_fix_modify.html options
89 are relevant to this fix.  No global or per-atom quantities are stored
90 by this fix for access by various "output
91 commands"_Section_howto.html#howto_15.  No parameter of this fix can
92 be used with the {start/stop} keywords of the "run"_run.html command.
93 This fix is not invoked during "energy minimization"_minimize.html.
95 [Restrictions:]
97 This fix style is part of the SHOCK package.  It is only enabled if
98 LAMMPS was built with that package. See the "Making
99 LAMMPS"_Section_start.html#start_3 section for more info.
101 The boundary on which atoms are added with append/atoms must be
102 shrink/minimum.  The opposite boundary may be any boundary type other
103 than periodic.
105 [Related commands:]
107 "fix wall/piston"_fix_wall_piston.html command
109 [Default:]
111 The keyword defaults are size = 0.0, freq = 0, units = lattice.  All
112 added atoms are of type 1 unless the basis keyword is used.