itasca.clumparray

Array interface for Itasca clumps.

Functions

itasca.clumparray.damp() → array float{clump}.

Get a numpy array of the clump local damping.

itasca.clumparray.density() → array float{clump}.

Get a numpy array of the clump density.

itasca.clumparray.disp() → array float{clump,2}.

Get a numpy array of the clump displacement.

itasca.clumparray.extra(slot: int) → array float{clump} or float{clump}.

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

itasca.clumparray.fill_damp(data: array float{clump}) → None.

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

itasca.clumparray.fill_density(data: array float{clump}) → None.

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

itasca.clumparray.fill_disp(data: array float{clump, 2}) → None.

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

itasca.clumparray.fill_force_app(data: array float{clump, 2}) → None.

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

itasca.clumparray.fill_force_contact(data: array float{clump, 2}) → None.

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

itasca.clumparray.fill_force_unbal(data: array float{clump, 2}) → None.

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

itasca.clumparray.fill_mass(data: array float{clump}) → None.

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

itasca.clumparray.fill_mass_real(data: array float{clump}) → None.

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

itasca.clumparray.fill_moi_prin_real(data: array float{clump, dim}) → None.

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

itasca.clumparray.fill_moment_app(data: array float{clump}) → None.

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

itasca.clumparray.fill_moment_contact(data: array float{clump}) → None.

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

itasca.clumparray.fill_moment_unbal(data: array float{clump}) → None.

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

itasca.clumparray.fill_pos(data: array float{clump, 2}) → None.

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

itasca.clumparray.fill_rotation(data: array float{clump}) → None.

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

itasca.clumparray.fill_spin(data: array float{clump}) → None.

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

itasca.clumparray.fill_vel(data: array float{clump, 2}) → None.

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

itasca.clumparray.fill_vol(data: array float{clump}) → None.

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

itasca.clumparray.force_app() → array float{clump,2}.

Get a numpy array of the clump applied force.

itasca.clumparray.force_contact() → array float{clump,2}.

Get a numpy array of the clump contact force.

itasca.clumparray.force_unbal() → array float{clump,2}.

Get a numpy array of the clump unbalanced force.

itasca.clumparray.ids() → array int{clump}.

Get the clump ids as an array.

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

Return clump group membership as a Boolean array.

itasca.clumparray.mass() → array float{clump}.

Get a numpy array of the inertial clump mass.

itasca.clumparray.mass_real() → array float{clump}.

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

itasca.clumparray.moi_prin_real() → array float{clump,dim}.

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

itasca.clumparray.moment_app() → array float{clump}.

Get a numpy array of the clump applied moment.

itasca.clumparray.moment_contact() → array float{clump}.

Get a numpy array of the clump contact moment.

itasca.clumparray.moment_unbal() → array float{clump}.

Get a numpy array of the clump unbalanced moment.

itasca.clumparray.pos() → array float{clump,2}.

Get a numpy array of the clump centroid location.

itasca.clumparray.rotation() → array float{clump}.

Get a numpy array of the clump orientation.

itasca.clumparray.set_damp(data: array float{clump}) → None.

Set the clump local damping from an array.

itasca.clumparray.set_density(data: array float{clump}) → None.

Set the clump density from an array.

itasca.clumparray.set_disp(data: array float{clump, 2}) → None.

Set the clump displacement from an array.

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

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

itasca.clumparray.set_force_app(data: array float{clump, 2}) → None.

Set the clump applied force from an array.

itasca.clumparray.set_force_contact(data: array float{clump, 2}) → None.

Set the clump contact force from an array.

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

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

itasca.clumparray.set_moi_prin_real(data: array float{clump, dim}) → None.

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

itasca.clumparray.set_moment_app(data: array float{clump}) → None.

Set the clump applied moment from an array.

itasca.clumparray.set_moment_contact(data: array float{clump}) → None.

Set the clump contact moment from an array.

itasca.clumparray.set_pos(data: array float{clump, 2}) → None.

Set the clump centroid location from an array.

itasca.clumparray.set_rotation(data: array float{clump}) → None.

Set the clump orientation from an array.

itasca.clumparray.set_spin(data: array float{clump}) → None.

Set the clump angular velocity from an array.

itasca.clumparray.set_vel(data: array float{clump, 2}) → None.

Set the clump velocity from an array.

itasca.clumparray.set_vol(data: array float{clump}) → None.

Set the clump volume from an array. In 2D this is the volume per unit thickness. When modified no other clump 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 clump unless the user changes the fix state.

itasca.clumparray.spin() → array float{clump}.

Get a numpy array of the clump angular velocity.

itasca.clumparray.vel() → array float{clump,2}.

Get a numpy array of the clump velocity.

itasca.clumparray.vol() → array float{clump}.

Get a numpy array of the clump volume.