doc/src/fix_smd_setvel.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 fix smd/setvel command :h3
  10
  11 [Syntax:]
  12
  13 fix ID group-ID smd/setvel vx vy vz keyword value ... :pre
  14
  15 ID, group-ID are documented in "fix"_fix.html command :ulb,l
  16 smd/setvel = style name of this fix command :l
  17 vx,vy,vz = velocity component values :l
  18 any of vx,vy,vz can be a variable (see below) :l
  19 zero or more keyword/value pairs may be appended to args :l
  20 keyword = {region}  :l
  21   {region} value = region-ID
  22     region-ID = ID of region particles must be in to have their velocities set :pre
  23 :ule
  24
  25 [Examples:]
  26
  27 fix top_velocity top_group setvel 1.0 0.0 0.0 :pre
  28
  29 [Description:]
  30
  31 Set each component of velocity on each particle in the group to the specified
  32 values vx,vy,vz, regardless of the forces acting on the particle.  This command can
  33 be used to impose velocity boundary conditions.
  34
  35 Any of the vx,vy,vz values can be specified as NULL which means do not
  36 alter the velocity component in that dimension.
  37
  38 This fix is indented to be used together with a time integration fix.
  39
  40 Any of the 3 quantities defining the velocity components can be specified
  41 as an equal-style or atom-style "variable"_variable.html, namely {vx},
  42 {vy}, {vz}.  If the value is a variable, it should be specified as
  43 v_name, where name is the variable name.  In this case, the variable
  44 will be evaluated each timestep, and its value used to determine the
  45 force component.
  46
  47 Equal-style variables can specify formulas with various mathematical
  48 functions, and include "thermo_style"_thermo_style.html command
  49 keywords for the simulation box parameters and timestep and elapsed
  50 time.  Thus it is easy to specify a time-dependent velocity field.
  51
  52 Atom-style variables can specify the same formulas as equal-style
  53 variables but can also include per-atom values, such as atom
  54 coordinates.  Thus it is easy to specify a spatially-dependent velocity
  55 field with optional time-dependence as well.
  56
  57 If the {region} keyword is used, the particle must also be in the
  58 specified geometric "region"_region.html in order to have its velocity set by this command.
  59
  60 :line
  61
  62 [Restart, fix_modify, output, run start/stop, minimize info:]
  63
  64 Currently, no part of USER-SMD supports restarting nor minimization
  65 None of the "fix_modify"_fix_modify.html options
  66 are relevant to this fix.
  67
  68 This fix computes a global 3-vector of forces, which can be accessed
  69 by various "output commands"_Section_howto.html#howto_15.  This is the
  70 total force on the group of atoms.  The vector values calculated by this
  71 fix are "extensive".
  72
  73 No parameter of this fix can be used with the {start/stop} keywords of
  74 the "run"_run.html command.
  75
  76 [Restrictions:]
  77
  78 This fix is part of the USER-SMD package.  It is only enabled if
  79 LAMMPS was built with that package. See the "Making LAMMPS"_Section_start.html#start_3
  80 section for more info.
  81
  82 [Related commands:] none
  83
  84 [Default:] none