contact.offset

Syntax

Vector Access

v = contact.offset(c<,i>)

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

Returns:

v - contact offset vector or component
Arguments:

c - contact pointer

i - optional vector component

Component Access

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
f = contact.offset.y(c)

Get the y-component of the contact offset.

Returns:f - y-component of the contact offset vector
Arguments:c - contact pointer
f = contact.offset.z(c) (3D ONLY)

Get the z-component of the contact offset.

Returns:f - z-component of the contact offset vector
Arguments:c - contact pointer