clump.moi.real

Syntax

t = clump.moi.real(cp)
clump.moi.real(cp) = t

Get/set the clump real moment of inertia.

Note

  • In 2D, the polar moment of inertia is used so the optional integers are not available and a float is returned.

  • 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:

t - clump real moment of inertia tensor

Accepts:

t - clump real moment of inertia tensor

Arguments:

cp - clump pointer

Component Access

f = clump.moi.real (cp)->xx
clump.moi.real (cp)->xx = f

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

Get/set the \(xx\)-value of the clump real 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:

f - \(xx\)-value of the clump real moment of inertia tensor

Accepts:

f - \(xx\)-value of the clump real moment of inertia tensor

Arguments:

c - clump pointer

Access other tensor components (\(yy\), \(zz\), \(xy\), \(xz\), \(yz\)) by substituting the component name where \(xx\) appears above. \(xz\), \(yz\), and \(zz\) are 3D only. See Member Access Operator for information about accessing members from data types using ->.

Deprecated Component Access

Component access by adding optional integer(s) in the function arguments (e.g., f = clump.moi.real(cp, 1, 1)) 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.real.xy(cp)
f = clump.moi.real.xz(cp) (3D only)
f = clump.moi.real.yy(cp)
f = clump.moi.real.yz(cp) (3D only)
f = clump.moi.real.zz(cp) (3D only)