FISH Functions

The type specifiers used in the FISH function signatures are given in the “FISH Type Index” section.

Ball Utilities

ball.energy(STR) Get the ball total energy contribution.
ball.find(INT) Find a ball.
ball.groupmap(STR<,INT>) Get balls that belong to a group.
ball.inbox(VEC,VEC<,BOOL>) Get balls with extents intersecting a box.
ball.list Get the global ball list.
ball.maxid Get the maximum ball ID.
ball.mech.ratio.avg Get the ball average unbalanced force ratio.
ball.mech.ratio.local Get the ball maximum local unbalanced force ratio.
ball.mech.ratio.max Get the ball maximum unbalanced force ratio.
ball.mech.unbal.max Get the ball maximum unbalanced force.
ball.near(VEC<,FLT>) Find the closest ball to a point.
ball.num Get the number of balls.
ball.typeid Get the ball type number.

Ball Intrinsics

ball.contactmap(B_PNT<,INT,PNT>) Get active contacts around a ball.
ball.contactmap.all(B_PNT<,INT,PNT>) Get all contacts around a ball.
ball.contactnum(B_PNT<,INT>) Get number of active contacts around a ball.
ball.contactnum.all(B_PNT<,INT>) Get number of contacts around a ball.
ball.create(FLT,VEC<,INT>) Create a ball.
ball.damp(B_PNT) Get/set ball local damping factor.
ball.delete(B_PNT) Delete a ball.
ball.density(B_PNT) Get/set ball density.
ball.disp(B_PNT<,INT>) Get/set the ball displacement.
ball.euler(B_PNT<,INT>)(3D ONLY) Get/set the ball orientation.
ball.extra(B_PNT<,INT>) Get/set ball extra variable.
ball.fix(B_PNT,INT) Get/set ball fixity condition.
ball.force.app(B_PNT<,INT>) Get/set the ball applied force.
ball.force.contact(B_PNT<,INT>) Get/set the ball contact force.
ball.force.unbal(B_PNT<,INT>) Get the ball unbalanced force.
ball.fragment(B_PNT) Get/set ball fragment ID.
ball.group(B_PNT<,STR>) Get/set ball groups.
ball.group.remove(B_PNT,STR) Remove ball groups.
ball.id(B_PNT) Get the ball ID.
ball.isbonded(B_PNT<,INT,PNT>) Get the ball bonded state.
ball.isgroup(B_PNT,STR<,STR>) Query the existence of a group.
ball.isprop(B_PNT,STR) Query the existence of a property.
ball.mass(B_PNT) Get the inertial ball mass.
ball.mass.real(B_PNT) Get the real (gravitational) ball mass.
ball.moi(B_PNT) Get the ball moment of inertia.
ball.moi.real(B_PNT) Get the real (gravitational) ball moment of inertia.
ball.moment.app(B_PNT<,INT>) Get/set the ball applied moment.
ball.moment.contact(B_PNT<,INT>) Get/set the ball contact moment.
ball.moment.unbal(B_PNT<,INT>) Get the ball unbalanced moment.
ball.pos(B_PNT<,INT>) Get/set the ball position.
ball.prop(B_PNT,STR) Get/set a ball property.
ball.radius(B_PNT) Get/set ball radius.
ball.rotation(B_PNT)(2D ONLY) Get/set the ball orientation.
ball.spin(B_PNT<,INT>) Get/set the ball angular velocity.
ball.stress(B_PNT<,INT,INT>) Get the stress tensor arising from all contacts acting on...
ball.stress.full(B_PNT) Get the full stress tensor arising from all contacts acting...
ball.vel(B_PNT<,INT>) Get/set the ball velocity.
ball.vol(B_PNT) Get ball volume.