clump rotate command

Syntax

clump rotate keyword ... <range>

Primary keywords:

axis    angle    point    update-orientation

Rotate clumps. Application with the point keyword may also modify the center of mass location. Rotations follow the right-hand rule where the rotation axis in 2D is toward the viewer. Rotations are not allowed that rotate clumps so that pebble centroids fall outside the model domain. No clumps will be rotated if any clumps fail this test. Should orientation tracking be active, then the orientation is updated by default, though this can be disabled (see the update-orientation keyword).

axis vaxis

Axis of rotation.

angle fang

Angle of rotation in degrees using the right-hand-rule.

point vrot

Rotation occurs about the specified point. Should this keyword be absent, rotation occurs about the centroid of each clump.

update-orientation b

Explicitly set the orientation update status for this rotate command. Used if orientation tracking is enabled to update the orientation. By default, the orientation is updated.

Usage Example

Please see the clump template example for a demonstration of the clump rotate command.