clump.pebble.pos

Syntax

v = clump.pebble.pos(p)

clump.pebble.pos(p) = v

Get/set the pebble position. No clump attributes are changed upon assignment (e.g., volume, moment of inertia, etc.).

Note

Only clump template pebbles where no clump in the model refers to the clump template can be modified.

Returns:

v - pebble position vector or component

Accepts:

v - pebble position vector or component

Arguments:

p - pebble pointer

Component Access

f = clump.pebble.pos (p)->x
clump.pebble.pos (p)->x = f

f = clump.pebble.pos.x(p)

clump.pebble.pos.x(p) = f

Get/set the \(x\)-component of the pebble position. No clump attributes are changed upon assignment (e.g., volume, moment of inertia, etc.).

Note

Only clump template pebbles where no clump in the model refers to the clump template can be modified.

Returns:

f - \(x\)-component of the pebble position vector

Accepts:

f - \(x\)-component of the pebble position vector

Arguments:

p - pebble 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.pebble.pos(p,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 = clump.pebble.pos.y(p)

f = clump.pebble.pos.z(p) (3D ONLY)