doc/src/compute_property_chunk.txt

   1 "LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
   2
   3 :link(lws,http://lammps.sandia.gov)
   4 :link(ld,Manual.html)
   5 :link(lc,Section_commands.html#comm)
   6
   7 :line
   8
   9 compute property/chunk command :h3
  10
  11 [Syntax:]
  12
  13 compute ID group-ID property/chunk chunkID input1 input2 ... :pre
  14
  15 ID, group-ID are documented in "compute"_compute.html command :ulb,l
  16 property/chunk = style name of this compute command :l
  17 input = one or more attributes :l
  18   attributes = count, id, coord1, coord2, coord3
  19     count = # of atoms in chunk
  20     id = original chunk IDs before compression by "compute chunk/atom"_compute_chunk_atom.html
  21     coord123 = coordinates for spatial bins calculated by "compute chunk/atom"_compute_chunk_atom.html :pre
  22 :ule
  23
  24 [Examples:]
  25
  26 compute 1 all property/chunk count
  27 compute 1 all property/chunk ID coord1 :pre
  28
  29 [Description:]
  30
  31 Define a computation that stores the specified attributes of chunks of
  32 atoms.
  33
  34 In LAMMPS, chunks are collections of atoms defined by a "compute
  35 chunk/atom"_compute_chunk_atom.html command, which assigns each atom
  36 to a single chunk (or no chunk).  The ID for this command is specified
  37 as chunkID.  For example, a single chunk could be the atoms in a
  38 molecule or atoms in a spatial bin.  See the "compute
  39 chunk/atom"_compute_chunk_atom.html doc page and "Section
  40 6.23"_Section_howto.html#howto_23 for details of how chunks can be
  41 defined and examples of how they can be used to measure properties of
  42 a system.
  43
  44 This compute calculates and stores the specified attributes of chunks
  45 as global data so they can be accessed by other "output
  46 commands"_Section_howto.html#howto_15 and used in conjunction with
  47 other commands that generate per-chunk data, such as "compute
  48 com/chunk"_compute_com_chunk.html or "compute
  49 msd/chunk"_compute_msd_chunk.html.
  50
  51 Note that only atoms in the specified group contribute to the
  52 calculation of the {count} attribute.  The "compute
  53 chunk/atom"_compute_chunk_atom.html command defines its own group;
  54 atoms will have a chunk ID = 0 if they are not in that group,
  55 signifying they are not assigned to a chunk, and will thus also not
  56 contribute to this calculation.  You can specify the "all" group for
  57 this command if you simply want to include atoms with non-zero chunk
  58 IDs.
  59
  60 The {count} attribute is the number of atoms in the chunk.
  61
  62 The {id} attribute stores the original chunk ID for each chunk.  It
  63 can only be used if the {compress} keyword was set to {yes} for the
  64 "compute chunk/atom"_compute_chunk_atom.html command referenced by
  65 chunkID.  This means that the original chunk IDs (e.g. molecule IDs)
  66 will have been compressed to remove chunk IDs with no atoms assigned
  67 to them.  Thus a compresed chunk ID of 3 may correspond to an original
  68 chunk ID (molecule ID in this case) of 415.  The {id} attribute will
  69 then be 415 for the 3rd chunk.
  70
  71 The {coordN} attributes can only be used if a {binning} style was used
  72 in the "compute chunk/atom"_compute_chunk_atom.html command referenced
  73 by chunkID.  For {bin/1d}, {bin/2d}, and {bin/3d} styles the attribute
  74 is the center point of the bin in the corresponding dimension.  Style
  75 {bin/1d} only defines a {coord1} attribute.  Style {bin/2d} adds a
  76 {coord2} attribute.  Style {bin/3d} adds a {coord3} attribute.
  77
  78 Note that if the value of the {units} keyword used in the "compute
  79 chunk/atom command"_compute_chunk_atom.html is {box} or {lattice}, the
  80 {coordN} attributes will be in distance "units"_units.html.  If the
  81 value of the {units} keyword is {reduced}, the {coordN} attributes
  82 will be in unitless reduced units (0-1).
  83
  84 The simplest way to output the results of the compute property/chunk
  85 calculation to a file is to use the "fix ave/time"_fix_ave_time.html
  86 command, for example:
  87
  88 compute cc1 all chunk/atom molecule
  89 compute myChunk1 all property/chunk cc1 count
  90 compute myChunk2 all com/chunk cc1
  91 fix 1 all ave/time 100 1 100 c_myChunk1 c_myChunk2\[*\] file tmp.out mode vector :pre
  92
  93 [Output info:]
  94
  95 This compute calculates a global vector or global array depending on
  96 the number of input values.  The length of the vector or number of
  97 rows in the array is the number of chunks.
  98
  99 This compute calculates a global vector or global array where the
 100 number of rows = the number of chunks {Nchunk} as calculated by the
 101 specified "compute chunk/atom"_compute_chunk_atom.html command.  If a
 102 single input is specified, a global vector is produced.  If two or
 103 more inputs are specified, a global array is produced where the number
 104 of columns = the number of inputs.  The vector or array can be
 105 accessed by any command that uses global values from a compute as
 106 input.  See "this section"_Section_howto.html#howto_15 for an overview
 107 of LAMMPS output options.
 108
 109 The vector or array values are "intensive".  The values will be
 110 unitless or in the units discussed above.
 111
 112 [Restrictions:] none
 113
 114 [Related commands:]
 115
 116 "fix ave/chunk"_fix_ave_chunk.html
 117
 118 [Default:] none