FISH Functions

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

Thermal Ball Utilities

ball.thermal.find(INT) Find a thermal ball.
ball.thermal.inbox(VEC,VEC<,BOOL>) Get thermal balls with extents intersecting a box.
ball.thermal.list Get the global thermal ball list.
ball.thermal.near(VEC<,FLT>) Find the closest thermal ball to a point.
ball.thermal.num Get the number of thermal balls.
ball.thermal.typeid Get the thermal ball type number.

Thermal Ball Intrinsics

ball.thermal.ball(BTH_PNT) Get the pointer to the host mechanical ball.
ball.thermal.contactmap(BTH_PNT<,INT,PNT>) Get active thermal contacts around a thermal ball.
ball.thermal.contactmap.all(BTH_PNT<,INT,PNT>) Get all thermal contacts around a thermal ball.
ball.thermal.contactnum(BTH_PNT<,INT>) Get number of active thermal contacts around a thermal ball.
ball.thermal.contactnum.all(BTH_PNT<,INT>) Get total number of thermal contacts around a thermal ball.
ball.thermal.expansion(BTH_PNT) Get/set the thermal expansion coefficient.
ball.thermal.extra(BTH_PNT<,INT>) Get/set the thermal ball extra variable.
ball.thermal.fix(BTH_PNT) Get/set the temperature fixity condition.
ball.thermal.group(BTH_PNT<,INT>) Get/set thermal ball groups.
ball.thermal.group.remove(BTH_PNT,STR) Remove thermal ball groups.
ball.thermal.id(BTH_PNT) Get the thermal ball ID.
ball.thermal.isgroup(BTH_PNT,STR<,STR>) Query the existence of a group.
ball.thermal.isprop(BTH_PNT,STR) Query the existence of a property.
ball.thermal.power.app(BTH_PNT) Get/set the thermal applied power.
ball.thermal.power.unbal(BTH_PNT) Get the unbalanced thermal power.
ball.thermal.prop(BTH_PNT,STR) Get/set a thermal ball property.
ball.thermal.specific.heat(BTH_PNT) Get/set the specific heat coefficient.
ball.thermal.temp(BTH_PNT) Get/set the temperature.
ball.thermal.temp.increment(BTH_PNT) Get/set the current temperature increment.