clump list
command
Syntax
 clump list <keyword> <range>

List clump information. By default, the clump ID, template name, pebble count, active/total contact count, fixity, and position are listed. Use the attribute keyword to list all clump ball attributes that can be listed.
Note
 Use the
model precision
command to change the precision of listed floating point values.  The optional range always applies to clumps and not pebbles.
 attribute keyword
List clump attributes. If no keyword is given, then the available attributes are listed. If the keyword is specified, then the value of that attribute is listed for each clump.
Attributes are characteristics of clumps such as mass and velocity. These are distinct from properties that represent surface conditions and are used in contact models to delineate interactions.
 damp
Clump local damping coefficient.
 density
Clump density.
 displacement
Accumulated clump displacement vector as a result of cycling.
 displacementx
The \(x\)component of the accumulated clump displacement as a result of cycling.
 displacementy
The \(y\)component of accumulated displacement as a result of cycling.
 displacementz (3D ONLY)
The \(z\)component of accumulated displacement as a result of cycling.
 eulerx (3D ONLY)
The \(x\)euler angle (in degrees) of the current clump orientation. See the euler keyword for further details.
 eulery (3D ONLY)
The \(y\)euler angle (in degrees) of the current clump orientation. See the euler keyword for further details.
 eulerz (3D ONLY)
The \(z\)euler angle (in degrees) of the current clump orientation. See the euler keyword for further details.
 forceapplied
Force vector applied to clumps.
 forcecontact
Sum of the contact force accumulated to the clumps during the previous forcedisplacement update. This value will be modified during the next forcedisplacement update.
 forcecontactx
The \(x\)component of the contact force.
 forcecontacty
The \(y\)component of the contact force.
 forcecontactz (3D ONLY)
The \(z\)component of the contact force.
 fragment
Fragment ID (see “Fragment”).
 moi11
11 component of the clump real moment of inertia. When modified, only the clump principal moments of inertia are modified and the other clump attributes are not changed (e.g., volume, pebble sizes). The specification of the clump principal moments of inertia via the command line or via FISH results in the principal moments of inertia being in a fixed state so that they will not be automatically updated when scaling a clump, changing the volume, or changing the density. The fix state can be modified in FISH (see the
clump.moi.fix
intrinsic).
 moi12
12 component of the clump real moment of inertia. When modified, only the clump principal moments of inertia are modified and the other clump attributes are not changed (e.g., volume, pebble sizes). The specification of the clump principal moments of inertia via the command line or via FISH results in the principal moments of inertia being in a fixed state so that they will not be automatically updated when scaling a clump, changing the volume, or changing the density. The fix state can be modified in FISH (see the
clump.moi.fix
intrinsic).
 moi13
13 component of the clump real moment of inertia. When modified, only the clump principal moments of inertia are modified and the other clump attributes are not changed (e.g., volume, pebble sizes). The specification of the clump principal moments of inertia via the command line or via FISH results in the principal moments of inertia being in a fixed state so that they will not be automatically updated when scaling a clump, changing the volume, or changing the density. The fix state can be modified in FISH (see the
clump.moi.fix
intrinsic).
 moi22
22 component of the clump real moment of inertia. When modified, only the clump principal moments of inertia are modified and the other clump attributes are not changed (e.g., volume, pebble sizes). The specification of the clump principal moments of inertia via the command line or via FISH results in the principal moments of inertia being in a fixed state so that they will not be automatically updated when scaling a clump, changing the volume, or changing the density. The fix state can be modified in FISH (see the
clump.moi.fix
intrinsic).
 moi23
23 component of the clump real moment of inertia. When modified, only the clump principal moments of inertia are modified and the other clump attributes are not changed (e.g., volume, pebble sizes). The specification of the clump principal moments of inertia via the command line or via FISH results in the principal moments of inertia being in a fixed state so that they will not be automatically updated when scaling a clump, changing the volume, or changing the density. The fix state can be modified in FISH (see the
clump.moi.fix
intrinsic).
 moi33
