clump.inbox

Syntax

a = clump.inbox(vl,vu<,b>)

Get clumps with extents intersecting a box. The extent is the axis-aligned bounding box of the clump. Specifying b = false indicates that only clumps with positions falling in the box are returned.

Note

• This function uses cell-space-based algorithms for efficient spatial searching, and therefore assumes that the clumps are properly mapped into the cell space. Directly after the model has been restored, after clumps have been created or clump pebbles added to existing clumps, one must execute a model clean command prior to using this function.

Returns:

a - array of clumps

Arguments:

vl - lower corner of the box

vu - upper corner of the box

b - optional intersection specifier