FISH Functions

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

Clump CFD Utilities

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

Clump CFD Intrinsics

clump.cfd.clump(CLCF_PNT) Get the pointer to the host mechanical clump.
clump.cfd.elementmap(CLCF_PNT) Get the CCFD element associated with a clump.
clump.cfd.extra(CLCF_PNT<,INT>) Get/set the CFD clump extra variable.
clump.cfd.force(CLCF_PNT<,INT>) Get/set the CFD clump force.
clump.cfd.group(CLCF_PNT<,INT>) Get/set CFD clump groups.
clump.cfd.group.remove(CLCF_PNT,STR) Remove CFD clump groups.
clump.cfd.id(CLCF_PNT) Get the CFD clump ID.
clump.cfd.isgroup(CLCF_PNT,STR<,STR>) Query the existence of a group.
clump.cfd.pebblelist(CLCF_PNT) Get the CFD pebbles of a CCFD clump.
clump.cfd.pos(CLCF_PNT<,INT>) Get the CFD clump position.

CFD Clump Pebble Utilities

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

CFD Clump Pebble Intrinsics

clump.cfd.pebble.clump(CLPCF_PNT) Get the CFD pebble’s CFD clump.
clump.cfd.pebble.group(CLPCF_PNT<,STR>) Get/set CFD pebble groups.
clump.cfd.pebble.group.remove(CLPCF_PNT,STR) Remove CFD pebble groups.
clump.cfd.pebble.id(CLPCF_PNT) Get/set the CFD pebble ID.
clump.cfd.pebble.isgroup(CLPCF_PNT,STR<,STR>) Query the existence of a group.
clump.cfd.pebble.pebble(CLPCF_PNT) Get the host mechanical pebble.