itasca.flowplanearray

Array interface for 3DEC flowplanes array.

Functions

itasca.flowplanearray.extra(slot: int) → array float{flowplane} or float{flowplane,3}.

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

itasca.flowplanearray.ids() → array int{flowplane}.

Get the flowplane ids as an array.

itasca.flowplanearray.in_group(group_name: str, slot='default') → array bool{nflowplane}.

Return block group membership as a Boolean array.

itasca.flowplanearray.set_extra(slot: int, data: array float{flowplane} or float{flowplane, 3}) → None.

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

itasca.flowplanearray.set_group(membership: array bool{nflowplane}, group_name: str, slot="default") → None.

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