contact.offset

Syntax

v = contact.offset(c)

Get the contact offset. The contact offset vector is used when domain periodic boundary conditions are active.

Returns:

v - contact offset vector

Arguments:

c - contact pointer

Component Access

f = contact.offset (c)->x

f = contact.offset.x(c)

Get the \(x\)-component of the contact offset.

Returns:

f - \(x\)-component of the contact offset 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.offset(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.offset.y(c)

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