itasca.clump.thermal.pebble

Functions and classes for working with Itasca thermal pebbles.

Functions

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

Get the number of thermal pebbles.

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

Get the thermal pebble object with the given ID number.

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

Get a tuple of thermal 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 then only thermal pebbles with positions falling in the box are returned.

itasca.clump.thermal.pebble.list() → Thermal pebble iterator object.

Get a thermal pebble iterator object.

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

Get the maximum thermal pebble ID.

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

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

Classes