clump create command

Syntax

clump create keyword ...

Primary keywords:

calculate    density    group    id    inertia    pebbles    position    position-x    position-y    position-z    volume

Create a single clump with the specified attributes. A model domain must be specified prior to clump creation. The clump will not be available for replication and will not have a surface description associated with it. Unit density is assumed at creation unless the density keyword is specified. Either all inertial attributes must be specified (position, volume, inertia tensor) or the calculate keyword must be given to calculate them from the pebble distribution. Unless the real moment of inertia is modified via FISH or via the clump attribute command, this value will be updated in response to changes in volume and density.

Note

  • A model domain must be specified prior to clump creation.
  • While cycling, clumps can only be created before cycle point 0 (i.e., when the timestep is calculated).
calculate f

This keyword specifies that the clump position, volume, and inertia tensor will be calculated from the pebble distribution assuming constant density. The space containing the clump is recursively subdivided into boxes that are {squares in 2D; cubes in 3D}. The {areas in 2D; volumes in 3D} and inertia tensors of all boxes that fall completely within any pebbles are accumulated. The parallel axis theorem is used to accumulate the inertia tensors. For each iteration the “final” volume is extrapolated, and the iterations cease when either 1) the total number of cells to be subdivided reaches 1e6 or 2) the extrapolated and estimated volumes are within the desired tolerance. By default, the percentage difference f = 0.01. The minimum value allowed is 0.00005 and the user should be aware that setting the percentage to such a small value may require some computational effort to calculate these attributes. The clump centroid calculated is assigned to the clump.

density f

Clump density with default value 1.0.

group s <slot slot > <pebble> ...

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

id i

Clump ID. If not specified, then the next available ID is used.

inertia fe11 fe22 fe33 fe12 fe13 fe23 (only 1 component in 2D)

Set the inertia “tensor” of the clump in its current configuration. This value of the inertia tensor, {a float in 2D corresponding to the polar moment of inertia; a 2nd order tensor in 3D}. In 3D, 6 parameters must be specified in the order e11,e22,e33,e12,e13,e23 using the row/column convention. One must also specify the volume, and this keyword cannot be specified with the calculate keyword.

pebbles i f v ...

Number of pebbles in the clump, i, followed by i sets of pebble geometric parameters. Each set is the pebble radius (f) and position (v).

position v

Clump position that is the origin by default. This is the position of the clump centroid. This keyword cannot be given with the calculate keyword.

position-x f

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

position-y f

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

position-z f (3D ONLY)

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

volume f

Set the {volume per unit thickness in 2D; volume in 3D} to f. One must also specify the inertia tensor, and this keyword cannot be given with the calculate keyword. Please be aware that this parameter doesn’t affect the geometry of the clump; as a result, the apparent geometric volume of the clump remains unchanged. This is the volume (from which the mass is computed) that is used to solve the law of motion for the clump.

Usage Examples

Create a clump with a single pebble. The inertial attributes are calculated from the ball.

clump create id 1 pebble 1 1,0,0,5 calculate 0.1

Create a clump with a single pebble. The inertial attributes are calculated from the ball.

clump create pebbles 1 0.5,[(xpos,ypos,zpos)] calculate

Create a clump composed of two pebbles. The inertial attributes are calculated from the ball.

clump create  id 1 position (0,0) ...
              pebbles 2           ...
              1.0 -0.5 0.0        ...
              1.0  0.5 0.0        ...
              calculate 0.05