lammps/doc/set.html

269 lines
14 KiB
HTML

<HTML>
<CENTER><A HREF = "http://lammps.sandia.gov">LAMMPS WWW Site</A> - <A HREF = "Manual.html">LAMMPS Documentation</A> - <A HREF = "Section_commands.html#comm">LAMMPS Commands</A>
</CENTER>
<HR>
<H3>set command
</H3>
<P><B>Syntax:</B>
</P>
<PRE>set style ID keyword values ...
</PRE>
<UL><LI>style = <I>atom</I> or <I>type</I> or <I>mol</I> or <I>group</I> or <I>region</I>
<LI>ID = atom ID range or type range or mol ID range or group ID or region ID
<LI>one or more keyword/value pairs may be appended
<LI>keyword = <I>type</I> or <I>type/fraction</I> or <I>mol</I> or <I>x</I> or <I>y</I> or <I>z</I> or <I>charge</I> or <I>dipole</I> or <I>dipole/random</I> or <I>quat</I> or <I>quat/random</I> or <I>diameter</I> or <I>shape</I> or <I>mass</I> or <I>density</I> or <I>volume</I> or <I>image</I> or
<I>bond</I> or <I>angle</I> or <I>dihedral</I> or <I>improper</I> or
<I>meso_e</I> or <I>meso_cv</I> or <I>meso_rho</I>
<PRE> <I>type</I> value = atom type
<I>type/fraction</I> values = type fraction seed
type = new atom type
fraction = fraction of selected atoms to set to new atom type
seed = random # seed (positive integer)
<I>mol</I> value = molecule ID
<I>x</I>,<I>y</I>,<I>z</I> value = atom coordinate (distance units)
<I>charge</I> value = atomic charge (charge units)
<I>dipole</I> values = x y z
x,y,z = orientation of dipole moment vector
<I>dipole/random</I> value = seed Dlen
seed = random # seed (positive integer) for dipole moment orientations
Dlen = magnitude of dipole moment (dipole units)
<I>quat</I> values = a b c theta
a,b,c = unit vector to rotate particle around via right-hand rule
theta = rotation angle in degrees
<I>quat/random</I> value = seed
seed = random # seed (positive integer) for quaternion orientations
<I>diameter</I> value = diameter of spherical particle (distance units)
<I>shape</I> value = Sx Sy Sz
Sx,Sy,Sz = 3 diameters of ellipsoid (distance units)
<I>mass</I> value = per-atom mass (mass units)
<I>density</I> value = particle density for sphere or ellipsoid (mass/distance^3 units)
<I>volume</I> value = particle volume for Peridynamic particle (distance^3 units)
<I>image</I> nx ny nz
nx,ny,nz = which periodic image of the simulation box the atom is in
<I>bond</I> value = bond type for all bonds between selected atoms
<I>angle</I> value = angle type for all angles between selected atoms
<I>dihedral</I> value = dihedral type for all dihedrals between selected atoms
<I>improper</I> value = improper type for all impropers between selected atoms
<I>meso_e</I> value = energy of SPH particles (need units)
<I>meso_cv</I> value = heat capacity of SPH particles (need units)
<I>meso_rho</I> value = density of SPH particles (need units)
</PRE>
</UL>
<P><B>Examples:</B>
</P>
<PRE>set group solvent type 2
set group solvent type/fraction 2 0.5 12393
set group edge bond 4
set region half charge 0.5
set type 3 charge 0.5
set type 1*3 charge 0.5
set atom 100*200 x 0.5 y 1.0
set atom 1492 type 3
</PRE>
<P><B>Description:</B>
</P>
<P>Set one or more properties of one or more atoms. Since atom
properties are initially assigned by the <A HREF = "read_data.html">read_data</A>,
<A HREF = "read_restart.html">read_restart</A> or <A HREF = "create_atoms.html">create_atoms</A>
commands, this command changes those assignments. This can be useful
for overriding the default values assigned by the
<A HREF = "create_atoms.html">create_atoms</A> command (e.g. charge = 0.0). It can
be useful for altering pairwise and molecular force interactions,
since force-field coefficients are defined in terms of types. It can
be used to change the labeling of atoms by atom type or molecule ID
when they are output in <A HREF = "dump.html">dump</A> files. It can be useful for
debugging purposes; i.e. positioning an atom at a precise location to
compute subsequent forces or energy.
</P>
<P>The style <I>atom</I> selects all the atoms in a range of atom IDs. The
style <I>type</I> selects all the atoms in a range of types. The style
<I>mol</I> selects all the atoms in a range of molecule IDs.
</P>
<P>In each of the range cases, a single value can be specified, or a
wildcard asterisk can be used to specify a range of values. This
takes the form "*" or "*n" or "n*" or "m*n". For example, for the
style <I>type</I>, if N = the number of atom types, then an asterisk with
no numeric values means all types from 1 to N. A leading asterisk
means all types from 1 to n (inclusive). A trailing asterisk means
all types from n to N (inclusive). A middle asterisk means all types
from m to n (inclusive). Note that the loweest value for the wildcard
is 1, not 0, so you cannot not use this form to select atoms
with molecule ID = 0, for example.
</P>
<P>The style <I>group</I> selects all the atoms in the specified group. The
style <I>region</I> selects all the atoms in the specified geometric
region. See the <A HREF = "group.html">group</A> and <A HREF = "region.html">region</A> commands
for details of how to specify a group or region.
</P>
<HR>
<P>Keyword <I>type</I> sets the atom type for all selected atoms. The
specified value must be from 1 to ntypes, where ntypes was set by the
<A HREF = "create_box.html">create_box</A> command or the <I>atom types</I> field in the
header of the data file read by the <A HREF = "read_data.html">read_data</A>
command.
</P>
<P>Keyword <I>type/fraction</I> sets the atom type for a fraction of the
selected atoms. The actual number of atoms changed is not guaranteed
to be exactly the requested fraction, but should be statistically
close. Random numbers are used in such a way that a particular atom
is changed or not changed, regardless of how many processors are being
used.
</P>
<P>Keyword <I>mol</I> sets the molecule ID for all selected atoms. The <A HREF = "atom_style.html">atom
style</A> being used must support the use of molecule
IDs.
</P>
<P>Keywords <I>x</I>, <I>y</I>, <I>z</I>, and <I>charge</I> set the coordinates or charge of
all selected atoms. For <I>charge</I>, the <A HREF = "atom_style.html">atom style</A>
being used must support the use of atomic charge.
</P>
<P>Keyword <I>dipole</I> uses the specified x,y,z values as components of a
vector to set as the orientation of the dipole moment vectors of the
selected atoms. The magnitude of the dipole moment is set
by the length of this orientation vector.
</P>
<P>Keyword <I>dipole/random</I> randomizes the orientation of the dipole
moment vectors of the selected atoms and sets the magnitude of each to
the specified <I>Dlen</I> value. For 2d systems, the z component of the
orientation is set to 0.0. Random numbers are used in such a way that
the orientation of a particular atom is the same, regardless of how
many processors are being used.
</P>
<P>Keyword <I>quat</I> uses the specified values to create a quaternion
(4-vector) that represents the orientation of the selected atoms.
Note that particles defined by <A HREF = "atom_style.html">atom_style ellipsoid</A>
have 3 shape parameters. The 3 values must be non-zero for each
particle set by this command. They are used to specify the aspect
ratios of an ellipsoidal particle, which is oriented by default with
its x-axis along the simulation box's x-axis, and similarly for y and
z. If this body is rotated (via the right-hand rule) by an angle
theta around a unit rotation vector (a,b,c), then the quaternion that
represents its new orientation is given by (cos(theta/2),
a*sin(theta/2), b*sin(theta/2), c*sin(theta/2)). The theta and a,b,c
values are the arguments to the <I>quat</I> keyword. LAMMPS normalizes the
quaternion in case (a,b,c) was not specified as a unit vector. For 2d
systems, the a,b,c values are ignored, since a rotation vector of
(0,0,1) is the only valid choice.
</P>
<P>Keyword <I>quat/random</I> randomizes the orientation of the quaternion of
the selected atoms. Random numbers are used in such a way that the
orientation of a particular atom is the same, regardless of how many
processors are being used. For 2d systems, only orientations in the
xy plane are generated. As with keyword <I>quat</I>, the 3 shape values
must be non-zero for each particle set by this command.
</P>
<P>Keyword <I>diameter</I> sets the size of the selected atoms. The particles
must be finite-size spheres as defined by the <A HREF = "atom_style.html">atom_style
sphere</A> command. The diameter of a particle can be
set to 0.0, which means they will be treated as point particles. Note
that this command does not adjust the particle mass, even if it was
defined with a density, e.g. via the <A HREF = "read_data.html">read_data</A>
command.
</P>
<P>Keyword <I>shape</I> sets the size and shape of the selected atoms. The
particles must be aspherical ellipsoids as defined by the <A HREF = "atom_style.html">atom_style
ellipsoid</A> command. The <I>Sx</I>, <I>Sy</I>, <I>Sz</I> settings are
the 3 diameters of the ellipsoid in each direction. All 3 can be set
to the same value, which means the ellipsoid is effectively a sphere.
They can also all be set to 0.0 which means the particle will be
treated as a point particle. Note that this command does not adjust
the particle mass, even if it was defined with a density, e.g. via the
<A HREF = "read_data.html">read_data</A> command.
</P>
<P>Keyword <I>mass</I> sets the mass of all selected particles. The particles
must have a per-atom mass attribute, as defined by the
<A HREF = "atom_style.html">atom_style</A> command. See the "mass" command for how
to set mass values on a per-type basis.
</P>
<P>Keyword <I>density</I> sets the mass of all selected particles. The
particles must have a per-atom mass attribute, as defined by the
<A HREF = "atom_style.html">atom_style</A> command. See the "mass" command for how
to set mass values on a per-type basis. If the atom has a radius
attribute (see <A HREF = "atom_style.html">atom_style sphere</A>) and its radius is
non-zero, its mass is set from the density and particle volume. The
same is true if the atom has a shape attribute (see <A HREF = "atom_style.html">atom_style
ellipsoid</A>) and its 3 shape parameters are non-zero.
Otherwise the mass is set to the density value directly.
</P>
<P>Keyword <I>volume</I> sets the volume of all selected particles.
Currently, only the <A HREF = "atom_style.html">atom_style peri</A> command defines
particles with a volume attribute. Note that this command does not
adjust the particle mass.
</P>
<P>Keyword <I>image</I> sets which image of the simulation box the atom is
considered to be in. An image of 0 means it is inside the box as
defined. A value of 2 means add 2 box lengths to get the true value.
A value of -1 means subtract 1 box length to get the true value.
LAMMPS updates these flags as atoms cross periodic boundaries during
the simulation. The flags can be output with atom snapshots via the
<A HREF = "dump.html">dump</A> command. If a value of NULL is specified for any of
nx,ny,nz, then the current image value for that dimension is
unchanged. For non-periodic dimensions only a value of 0 can be
specified.
</P>
<P>This command can be useful after a system has been equilibrated and
atoms have diffused one or more box lengths in various directions.
This command can then reset the image values for atoms so that they
are effectively inside the simulation box, e.g if a diffusion
coefficient is about to be measured via the <A HREF = "compute_msd.html">compute
msd</A> command. Care should be taken not to reset the
image flags of two atoms in a bond to the same value if the bond
straddles a periodic boundary (rather they should be different by +/-
1). This will not affect the dynamics of a simulation, but may mess
up analysis of the trajectories if a LAMMPS diagnostic or your own
analysis relies on the image flags to unwrap a molecule which
straddles the periodic box.
</P>
<P>Keywords <I>bond</I>, <I>angle</I>, <I>dihedral</I>, and <I>improper</I>, set the bond
type (angle type, etc) of all bonds (angles, etc) of selected atoms to
the specified value from 1 to nbondtypes (nangletypes, etc). All
atoms in a particular bond (angle, etc) must be selected atoms in
order for the change to be made. The value of nbondtype (nangletypes,
etc) was set by the <I>bond types</I> (<I>angle types</I>, etc) field in the
header of the data file read by the <A HREF = "read_data.html">read_data</A>
command.
</P>
<P>Keywords <I>meso_e</I>, <I>meso_cv</I>, and <I>meso_rho</I> set the energy, heat
capacity, and density of smmothed particle hydrodynamics (SPH)
particles. See <A HREF = "USER/sph/SPH_LAMMPS_userguide.pdf">this PDF guide</A> to
using SPH in LAMMPS.
</P>
<P><B>Restrictions:</B>
</P>
<P>You cannot set an atom attribute (e.g. <I>mol</I> or <I>q</I> or <I>volume</I>) if
the <A HREF = "atom_style.html">atom_style</A> does not have that attribute.
</P>
<P>This command requires inter-processor communication to coordinate the
setting of bond types (angle types, etc). This means that your system
must be ready to perform a simulation before using one of these
keywords (force fields set, atom mass set, etc). This is not
necessary for other keywords.
</P>
<P>Using the <I>region</I> style with the bond (angle, etc) keywords can give
unpredictable results if there are bonds (angles, etc) that straddle
periodic boundaries. This is because the region may only extend up to
the boundary and partner atoms in the bond (angle, etc) may have
coordinates outside the simulation box if they are ghost atoms.
</P>
<P><B>Related commands:</B>
</P>
<P><A HREF = "create_box.html">create_box</A>, <A HREF = "create_atoms.html">create_atoms</A>,
<A HREF = "read_data.html">read_data</A>
</P>
<P><B>Default:</B> none
</P>
</HTML>