clump.scalevol
Syntax
- b = clump.scalevol(c,f)
Scale the clump. The clump is scaled so that its {volume per unit thickness in 2D; volume in 3D} is f. The pebbles are scaled, their positions are modified, and the volume is updated.
Note
- All pebbles of the scaled clump must fall within the model domain for the operation to succeed.
- If the volume or moment of inertia has been previously specified by the user either via
clump attribute
or via FISH (clump.vol
,clump.moi.prin.real
, orclump.moi.real
), the principal moment of inertia is in a fixed state and will not be scaled. See theclump.moi.fix
intrinsic for further details.
Returns: b - boolean indicating success/failure of operation
Arguments: c - clump pointer
f - volume
Was this helpful? ... | PFC © 2021, Itasca | Updated: Feb 25, 2024 |