itasca.rblockarray

Array interface for Itasca rblocks.

Functions

itasca.rblockarray.damp() → array float{rblock}.

Get a numpy array of the rblock local damping.

itasca.rblockarray.density() → array float{rblock}.

Get a numpy array of the rblock density.

itasca.rblockarray.disp() → array float{rblock,2}.

Get a numpy array of the rblock displacement.

itasca.rblockarray.extra(slot: int) → array float{rblock} or float{rblock}.

Get the rblock extra data in the given slot as an array. Extra variables accessed by array must be of type float or vec.

itasca.rblockarray.fill_damp(data: array float{rblock}) → None.

Fill an existing array with the rblock local damping. The array must be the correct shape.

itasca.rblockarray.fill_density(data: array float{rblock}) → None.

Fill an existing array with the rblock density. The array must be the correct shape.

itasca.rblockarray.fill_disp(data: array float{rblock, 2}) → None.

Fill an existing array with the rblock displacement. The array must be the correct shape.

itasca.rblockarray.fill_force_app(data: array float{rblock, 2}) → None.

Fill an existing array with the rblock applied force. The array must be the correct shape.

itasca.rblockarray.fill_force_contact(data: array float{rblock, 2}) → None.

Fill an existing array with the rblock contact force. The array must be the correct shape.

itasca.rblockarray.fill_force_unbal(data: array float{rblock, 2}) → None.

Fill an existing array with the rblock unbalanced force. The array must be the correct shape.

itasca.rblockarray.fill_mass(data: array float{rblock}) → None.

Fill an existing array with the inertial rblock mass. The array must be the correct shape.

itasca.rblockarray.fill_mass_real(data: array float{rblock}) → None.

Fill an existing array with the real (gravitational) rblock mass. The array must be the correct shape.

itasca.rblockarray.fill_moi_prin_real(data: array float{rblock, dim}) → None.

Fill an existing array with the rblock principal moments of inertia. The array must be the correct shape.

itasca.rblockarray.fill_moment_app(data: array float{rblock}) → None.

Fill an existing array with the rblock applied moment. The array must be the correct shape.

itasca.rblockarray.fill_moment_contact(data: array float{rblock}) → None.

Fill an existing array with the rblock contact moment. The array must be the correct shape.

itasca.rblockarray.fill_moment_unbal(data: array float{rblock}) → None.

Fill an existing array with the rblock unbalanced moment. The array must be the correct shape.

itasca.rblockarray.fill_pos(data: array float{rblock, 2}) → None.

Fill an existing array with the rblock centroid location. The array must be the correct shape.

itasca.rblockarray.fill_rotation(data: array float{rblock}) → None.

Fill an existing array with the rblock orientation. The array must be the correct shape.

itasca.rblockarray.fill_spin(data: array float{rblock}) → None.

Fill an existing array with the rblock angular velocity. The array must be the correct shape.

itasca.rblockarray.fill_vel(data: array float{rblock, 2}) → None.

Fill an existing array with the rblock velocity. The array must be the correct shape.

itasca.rblockarray.fill_vol(data: array float{rblock}) → None.

Fill an existing array with the rblock volume. The array must be the correct shape.

itasca.rblockarray.force_app() → array float{rblock,2}.

Get a numpy array of the rblock applied force.

itasca.rblockarray.force_contact() → array float{rblock,2}.

Get a numpy array of the rblock contact force.

itasca.rblockarray.force_unbal() → array float{rblock,2}.

Get a numpy array of the rblock unbalanced force.

itasca.rblockarray.ids() → array int{rblock}.

Get the rblock ids as an array.

itasca.rblockarray.in_group(group_name: str, slot=1) → array bool{rblock}.

Return rblock group membership as a Boolean array.

itasca.rblockarray.mass() → array float{rblock}.

Get a numpy array of the inertial rblock mass.

itasca.rblockarray.mass_real() → array float{rblock}.

Get a numpy array of the real (gravitational) rblock mass.

itasca.rblockarray.moi_prin_real() → array float{rblock,dim}.

Get a numpy array of the rblock principal moments of inertia.

itasca.rblockarray.moment_app() → array float{rblock}.

Get a numpy array of the rblock applied moment.

itasca.rblockarray.moment_contact() → array float{rblock}.

Get a numpy array of the rblock contact moment.

itasca.rblockarray.moment_unbal() → array float{rblock}.

Get a numpy array of the rblock unbalanced moment.

itasca.rblockarray.pos() → array float{rblock,2}.

Get a numpy array of the rblock centroid location.

itasca.rblockarray.rotation() → array float{rblock}.

Get a numpy array of the rblock orientation.

itasca.rblockarray.set_damp(data: array float{rblock}) → None.

Set the rblock local damping from an array.

itasca.rblockarray.set_density(data: array float{rblock}) → None.

Set the rblock density from an array.

itasca.rblockarray.set_disp(data: array float{rblock, 2}) → None.

Set the rblock displacement from an array.

itasca.rblockarray.set_extra(slot: int, data: array float{rblock} or float{rblock}) → None.

Set the rblock extra data in the given slot with an array. Extra variables set by array must be of type float or vec.

itasca.rblockarray.set_force_app(data: array float{rblock, 2}) → None.

Set the rblock applied force from an array.

itasca.rblockarray.set_force_contact(data: array float{rblock, 2}) → None.

Set the rblock contact force from an array.

itasca.rblockarray.set_group(membership: array bool{rblock}, group_name: str, slot=1) → None.

Set rblock group from an array. Where membership True set the corresponding rblock to be a member of group group_name in the given slot.

itasca.rblockarray.set_moi_prin_real(data: array float{rblock, dim}) → None.

Set the rblock principal moments of inertia from an array. When modified no other rblock attributes are changed (e.g., pebble sizes, rblock volume, etc.). 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 rblock unless the user changes the fix state.

itasca.rblockarray.set_moment_app(data: array float{rblock}) → None.

Set the rblock applied moment from an array.

itasca.rblockarray.set_moment_contact(data: array float{rblock}) → None.

Set the rblock contact moment from an array.

itasca.rblockarray.set_pos(data: array float{rblock, 2}) → None.

Set the rblock centroid location from an array.

itasca.rblockarray.set_rotation(data: array float{rblock}) → None.

Set the rblock orientation from an array.

itasca.rblockarray.set_spin(data: array float{rblock}) → None.

Set the rblock angular velocity from an array.

itasca.rblockarray.set_vel(data: array float{rblock, 2}) → None.

Set the rblock velocity from an array.

itasca.rblockarray.set_vol(data: array float{rblock}) → None.

Set the rblock volume from an array. In 2D this is the volume per unit thickness. When modified no other rblock attributes are changed (e.g., moment of inertia, pebble sizes, etc.). The specification of the volume 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 rblock unless the user changes the fix state.

itasca.rblockarray.spin() → array float{rblock}.

Get a numpy array of the rblock angular velocity.

itasca.rblockarray.vel() → array float{rblock,2}.

Get a numpy array of the rblock velocity.

itasca.rblockarray.vol() → array float{rblock}.

Get a numpy array of the rblock volume.