clump.moi.real — PFC 6.0 documentation

t = clump.moi.real(c<,i1<,i2>>)

clump.moi.real(c<,i1<,i2>>) = 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:

Returns:	t - clump real moment of inertia tensor or value
Accepts:	t - clump real moment of inertia tensor or value
Arguments:	c - clump pointer i1 - Optional tensor index that, if given without i2, ranges from 1 to 7, accessing the xx, yy, zz, xy, xz, and yz tensor values. i2 - Optional tensor notation that must be given with i1. In this case, i1 corresponds to the first index of the tensor position and i2 to the second in the row/column format. For instance, i1 = 1 and i2 = 3 returns the xz tensor value.

t - clump real moment of inertia tensor or value

Accepts:

t - clump real moment of inertia tensor or value

Arguments:

c - clump pointer

i1 - Optional tensor index that, if given without i2, ranges from 1 to 7, accessing the xx, yy, zz, xy, xz, and yz tensor values.

i2 - Optional tensor notation that must be given with i1. In this case, i1 corresponds to the first index of the tensor position and i2 to the second in the row/column format. For instance, i1 = 1 and i2 = 3 returns the xz tensor value.

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

clump.moi.real.xx(c) = 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

f = clump.moi.real.xy(c) (3D ONLY)

clump.moi.real.xy(c) = f (3D ONLY)

Get/set the xy-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 - xy-value of the clump real moment of inertia tensor
Accepts:	f - xy-value of the clump real moment of inertia tensor
Arguments:	c - clump pointer

f = clump.moi.real.xz(c) (3D ONLY)

clump.moi.real.xz(c) = f (3D ONLY)

Get/set the xz-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 - xz-value of the clump real moment of inertia tensor
Accepts:	f - xz-value of the clump real moment of inertia tensor
Arguments:	c - clump pointer

f = clump.moi.real.yy(c) (3D ONLY)

clump.moi.real.yy(c) = f (3D ONLY)

Get/set the yy-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 - yy-value of the clump real moment of inertia tensor
Accepts:	f - yy-value of the clump real moment of inertia tensor
Arguments:	c - clump pointer

f = clump.moi.real.yz(c) (3D ONLY)

clump.moi.real.yz(c) = f (3D ONLY)

Get/set the yz-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 - yz-value of the clump real moment of inertia tensor
Accepts:	f - yz-value of the clump real moment of inertia tensor
Arguments:	c - clump pointer

f = clump.moi.real.zz(c) (3D ONLY)

clump.moi.real.zz(c) = f (3D ONLY)

Get/set the zz-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 - zz-value of the clump real moment of inertia tensor
Accepts:	f - zz-value of the clump real moment of inertia tensor
Arguments:	c - clump pointer