itasca.clump.thermal

Functions and classes for working with Itasca thermal clumps.

Functions

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

Get the number of thermal clumps.

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

Get the thermal clump object with the given ID number.

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

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

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

Get a thermal clump iterator object.

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

Get the thermal maximum clump ID.

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

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

Classes

• ThermalClump

Sub-modules

• pebble
  • ThermalPebble