itasca.clump.cfd.pebble

Functions and classes for working with Itasca cfd pebbles.

Functions

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

Get the number of CFD pebbles.

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

Get the CFD pebble object with the given ID number.

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

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

itasca.clump.cfd.pebble.list() → CFD pebble iterator object.

Get a CFD pebble iterator object.

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

Get the maximum CFD pebble ID.

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

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

Classes