clump.moi.prin.real

Syntax

v = clump.moi.prin.real(cp)

clump.moi.prin.real(cp) = v

Get/set the clump real principal moment of inertia.

Note

When modified, no other clump attributes are changed (e.g., pebble sizes, clump volume). The specification of the moment of inertia in this way results in the principal moments of inertia being in a fixed state so that they will not be automatically updated when scaling a clump unless the user changes the fix state (see clump.moi.fix).

Returns:

v - clump real principal moment of inertia vector

Accepts:

v - clump real principal moment of inertia vector

Arguments:

cp - clump pointer

Component Access

f = clump.moi.prin.real (cp)->x
clump.moi.prin.real (cp)->x = f

f = clump.moi.prin.real.x(cp)

clump.moi.prin.real.x(cp) = f

Get/set the \(x\)-component of the clump principal moment of inertia.

Returns:

f - \(x\)-component of the clump real principal moment of inertia vector

Accepts:

f - \(x\)-component of the clump real principal moment of inertia 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.moi.prin.real(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 vector component access functions for inline help.

f = clump.moi.prin.real.y(cp)

f = clump.moi.prin.real.z(cp) (3D ONLY)