contact.branch

Syntax

v = contact.branch(c)

Get the contact branch vector is defined as the difference between body centroids from end1 to end2. For contacts with wall facets, the branch vector is twice the vector from the contact position to the end1 position.

Returns:

v - contact branch (vector)

Arguments:

c - mechanical contact pointer

Component Access

f = contact.branch (c)->x

f = contact.branch.x(c)

Get the \(x\)-component of the contact branch vector.

Returns:

f - \(x\)-component of the contact branch vector.

Arguments:

c - contact 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 = contact.branch(c,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 vector component access functions for inline help.

f = contact.branch.y(c)

f = contact.branch.z(c) (3D ONLY)