FISH Functions

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

Thermal Clump Utilities

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

Thermal Clump Intrinsics

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

Thermal Clump Pebble Utilities

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

Thermal Clump Pebble Intrinsics

clump.thermal.pebble.clump(CLPTH_PNT) Get the thermal pebble’s thermal clump.
clump.thermal.pebble.contactmap(CLPTH_PNT<,INT,PNT>) Get active thermal contacts around a thermal pebble.
clump.thermal.pebble.contactnum(CLPTH_PNT<,INT>) Get the number of active thermal contacts around a thermal...
clump.thermal.pebble.contactnum.all(CLPTH_PNT<,INT>) Get the number of thermal contacts around a thermal pebble.
clump.thermal.pebble.group(CLPTH_PNT<,STR>) Get/set thermal pebble groups.
clump.thermal.pebble.group.remove(CLPTH_PNT,STR) Remove thermal pebble groups.
clump.thermal.pebble.id(CLPTH_PNT) Get/set the thermal pebble ID.
clump.thermal.pebble.isgroup(CLPTH_PNT,STR<,STR>) Query the existence of a group.
clump.thermal.pebble.isprop(CLPTH_PNT,STR) Query the existence of a property.
clump.thermal.pebble.pebble(CLPTH_PNT) Get the host mechanical pebble.
clump.thermal.pebble.prop(CLPTH_PNT,STR) Get/set a thermal pebble property.