itasca.facetarray

Array interface for Itasca facets.

Functions

itasca.facetarray.conveyor() → array float{facet,dim}.

Get a numpy array of the facet conveyor velocity.

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

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

itasca.facetarray.fill_conveyor(data: array float{facet, dim}) → None.

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

itasca.facetarray.fill_normal(data: array float{facet, dim}) → None.

Fill an existing array with the facet normal. The array must be the correct shape.

itasca.facetarray.fill_pos(data: array float{facet, 3}) → None.

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

itasca.facetarray.ids() → array int{facet}.

Get the facet ids as an array.

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

Return facet group membership as a Boolean array.

itasca.facetarray.normal() → array float{facet,dim}.

Get a numpy array of the facet normal.

itasca.facetarray.pos() → array float{facet,3}.

Get a numpy array of the facet location.

itasca.facetarray.set_conveyor((data: array float{facet, dim}) → None.

Set the facet conveyor velocity from an array.

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

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

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

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