clump.force.unbal

Syntax

v = clump.force.unbal(cp)

Get the clump unbalanced force.

Returns:

v - clump unbalanced force vector

Arguments:

cp - clump pointer

Component Access

f = clump.force.unbal (cp)->x

f = clump.force.unbal.x(cp)

Get the \(x\)-component of the clump unbalanced force vector.

Returns:

f - \(x\)-component of the clump unbalanced force vector

Arguments:

cp - clump 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 = clump.force.unbal(cp,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 = clump.force.unbal.y(cp)

f = clump.force.unbal.z(cp) (3D ONLY)