itasca.ball

Functions and classes for working with Itasca balls.

Functions

itasca.ball.containing(point: vec) Ball object.

Find the ball containing the point.

itasca.ball.count() int.

Get the number of balls.

itasca.ball.create(radius: double, centroid: vec[, id: int]) Ball object.

Create a ball.

itasca.ball.energy(energy_name: str) float.

Get the ball total energy contribution.

itasca.ball.find(id: int) Ball object.

Get the ball object with the given ID number.

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

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

itasca.ball.list() Ball iterator object.

Get a ball iterator object.

itasca.ball.maxid() int.

Get the maximum ball ID.

itasca.ball.near(point: vec, radius=0.0) Ball object.

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

Classes

Sub-modules