# ball list command

Syntax

ball list <keyword> <range>

Primary keywords:

List ball information. By default, the ball ID, radius, active/total contact count, fixity, and position are listed. Use the attribute keyword to list all ball attributes that can be listed.

Note

Use the model precision command to change the precision of listed floating point values.

attribute keyword

List ball attributes. If no keyword is given, then the available attributes are listed.

Attributes are characteristics of balls such as mass and velocity. These are distinct from properties that represent surface conditions and are used in contact models to delineate interactions.

damp

Ball local damping coefficient.

density

Ball density.

displacement

Accumulated ball displacement vector as a result of cycling.

displacement-x

The $$x$$-component of the accumulated ball displacement as a result of cycling.

displacement-y

The $$y$$-component of the accumulated ball displacement as a result of cycling.

displacement-z (3D ONLY)

The $$z$$-component of the accumulated ball displacement as a result of cycling.

euler (3D ONLY)

Current orientation of Euler angles following the X,Y,Z convention (e.g., rotation about the $$x$$-axis followed by rotation about the y’-axis followed by rotation about the z’‘-axis) in degrees. The orientation is updated only when orientation tracking has been enabled (see model orientation-tracking command). When active, the current ball orientation can be visualized.

euler-x (3D ONLY)

The $$x$$-euler angle (in degrees) of the current ball orientation. See the euler keyword for further details.

euler-y (3D ONLY)

The $$y$$-euler angle (in degrees) of the current ball orientation. See the euler keyword for further details.

euler-z (3D ONLY)

The $$z$$-euler angle (in degrees) of the current ball orientation. See the euler keyword for further details.

force-applied

Force applied to balls.

force-applied-x

The $$x$$-component of the force applied to balls.

force-applied-y

The $$y$$-component of the force applied to balls.

force-applied-z (3D ONLY)

The $$z$$-component of the force applied to balls.

force-contact

Sum of the contact force accumulated to the balls during the previous force-displacement update. This value will be modified during the next force-displacement update.

force-contact-x

The $$x$$-component of the contact force.

force-contact-y

The $$y$$-component of the contact force.

force-contact-z (3D ONLY)

The $$z$$-component of the contact force.

fragment

Fragment ID (see “Fragment”).

moment-applied

Moment applied to balls.

moment-applied-x (3D ONLY)

The $$x$$-component of the moment applied to balls.

moment-applied-y (3D ONLY)

The $$y$$-component of the moment applied to balls.

moment-applied-z (3D ONLY)

The $$z$$-component of the moment applied to balls.

moment-contact

Sum of the contact moments accumulated to the balls during the previous force-displacement update. This value will be modified during the next force-displacement update.

moment-contact-x (3D ONLY)

The $$x$$-component of the contact moment.

moment-contact-y (3D ONLY)

The $$y$$-component of the contact moment.

moment-contact-z (3D ONLY)

The $$z$$-component of the contact moment.

position

Location of ball centroid. Note that the model should be cleaned (see the model clean command) after this command is issued to ensure that potential contacts with neighboring pieces are updated.

position-x

The $$x$$-component of the location of ball centroids.

position-y

The $$y$$-component of the location of ball centroids.

position-z (3D ONLY)

The $$z$$-component of the location of ball centroids.

rotation (2D ONLY)

Current ball orientation. The orientation is updated only when orientation tracking has been enabled (see model orientation-tracking command).

spin

Ball angular velocity.

spin-x (3D ONLY)

The $$x$$-component of the ball angular velocity in radians.

spin-y (3D ONLY)

The $$y$$-component of the ball angular velocity in radians.

spin-z (3D ONLY)

The $$z$$-component of the ball angular velocity in radians.

velocity

Ball translational velocity vector.

velocity-x

The $$x$$-component of the ball velocity.

velocity-y

The $$y$$-component of the ball velocity.

velocity-z (3D ONLY)

The $$z$$-component of the ball velocity.

contact <all>

List the contacts with a ball. The 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

List the extra variables at index i.

group s

List the group names at slot s.

property <s >

List ball properties. If no s is given, then the available properties are listed for each ball. If s is specified, then the value of that property is listed for each ball.

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 ball model results that have been tabulated. See the ball results command for further details.

Usage Examples

List the value stored in the extra variable at index 2 for all balls.

ball list extra 2


List the applied force for all balls.

ball list attribute force-applied


List the value of the property kn (normal stiffness) for all balls.

ball list prop 'kn'