clump scale command

Syntax

clump scale keyword ... <range>

Primary keywords:

diameter    fish-size    volume

Scale clumps. The pebbles are scaled, their positions are modified, and the volume is updated. If the volume or moment of inertia has been previously specified by the user either via the clump attribute command or via FISH, the principal moments of inertia are in a fixed state and will not be scaled. This can be modified with FISH (see the clump.moi.fix intrinsic for further details). One can either scale the volume to a target value, the volume to the volume of an equivalent {disk with unit thickness in 2D; sphere in 3D} with a specified diameter, or via the return value of a FISH function. This operation may fail if a clump is scaled so that any of its pebbles fall outside of the model domain. If this happens for any clump, then no clumps are scaled.

diameter fdiam

Scale the clump to have volume of an equivalent {disk with unit thickness in 2D; sphere in 3D} with a specified diameter.

fish-size s fval

Use the FISH function s to scale the “size” of the clump 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.

volume fvol

Scale the clump to have volume fvol.

Usage Example

clump scale volume [svol]

clump scale diameter 0.4

Also, please see the clump template example for a demonstration of the clump scale command.