itasca.ball.cfd

Functions and classes for working with Itasca CFD balls.

Functions

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

Get the number of CFD balls.

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

Get the CFD ball object with the given ID number.

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

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

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

Get a CFD ball iterator object.

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

Get the maximum CFD ball ID.

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

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

Classes