itasca.flowplane.zonearray

Array interface for flowplane zones.

Functions

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

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

itasca.flowplane.zonearray.ids() → array int{flowplane zone}.

Get the flowplane zone ids as an array.

itasca.flowplane.zonearray.in_group(group_name: str, slot='default') → array bool{nzone}.

Return block group membership as a Boolean array.

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

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

itasca.flowplane.zonearray.set_group(membership: array bool{nzone}, 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.