itasca.data.vectorarray

Functions and classes for working with UD vector array.

Functions

itasca.data.vectorarray.extra(slot: int) → array float{vector} or float{vector}.

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

itasca.data.vectorarray.ids() → array int{vector}.

Get the vector ids as an array.

itasca.data.vectorarray.in_group(group_name: str, slot=1) → array bool{vector}.

Return vector group membership as a Boolean array.

itasca.data.vectorarray.pos() → array vec{vector}.

Get a NumPy array of the current position of ud vectors.

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

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

itasca.data.vectorarray.set_group(membership: array bool{vector}, group_name: str, slot=1) → None.

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

itasca.data.vectorarray.set_pos(array vec{vector}) →

Set the position of ud vector array.

itasca.data.vectorarray.set_value(array vec{vector}) → None.

Set the values of ud vectors.

itasca.data.vectorarray.value() → array vec{vector}.

Get a NumPy array of the current value of ud vectors.