33 component of the clump real moment of inertia. When modified, only the clump principal moments of inertia are modified and the other clump attributes are not changed (e.g., volume, pebble sizes). The specification of the clump principal moments of inertia via the command line or via FISH results in the principal moments of inertia being in a fixed state so that they will not be automatically updated when scaling a clump, changing the volume, or changing the density. The fix state can be modified in FISH (see the
clump.moi.fix
intrinsic).
 moiprincipal (3D ONLY)
Real principal moments of inertia.
 momentapplied
Moment applied to clumps.
 momentappliedx (3D ONLY)
The \(x\)component of the moment applied to clumps.
 momentappliedy (3D ONLY)
The \(y\)component of the moment applied to clumps.
 momentappliedz (3D ONLY)
The \(z\)component of the moment applied to clumps.
 momentcontact
Sum of the contact moments accumulated to the clumps during the previous forcedisplacement update. This value will be modified during the next forcedisplacement update.
 momentcontactx (3D ONLY)
The \(x\)component of the contact moment.
 momentcontacty (3D ONLY)
The \(y\)component of the contact moment.
 momentcontactz (3D ONLY)
The \(z\)component of the contact moment.
 position
Location of clump centroid.
 positionx
The \(x\)component of the location of clump centroids.
 positiony
The \(y\)component of the location of clump centroids.
 positionz (3D ONLY)
The \(z\)component of the location of clump centroids.
 rotation (2D ONLY)
Current clump orientation. The orientation is updated only when orientation tracking has been enabled (see
model orientationtracking
command).
 spin
Clump angular velocity in radians per second.
 spinx (3D ONLY)
The \(x\)component of the clump angular velocity in radians per second.
 spiny (3D ONLY)
The \(y\)component of the clump angular velocity in radians per second.
 spinz (3D ONLY)
The \(z\)component of the clump angular velocity in radians per second.
 velocity
Clump translational velocity vector.
 velocityx
The \(x\)component of the clump velocity.
 velocityy
The \(y\)component of the clump velocity.
 velocityz (3D ONLY)
The \(z\)component of the clump velocity.
 volume
Clump volume. When modified, only the clump mass and real mass are modified and the other clump attributes based on volume are not changed (e.g., moment of inertia, pebble sizes). The specification of the volume via the command line or via FISH results in the principal moments of inertia being in a fixed state so that they will not be automatically updated when scaling a clump, changing the volume, or changing the density. The fixity state of the inertia can be modified in FISH (see the
clump.moi.fix
intrinsic).
 contact <all>
List the contacts with a clump. The pebble ID, contact ID, ID of the other contacting piece, contact type, activity state, inhibited state, and contact model are listed. By default, only active contacts are listed. Use the all keyword to list active and inactive contacts.
 extra i <pebble>
List the extra variables at index i. If the pebble keyword is given, then the pebble extra variables at index i are listed.
 group s <pebble>
List the group names at slot s. If the pebble keyword is given, then the pebble group variables at slot s are listed.
 property <s ...>
List pebble properties. If no s is given, then the available properties are listed for each clump (i.e., the list of properties over all pebbles in the clump). If s is specified, then the value of that property is listed for each pebble.
Properties represent surface conditions and are used in contact models to delineate interactions. These are distinct from attributes that are characteristics of balls such as mass and velocity.
 result
List the clump model results that have been tabulated. See the
clump results
command for more details.
 template <attribute s >
List information regarding clump templates, including the clump template name, referenced status, pebble count, volume, and density. The attribute kewyord without s lists the available attributes. If s is specified, then the value of that attribute is listed for each clump template.
 Use the
Usage Examples
Show the default listing for clumps.
clump list
List the clump velocities.
clump list attribute velocity
List the clump applied forces.
clump list attribute forceapplied
List the clump property kn
.
clump list property 'kn'
Was this helpful? ...  PFC © 2021, Itasca  Updated: Aug 19, 2023 