doc/src/neighbor.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 neighbor command :h3
  10
  11 [Syntax:]
  12
  13 neighbor skin style :pre
  14
  15 skin = extra distance beyond force cutoff (distance units)
  16 style = {bin} or {nsq} or {multi} :ul
  17
  18 [Examples:]
  19
  20 neighbor 0.3 bin
  21 neighbor 2.0 nsq :pre
  22
  23 [Description:]
  24
  25 This command sets parameters that affect the building of pairwise
  26 neighbor lists.  All atom pairs within a neighbor cutoff distance
  27 equal to the their force cutoff plus the {skin} distance are stored in
  28 the list.  Typically, the larger the skin distance, the less often
  29 neighbor lists need to be built, but more pairs must be checked for
  30 possible force interactions every timestep.  The default value for
  31 {skin} depends on the choice of units for the simulation; see the
  32 default values below.
  33
  34 The {skin} distance is also used to determine how often atoms migrate
  35 to new processors if the {check} option of the
  36 "neigh_modify"_neigh_modify.html command is set to {yes}.  Atoms are
  37 migrated (communicated) to new processors on the same timestep that
  38 neighbor lists are re-built.
  39
  40 The {style} value selects what algorithm is used to build the list.
  41 The {bin} style creates the list by binning which is an operation that
  42 scales linearly with N/P, the number of atoms per processor where N =
  43 total number of atoms and P = number of processors.  It is almost
  44 always faster than the {nsq} style which scales as (N/P)^2.  For
  45 unsolvated small molecules in a non-periodic box, the {nsq} choice can
  46 sometimes be faster.  Either style should give the same answers.
  47
  48 The {multi} style is a modified binning algorithm that is useful for
  49 systems with a wide range of cutoff distances, e.g. due to different
  50 size particles.  For the {bin} style, the bin size is set to 1/2 of
  51 the largest cutoff distance between any pair of atom types and a
  52 single set of bins is defined to search over for all atom types.  This
  53 can be inefficient if one pair of types has a very long cutoff, but
  54 other type pairs have a much shorter cutoff.  For style {multi} the
  55 bin size is set to 1/2 of the shortest cutoff distance and multiple
  56 sets of bins are defined to search over for different atom types.
  57 This imposes some extra setup overhead, but the searches themselves
  58 may be much faster for the short-cutoff cases.  See the "comm_modify
  59 mode multi"_comm_modify.html command for a communication option option
  60 that may also be beneficial for simulations of this kind.
  61
  62 The "neigh_modify"_neigh_modify.html command has additional options
  63 that control how often neighbor lists are built and which pairs are
  64 stored in the list.
  65
  66 When a run is finished, counts of the number of neighbors stored in
  67 the pairwise list and the number of times neighbor lists were built
  68 are printed to the screen and log file.  See "this
  69 section"_Section_start.html#start_8 for details.
  70
  71 [Restrictions:] none
  72
  73 [Related commands:]
  74
  75 "neigh_modify"_neigh_modify.html, "units"_units.html,
  76 "comm_modify"_comm_modify.html
  77
  78 [Default:]
  79
  80 0.3 bin for units = lj, skin = 0.3 sigma
  81 2.0 bin for units = real or metal, skin = 2.0 Angstroms
  82 0.001 bin for units = si, skin = 0.001 meters = 1.0 mm
  83 0.1 bin for units = cgs, skin = 0.1 cm = 1.0 mm :all(b)