itasca.blockarray

Array interface for 3DEC blocks.

Functions

itasca.blockarray.area() → array float{block}.

Get a numpy array of the block area.

itasca.blockarray.density() → array float{block}.

Get a numpy array of the block density.

itasca.blockarray.dsf() → array float{block}.

Get a numpy array of the block density scaling factor.

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

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

itasca.blockarray.fill_pos(data: array float{block, 3}) → None.

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

itasca.blockarray.ids() → array int{block}.

Get the block ids as an array.

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

Return block group membership as a Boolean array.

itasca.blockarray.is_excavated() → array bool{block}.

Get a numpy array of the block excavated flag.

itasca.blockarray.is_rigid() → array bool{block}.

Get a numpy array of the block rigid flag.

itasca.blockarray.pos() → array float{block,3}.

Get a numpy array of the block centroid location.

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

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

itasca.blockarray.set_group(membership: array bool{nblock}, 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.

itasca.blockarray.vol() → array float{block}.

Get a numpy array of the block volumic.