Commit e1189381 authored by Axel Kohlmeyer's avatar Axel Kohlmeyer
Browse files

correct documentation for create_atoms rotate

This closes #736
parent 90ee5229
Loading
Loading
Loading
Loading
+11 −11
Original line number Diff line number Diff line
@@ -36,9 +36,9 @@ keyword = {mol} or {basis} or {remap} or {var} or {set} or {units} :l
  {set} values = dim name
    dim = {x} or {y} or {z}
    name = name of variable to set with x, y, or z atom position
  {rotate} values = Rx Ry Rz theta
    Rx,Ry,Rz = rotation vector for single molecule
  {rotate} values = theta Rx Ry Rz
    theta = rotation angle for single molecule (degrees)
    Rx,Ry,Rz = rotation vector for single molecule
  {units} value = {lattice} or {box}
    {lattice} = the geometry is defined in lattice units
    {box} = the geometry is defined in simulation box units :pre
@@ -242,15 +242,15 @@ write_dump all atom sinusoid.lammpstrj :pre

:c,image(JPG/sinusoid_small.jpg,JPG/sinusoid.jpg)

The {rotate} keyword can be used with the {single} style, when adding
a single molecule to specify the orientation at which the molecule is
inserted.  The axis of rotation is determined by the rotation vector
(Rx,Ry,Rz) that goes through the insertion point.  The specified
{theta} determines the angle of rotation around that axis.  Note that
the direction of rotation for the atoms around the rotation axis is
consistent with the right-hand rule: if your right-hand's thumb points
along {R}, then your fingers wrap around the axis in the direction of
rotation.
The {rotate} keyword can only be used with the {single} style and
when adding a single molecule. It allows to specify the orientation
at which the molecule is inserted.  The axis of rotation is
determined by the rotation vector (Rx,Ry,Rz) that goes through the
insertion point.  The specified {theta} determines the angle of
rotation around that axis.  Note that the direction of rotation for
the atoms around the rotation axis is consistent with the right-hand
rule: if your right-hand's thumb points along {R}, then your fingers
wrap around the axis in the direction of rotation.

The {units} keyword determines the meaning of the distance units used
to specify the coordinates of the one particle created by the {single}