clump.disp

Syntax

v = clump.disp(cp)

clump.disp(cp) = v

Get/set the clump displacement.

Returns:

v - clump displacement vector

Accepts:

v - clump displacement vector

Arguments:

cp - clump pointer

Component Access

f = clump.disp (cp)->x
clump.disp (cp)->x = f

f = clump.disp.x(cp)

clump.disp.x(cp) = f

Get/set the \(x\)-component of the clump displacement.

Returns:

f - \(x\)-component of the clump displacement vector

Accepts:

f - \(x\)-component of the clump displacement 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.disp(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.disp.y(cp)

f = clump.disp.z(cp) (3D ONLY)