git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@16053 f3b2605a-c512-4ea7-a41b...
[lammps.git] / doc / src / compute_com_chunk.txt
blobd497585cb036455b2cf199b6bc1098e34077b16e
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 com/chunk command :h3
11 [Syntax:]
13 compute ID group-ID com/chunk chunkID :pre
15 ID, group-ID are documented in "compute"_compute.html command
16 com/chunk = style name of this compute command
17 chunkID = ID of "compute chunk/atom"_compute_chunk_atom.html command :ul
19 [Examples:]
21 compute 1 fluid com/chunk molchunk :pre
23 [Description:]
25 Define a computation that calculates the center-of-mass for multiple
26 chunks of atoms.
28 In LAMMPS, chunks are collections of atoms defined by a "compute
29 chunk/atom"_compute_chunk_atom.html command, which assigns each atom
30 to a single chunk (or no chunk).  The ID for this command is specified
31 as chunkID.  For example, a single chunk could be the atoms in a
32 molecule or atoms in a spatial bin.  See the "compute
33 chunk/atom"_compute_chunk_atom.html doc page and "Section
34 6.23"_Section_howto.html#howto_23 for details of how chunks can be
35 defined and examples of how they can be used to measure properties of
36 a system.
38 This compute calculates the x,y,z coordinates of the center-of-mass
39 for each chunk, which includes all effects due to atoms passing thru
40 periodic boundaries.
42 Note that only atoms in the specified group contribute to the
43 calculation.  The "compute chunk/atom"_compute_chunk_atom.html command
44 defines its own group; atoms will have a chunk ID = 0 if they are not
45 in that group, signifying they are not assigned to a chunk, and will
46 thus also not contribute to this calculation.  You can specify the
47 "all" group for this command if you simply want to include atoms with
48 non-zero chunk IDs.
50 NOTE: The coordinates of an atom contribute to the chunk's
51 center-of-mass in "unwrapped" form, by using the image flags
52 associated with each atom.  See the "dump custom"_dump.html command
53 for a discussion of "unwrapped" coordinates.  See the Atoms section of
54 the "read_data"_read_data.html command for a discussion of image flags
55 and how they are set for each atom.  You can reset the image flags
56 (e.g. to 0) before invoking this compute by using the "set
57 image"_set.html command.
59 The simplest way to output the results of the compute com/chunk
60 calculation to a file is to use the "fix ave/time"_fix_ave_time.html
61 command, for example:
63 compute cc1 all chunk/atom molecule
64 compute myChunk all com/chunk cc1
65 fix 1 all ave/time 100 1 100 c_myChunk\[*\] file tmp.out mode vector :pre
67 [Output info:]
69 This compute calculates a global array where the number of rows = the
70 number of chunks {Nchunk} as calculated by the specified "compute
71 chunk/atom"_compute_chunk_atom.html command.  The number of columns =
72 3 for the x,y,z center-of-mass coordinates of each chunk.  These
73 values can be accessed by any command that uses global array values
74 from a compute as input.  See "Section
75 6.15"_Section_howto.html#howto_15 for an overview of LAMMPS output
76 options.
78 The array values are "intensive".  The array values will be in
79 distance "units"_units.html.
81 [Restrictions:] none
83 [Related commands:]
85 "compute com"_compute_com.html
87 [Default:] none