git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / compute_property_atom.txt
blobbac19918ba7ccefedb982449b91db8cd086edae7
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 compute property/atom command :h3
11 [Syntax:]
13 compute ID group-ID property/atom input1 input2 ... :pre
15 ID, group-ID are documented in "compute"_compute.html command :ulb,l
16 property/atom = style name of this compute command :l
17 input = one or more atom attributes :l
18   possible attributes = id, mol, proc, type, mass,
19                         x, y, z, xs, ys, zs, xu, yu, zu, ix, iy, iz,
20                         vx, vy, vz, fx, fy, fz,
21                         q, mux, muy, muz, mu,
22                         radius, diameter, omegax, omegay, omegaz,
23                         angmomx, angmomy, angmomz,
24                         shapex,shapey, shapez,
25                         quatw, quati, quatj, quatk, tqx, tqy, tqz,
26                         end1x, end1y, end1z, end2x, end2y, end2z,
27                         corner1x, corner1y, corner1z,
28                         corner2x, corner2y, corner2z,
29                         corner3x, corner3y, corner3z,
30                         nbonds,
31                         vfrac, s0,
32                         spin, eradius, ervel, erforce,
33                         rho, drho, e, de, cv,
34                         i_name, d_name :pre
35       id = atom ID
36       mol = molecule ID
37       proc = ID of processor that owns atom
38       type = atom type
39       mass = atom mass
40       x,y,z = unscaled atom coordinates
41       xs,ys,zs = scaled atom coordinates
42       xu,yu,zu = unwrapped atom coordinates
43       ix,iy,iz = box image that the atom is in
44       vx,vy,vz = atom velocities
45       fx,fy,fz = forces on atoms
46       q = atom charge
47       mux,muy,muz = orientation of dipole moment of atom
48       mu = magnitude of dipole moment of atom
49       radius,diameter = radius,diameter of spherical particle
50       omegax,omegay,omegaz = angular velocity of spherical particle
51       angmomx,angmomy,angmomz = angular momentum of aspherical particle
52       shapex,shapey,shapez = 3 diameters of aspherical particle
53       quatw,quati,quatj,quatk = quaternion components for aspherical or body particles
54       tqx,tqy,tqz = torque on finite-size particles
55       end12x, end12y, end12z = end points of line segment
56       corner123x, corner123y, corner123z = corner points of triangle
57       nbonds = number of bonds assigned to an atom :pre
59       PERI package per-atom properties:
60       vfrac = ???
61       s0 = ??? :pre
63       USER-EFF and USER-AWPMD package per-atom properties:
64       spin = electron spin
65       eradius = electron radius
66       ervel = electron radial velocity
67       erforce = electron radial force :pre
69       USER-SPH package per-atom properties:
70       rho = ???
71       drho = ???
72       e = ???
73       de = ???
74       cv = ??? :pre
76       "fix property/atom"_fix_property_atom.html per-atom properties:
77       i_name = custom integer vector with name
78       d_name = custom integer vector with name :pre
79 :ule
81 [Examples:]
83 compute 1 all property/atom xs vx fx mux
84 compute 2 all property/atom type
85 compute 1 all property/atom ix iy iz :pre
87 [Description:]
89 Define a computation that simply stores atom attributes for each atom
90 in the group.  This is useful so that the values can be used by other
91 "output commands"_Section_howto.html#howto_15 that take computes as
92 inputs.  See for example, the "compute reduce"_compute_reduce.html,
93 "fix ave/atom"_fix_ave_atom.html, "fix ave/histo"_fix_ave_histo.html,
94 "fix ave/chunk"_fix_ave_chunk.html, and "atom-style
95 variable"_variable.html commands.
97 The list of possible attributes is the same as that used by the "dump
98 custom"_dump.html command, which describes their meaning, with some
99 additional quantities that are only defined for certain "atom
100 styles"_atom_style.html.  Basically, this augmented list gives an
101 input script access to any per-atom quantity stored by LAMMPS.
103 The values are stored in a per-atom vector or array as discussed
104 below.  Zeroes are stored for atoms not in the specified group or for
105 quantities that are not defined for a particular particle in the group
106 (e.g. {shapex} if the particle is not an ellipsoid).
108 The additional quantities only accessible via this command, and not
109 directly via the "dump custom"_dump.html command, are as follows.
111 {Shapex}, {shapey}, and {shapez} are defined for ellipsoidal particles
112 and define the 3d shape of each particle.
114 {Quatw}, {quati}, {quatj}, and {quatk} are defined for ellipsoidal
115 particles and body particles and store the 4-vector quaternion
116 representing the orientation of each particle.  See the "set"_set.html
117 command for an explanation of the quaternion vector.
119 {End1x}, {end1y}, {end1z}, {end2x}, {end2y}, {end2z}, are defined for
120 line segment particles and define the end points of each line segment.
122 {Corner1x}, {corner1y}, {corner1z}, {corner2x}, {corner2y},
123 {corner2z}, {corner3x}, {corner3y}, {corner3z}, are defined for
124 triangular particles and define the corner points of each triangle.
126 {Nbonds} is available for all molecular atom styles and refers to the
127 number of explicit bonds assigned to an atom.  Note that if the
128 "newton bond"_newton.html command is set to {on}, which is the
129 default, then every bond in the system is assigned to only one of the
130 two atoms in the bond.  Thus a bond between atoms I,J may be tallied
131 for either atom I or atom J.  If "newton bond off"_newton.html is set,
132 it will be tallied with both atom I and atom J.
134 The {i_name} and {d_name} attributes refer to custom integer and
135 floating-point properties that have been added to each atom via the
136 "fix property/atom"_fix_property_atom.html command.  When that command
137 is used specific names are given to each attribute which are what is
138 specified as the "name" portion of {i_name} or {d_name}.
140 [Output info:]
142 This compute calculates a per-atom vector or per-atom array depending
143 on the number of input values.  If a single input is specified, a
144 per-atom vector is produced.  If two or more inputs are specified, a
145 per-atom array is produced where the number of columns = the number of
146 inputs.  The vector or array can be accessed by any command that uses
147 per-atom values from a compute as input.  See "this
148 section"_Section_howto.html#howto_15 for an overview of LAMMPS output
149 options.
151 The vector or array values will be in whatever "units"_units.html the
152 corresponding attribute is in, e.g. velocity units for vx, charge
153 units for q, etc.
155 [Restrictions:] none
157 [Related commands:]
159 "dump custom"_dump.html, "compute reduce"_compute_reduce.html, "fix
160 ave/atom"_fix_ave_atom.html, "fix ave/chunk"_fix_ave_chunk.html,
161 "fix property/atom"_fix_property_atom.html
163 [Default:] none