clump.force.contact

Syntax

v = clump.force.contact(cp)

clump.force.contact(cp) = v

Get/set the clump contact force. The contact force vector is defined as the sum of the contact force vectors acting on the ball and is updated during force-displacement calculation.

Returns:

v - clump contact force vector

Accepts:

v - clump contact force vector

Arguments:

cp - clump pointer

Component Access

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

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

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

Get/set the $x$-component of the clump contact force.

Returns:

f - $x$-component of the clump contact force vector

Accepts:

f - $x$-component of the clump contact 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.contact(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.contact.y(cp)

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