itasca.pebblefacetarray

Array interface for Itasca pebble-facet contacts.

Functions

itasca.pebblefacetarray.branch() → array float{contact,3}.

Get a numpy array of the contact branch vectors in the global coordinate system.

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

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

itasca.pebblefacetarray.fill_branch(data: array float{contact, 3}) → None.

Fill an existing array with the contact branch vectors in the global coordinate system. The array must be the correct shape.

itasca.pebblefacetarray.fill_force_global(data: array float{contact, 3}) → None.

Fill an existing array with the contact force in the global coordinate system. The array must be the correct shape.

itasca.pebblefacetarray.fill_force_local(data: array float{contact, 3}) → None.

Fill an existing array with the contact force in the local coordinate system. The array must be the correct shape.

itasca.pebblefacetarray.fill_force_normal(data: array float{contact}) → None.

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

itasca.pebblefacetarray.fill_force_shear(data: array float{contact}) → None.

Fill an existing array with the contact shear force magnitude. The array must be the correct shape.

itasca.pebblefacetarray.fill_gap(data: array float{contact}) → None.

Fill an existing array with the contact gap. The array must be the correct shape.

itasca.pebblefacetarray.fill_moment1_global(data: array float{contact, 3}) → None.

Fill an existing array with the contact moment acting on end 1 in the global coordinate system. The array must be the correct shape.

itasca.pebblefacetarray.fill_moment1_local(data: array float{contact, 3}) → None.

Fill an existing array with the contact moment acting on end 1 in the local coordinate system. The array must be the correct shape.

itasca.pebblefacetarray.fill_moment2_global(data: array float{contact, 3}) → None.

Fill an existing array with the contact moment acting on end 2 in the global coordinate system. The array must be the correct shape.

itasca.pebblefacetarray.fill_moment2_local(data: array float{contact, 3}) → None.

Fill an existing array with the contact moment acting on end 2 in the local coordinate system. The array must be the correct shape.

itasca.pebblefacetarray.fill_normal(data: array float{contact, 3}) → None.

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

itasca.pebblefacetarray.fill_offset(data: array float{contact, 3}) → None.

Fill an existing array with the contact offset. The array must be the correct shape.

itasca.pebblefacetarray.fill_pos(data: array float{contact, 3}) → None.

Fill an existing array with the contact position. The array must be the correct shape.

itasca.pebblefacetarray.force_global() → array float{contact,3}.

Get a numpy array of the contact force in the global coordinate system.

itasca.pebblefacetarray.force_local() → array float{contact,3}.

Get a numpy array of the contact force in the local coordinate system.

itasca.pebblefacetarray.force_normal() → array float{contact}.

Get a numpy array of the contact normal force.

itasca.pebblefacetarray.force_shear() → array float{contact}.

Get a numpy array of the contact shear force magnitude.

itasca.pebblefacetarray.gap() → array float{contact}.

Get a numpy array of the contact gap.

itasca.pebblefacetarray.ids() → array int{contact}.

Get the contact ids as an array.

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

Return contact group membership as a Boolean array.

itasca.pebblefacetarray.moment1_global() → array float{contact,3}.

Get a numpy array of the contact moment acting on end 1 in the global coordinate system.

itasca.pebblefacetarray.moment1_local() → array float{contact,3}.

Get a numpy array of the contact moment acting on end 1 in the local coordinate system.

itasca.pebblefacetarray.moment2_global() → array float{contact,3}.

Get a numpy array of the contact moment acting on end 2 in the global coordinate system.

itasca.pebblefacetarray.moment2_local() → array float{contact,3}.

Get a numpy array of the contact moment acting on end 2 in the local coordinate system.

itasca.pebblefacetarray.normal() → array float{contact,3}.

Get a numpy array of the contact normal.

itasca.pebblefacetarray.offset() → array float{contact,3}.

Get a numpy array of the contact offset.

itasca.pebblefacetarray.pos() → array float{contact,3}.

Get a numpy array of the contact position.

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

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

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

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