itasca.clump.pebble

Functions and classes for working with Itasca clump pebbles.

Functions

itasca.clump.pebble.count() → int.

Get the number of pebbles.

itasca.clump.pebble.find(id: int) → Pebble object.

Get the Pebble object with the given ID number.

itasca.clump.pebble.inbox(lower_bound: vec, upper_bound: vec, intersect=True) → Tuple of Pebble objects.

Get a tuple of pebbles with extents intersecting a box. The extent is the axis-aligned bounding box of the pebble. The if the optional keyword argument intersect is False only pebbles with positions falling in the box are returned.

itasca.clump.pebble.list() → Pebble iterator object.

Get a pebble iterator object.

itasca.clump.pebble.maxid() → int.

Get the maximum pebble ID.

itasca.clump.pebble.near(point: vec, radius=0.0) → Pebble object.

Find the closest pebble to a point. If the optional keyword argument radius is non-zero, only search within this radius.

Classes