doc/src/compute_basal_atom.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 basal/atom command :h3
  10
  11 [Syntax:]
  12
  13 compute ID group-ID basal/atom :pre
  14
  15 ID, group-ID are documented in "compute"_compute.html command
  16 basal/atom = style name of this compute command :ul
  17
  18 [Examples:]
  19
  20 compute 1 all basal/atom :pre
  21
  22 [Description:]
  23
  24 Defines a computation that calculates the hexagonal close-packed "c"
  25 lattice vector for each atom in the group.  It does this by
  26 calculating the normal unit vector to the basal plane for each atom.
  27 The results enable efficient identification and characterization of
  28 twins and grains in hexagonal close-packed structures.
  29
  30 The output of the compute is thus the 3 components of a unit vector
  31 associdate with each atom.  The components are set to 0.0 for
  32 atoms not in the group.
  33
  34 Details of the calculation are given in "(Barrett)"_#Barrett.
  35
  36 The neighbor list needed to compute this quantity is constructed each
  37 time the calculation is performed (i.e. each time a snapshot of atoms
  38 is dumped).  Thus it can be inefficient to compute/dump this quantity
  39 too frequently or to have multiple compute/dump commands, each of
  40 which computes this quantity.
  41
  42 An example input script that uses this compute is provided
  43 in examples/USER/misc/basal.
  44
  45 [Output info:]
  46
  47 This compute calculates a per-atom array with 3 columns, which can be
  48 accessed by indices 1-3 by any command that uses per-atom values from
  49 a compute as input.  See "Section
  50 6.15"_Section_howto.html#howto_15 for an overview of LAMMPS output
  51 options.
  52
  53 The per-atom vector values are unitless since the 3 columns represent
  54 components of a unit vector.
  55
  56 [Restrictions:]
  57
  58 This compute is part of the USER-MISC package.  It is only enabled if
  59 LAMMPS was built with that package.  See the "Making
  60 LAMMPS"_Section_start.html#start_3 section for more info.
  61
  62 The output of this compute will be meaningless unless the atoms are on
  63 (or near) hcp lattice sites, since the calculation assumes a
  64 well-defined basal plane.
  65
  66 [Related commands:]
  67
  68 "compute centro/atom"_compute_centro_atom.html, "compute
  69 ackland/atom"_compute_ackland_atom.html
  70
  71 [Default:] none
  72
  73 :line
  74
  75 :link(Barrett)
  76 [(Barrett)] Barrett, Tschopp, El Kadiri, Scripta Mat. 66, p.666 (2012).