itasca.wallarray

Array interface for Itasca walls.

Functions

itasca.wallarray.cutoff() → array float{wall}.

Get a numpy array of the wall cutoff angle.

itasca.wallarray.disp() → array float{wall,2}.

Get a numpy array of the wall displacement.

itasca.wallarray.extra(slot: int) → array float{wall} or float{wall}.

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

itasca.wallarray.fill_cutoff(data: array float{wall}) → None.

Fill an existing array with the wall cutoff angle. The array must be the correct shape.

itasca.wallarray.fill_disp(data: array float{wall, 2}) → None.

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

itasca.wallarray.fill_force_contact(data: array float{wall, 2}) → None.

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

itasca.wallarray.fill_moment_contact(data: array float{wall}) → None.

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

itasca.wallarray.fill_pos(data: array float{wall, 2}) → None.

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

itasca.wallarray.fill_rotation(data: array float{wall}) → None.

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

itasca.wallarray.fill_rotation_center(data: array float{wall, dim}) → None.

Fill an existing array with the wall center of rotation. The array must be the correct shape.

itasca.wallarray.fill_spin(data: array float{wall}) → None.

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

itasca.wallarray.fill_vel(data: array float{wall, 2}) → None.

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

itasca.wallarray.force_contact() → array float{wall,2}.

Get a numpy array of the wall contact force.

itasca.wallarray.ids() → array int{wall}.

Get the wall ids as an array.

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

Return wall group membership as a Boolean array.

itasca.wallarray.moment_contact() → array float{wall}.

Get a numpy array of the wall contact moment.

itasca.wallarray.pos() → array float{wall,2}.

Get a numpy array of the wall location.

itasca.wallarray.rotation() → array float{wall}.

Get a numpy array of the wall orientation.

itasca.wallarray.rotation_center() → array float{wall,dim}.

Get a numpy array of the wall center of rotation.

itasca.wallarray.set_cutoff(data: array float{wall}) → None.

Set the wall cutoff angle from an array.

itasca.wallarray.set_disp(data: array float{wall, 2}) → None.

Set the wall displacement from an array.

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

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

itasca.wallarray.set_force_contact(data: array float{wall, 2}) → None.

Set the wall contact force from an array.

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

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

itasca.wallarray.set_moment_contact(data: array float{wall}) → None.

Set the wall contact moment from an array.

itasca.wallarray.set_pos(data: array float{wall, 2}) → None.

Set the wall location from an array.

itasca.wallarray.set_rotation(data: array float{wall}) → None.

Set the wall orientation from an array.

itasca.wallarray.set_rotation_center((data: array float{wall, dim}) → None.

Set the wall center of rotation from an array.

itasca.wallarray.set_spin(data: array float{wall}) → None.

Set the wall angular velocity from an array.

itasca.wallarray.set_vel(data: array float{wall, 2}) → None.

Set the wall velocity from an array.

itasca.wallarray.spin() → array float{wall}.

Get a numpy array of the wall angular velocity.

itasca.wallarray.vel() → array float{wall,2}.

Get a numpy array of the wall velocity.