ball.force.unbal

Syntax

v = ball.force.unbal(bp)

Get the ball unbalanced force.

The unbalanced force vector is defined as the sum of the contact force vectors, the applied force vector, and gravity loading.

Returns:

v - ball unbalanced force vector

Arguments:

bp - ball pointer

Component Access

f = ball.force.unbal (bp)->x

f = ball.force.unbal.x(bp)

Get the $x$-component of the ball unbalanced force.

Returns:

f - $x$-component of the ball unbalanced force vector

Arguments:

bp - ball pointer

Access other vector components ($y$, $z$ (3D ONLY)) by substituting the component name where $x$ appears above. See Member Access Operator for information about accessing members from data types using ->.

Deprecated Component Access

Component access by adding an optional integer in the function arguments (e.g., f = ball.force.unbal(bp,3)) is deprecated. It remains available but will not be supported in future versions. See Component Access with Integers in FISH on the Deprecated Commands and FISH page for details.

This is hidden. Added to include remaining tensor component access functions for inline help.

f = ball.force.unbal.y(bp)

f = ball.force.unbal.z(bp) (3D ONLY)