clump.template.moi

Syntax

t = clump.template.moi(cp)

Get the clump template 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.

Returns:

t - clump template moment of inertia tensor or value

Arguments:

cp - clump template pointer

Component Access

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

Get the \(xx\)-value of the clump template moment of inertia.

Returns:

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

Arguments:

cp - clump template 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.template.moi(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.template.moi.xy(cp)

f = clump.template.moi.xz(cp) (3D only)

f = clump.template.moi.yy(cp)

f = clump.template.moi.yz(cp) (3D only)

f = clump.template.moi.zz(cp) (3D only)