itasca.pebblearray
Array interface for Itasca pebbles.
Functions
- itasca.pebblearray.extra(slot: int) array float{pebble} or float{pebble,3}.
Get the pebble extra data in the given slot as an array. Extra variables accessed by array must be of type float or vec.
- itasca.pebblearray.fill_pos(data: array float{pebble, 3}) None.
Fill an existing array with the pebble location. The array must be the correct shape.
- itasca.pebblearray.fill_radius(data: array float{ball}) None.
Fill an existing array with the pebble radii. The array must be the correct shape.
- itasca.pebblearray.fill_vel(data: array float{pebble, 3}) None.
Fill an existing array with the pebble velocity. The array must be the correct shape.
- itasca.pebblearray.ids() array int{pebble}.
Get the pebble ids as an array.
- itasca.pebblearray.in_group(group_name: str, slot=1) array bool{pebble}.
Return pebble group membership as a Boolean array.
- itasca.pebblearray.pos() array float{pebble,3}.
Get a numpy array of the pebble location.
- itasca.pebblearray.radius() array float{ball}.
Get a numpy array of the pebble radii.
- itasca.pebblearray.set_extra(slot: int, data: array float{pebble} or float{pebble, 3}) None.
Set the pebble extra data in the given slot with an array. Extra variables set by array must be of type float or vec.
- itasca.pebblearray.set_group(membership: array bool{pebble}, group_name: str, slot=1) None.
Set pebble group from an array. Where membership True set the corresponding pebble to be a member of group group_name in the given slot.
- itasca.pebblearray.set_pos(data: array float{pebble, 3}) None.
Set the pebble location from an array.
- itasca.pebblearray.set_radius(data: array float{ball}) None.
Set the pebble radii from an array.
- itasca.pebblearray.vel() array float{pebble,3}.
Get a numpy array of the pebble velocity.
Was this helpful? ... | Itasca Software © 2024, Itasca | Updated: Aug 13, 2024 |