Commit 86179478 authored by Stefan Paquay's avatar Stefan Paquay
Browse files

Updated documentation regarding types keyword.

parent 2430c7bc
Loading
Loading
Loading
Loading
+14 −1
Original line number Diff line number Diff line
@@ -10,12 +10,16 @@ fix propel/self command :pre

[Syntax:]

fix ID group-ID propel/self mode magnitude
fix ID group-ID propel/self mode magnitude keyword values ...

ID, group-ID are documented in "fix"_fix.html command :ulb,l
propel/self = style name of this fix command :l
mode = velocity or quaternion :l
magnitude = magnitude of the active force :l
one or more keyword/value pairs may be appended to args :l
keyword = {types} :l
  {types} values = one or more atom types
  
:ule

[Examples:]
@@ -25,6 +29,9 @@ fix constant_velocity all viscous 1.0 :pre

fix active_group all propel/self quaternion 1.0 :pre

fix active all propel/self quaternion 1.0 types 1 2 4 :pre


[Description:]

Adds a force of a constant magnitude to each atom in the group. The nature in
@@ -37,6 +44,10 @@ z-axis along the atom's quaternion. In other words, the force is along the
z-axis in the atom's body frame. This mode requires all atoms in the group
to have a quaternion, so atom_style should either be ellipsoid or body.

By default, this fix is applied to all atoms in the group. You can override this
behavior by specifying the atom types the fix should work on through the {types}
keyword.

:line

[Restart, fix_modify, output, run start/stop, minimize info:]
@@ -65,3 +76,5 @@ Phys. Rev. E, 74, 061908, 2006
[(Henkes)] Henkes, S, Fily, Y., and Marchetti, M. C.
Phys. Rev. E, 84, 040301(R), 2011


[Default:] types