itasca.clump.cfd

Functions and classes for working with Itasca clump cfd.

Functions

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

Get the number of CFD clumps.

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

Get the CFD clump object with the given ID number.

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

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

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

Get a CFD clump iterator object.

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

Get the maximum CFD clump ID.

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

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

Classes

Sub-modules