clump replicate command

Syntax

clump replicate keyword ...

Primary keywords:

angle    axis    density    diameter    fish-size    group    id    original-position    position    position-x    position-y    position-z    name    size

Create a clump from a template. If no size measure is given, then the clump template volume is retained. If the density keyword is not given, then the clump is given unit density.

Note

  • A model domain must be specified prior to clump replication.

  • The replicated clump must fall entirely within the model domain.

  • While cycling, clumps can only be created before cycle point 0 (i.e., when the timestep is calculated).

angle fang

Angle about which to rotate the clump in degrees via the right-hand rule. If no angle is specified, then no rotation will occur. In 2D, rotation occurs in the out-of-plane direction.

axis vaxis

Axis about which to rotate the clump. If no axis is specified, then no rotation occurs.

density fden

Density of the clump that is 1 by default.

diameter fdiam

Volume is set to be the equivalent to the volume of a {disk of unit thickness in 2D; sphere in 3D} with diameter fdiam.

fish-size sfname fval

Use the FISH function sfname to scale the “size” of the clump template to fval. The FISH function must take a single argument that is a clump pointer and return a floating point value corresponding to a linear measure of the clump size.

group s <slot slot > <pebble>

The group slot slot is set to s for the newly created clump. If slot is not specified, then s is assigned to the group slot Default. The pebble keyword specifies that the group is assigned to the pebbles and not to the clump.

id id

Clump ID that is the next available ID by default.

original-position

Specify that the clump centroid will be set to the original position of the clump template when it was created.

position vpos

Clump position that is the origin by default. This keyword cannot be given with the original-position keyword.

position-x fposx

The \(x\)-component of the clump position that is 0 by default. This keyword cannot be given with the calculate or origposition keywords.

position-y fposy

The \(y\)-component of the clump position that is 0 by default. This keyword cannot be given with the calculate or origposition keywords.

position-z fposz (3D ONLY)

The \(z\)-component of the clump position that is 0 by default. This keyword cannot be given with the calculate or origposition keywords.

name s

Name of the clump template to be replicated.

size fvol

Scale the clump to have a volume of fvol. In 2D, the volume assumes disk with unit thickness.

Usage Examples

Create a clump from the clump template named ball1. The size is set from the diameter of an equivalent {circle in 2D; sphere in 3D}.

clump replicate diameter [r2 * 2.0] name 'ball1'

Create a clump from the clump template named rock1. The size is set from the diameter of an equivalent {circle in 2D; sphere in 3D} and the position is specified.

clump replicate name 'rock1' pos (2,2,2) diameter 2.0

Create a clump from the clump template named triad. The size is set from the diameter of an equivalent {circle in 2D; sphere in 3D} and the position is specified. In this case the orientation is also specified.

clump replicate name 'triad' position 0.5 0.5 1.5 diameter 0.25 axis 0 1 1 angle 45