FISH Functions
The type specifiers used in the FISH function signatures are given in the “FISH Type Index” section.
- Clump Utilities
- Clump Intrinsics
- Clump Template Utilities
- Clump Template Intrinsics
- Clump Pebble Utilities
- Clump Pebble Intrinsics
Clump Utilities
| clump.energy(STR) | Get the clump total energy contribution. |
| clump.find(INT) | Find a clump. |
| clump.groupmap(STR<,INT>) | Get clumps that belong to a group. |
| clump.inbox(VEC,VEC<,BOOL>) | Get clumps with extents intersecting a box. |
| clump.list | Get the global clump list. |
| clump.maxid | Get the maximum clump ID. |
| clump.mech.ratio.avg | Get the clump average unbalanced force ratio. |
| clump.mech.ratio.local | Get the clump maximum local unbalanced force ratio. |
| clump.mech.ratio.max | Get the clump maximum unbalanced force ratio. |
| clump.mech.unbal.max | Get the clump maximum unbalanced force. |
| clump.near(VEC<,FLT>) | Find the closest clump to a point. |
| clump.num | Get the number of clumps. |
| clump.typeid | Get the clump type number. |
Clump Intrinsics
| clump.addpebble(CL_PNT,FLT,VEC<,INT>) | Add a pebble to a clump. |
| clump.calculate(CL_PNT<,FLT>) | Calculate the inertial properties. |
| clump.contactmap(CL_PNT<,INT><,PNT>) | Get active contacts around a clump. |
| clump.contactmap.all(CL_PNT<,INT><,PNT>) | Get all contacts around a clump. |
| clump.contactnum(CL_PNT<,INT>) | Get number of active contacts around a clump. |
| clump.contactnum.all(CL_PNT<,INT>) | Get number of contacts around a clump. |
| clump.damp(CL_PNT) | Get/set the clump local damping factor. |
| clump.delete(CL_PNT) | Delete a clump. |
| clump.deletepebble(CL_PNT,CLP_PNT) | Delete a pebble from a clump. |
| clump.density(CL_PNT) | Get/set the clump density. |
| clump.disp(CL_PNT<,INT>) | Get/set the clump displacement. |
| clump.euler(CL_PNT<,INT>)(3D ONLY) | Get/set the clump orientation. |
| clump.extra(CL_PNT<,INT>) | Get/set a clump extra variable. |
| clump.fix(CL_PNT,INT) | in 3D: 1) x -velocity, 2) y -velocity, 3) z -velocity, 4) x -angular... |
| clump.force.app(CL_PNT<,INT>) | Get/set the clump applied force. |
| clump.force.contact(CL_PNT<,INT>) | Get/set the clump contact force. |
| clump.force.unbal(CL_PNT<,INT>) | Get the clump unbalanced force. |
| clump.fragment(CL_PNT) | Get/set clump fragment ID. |
| clump.group(CL_PNT<,STR>) | Get/set clump groups. |
| clump.group.remove(CL_PNT,STR) | Remove clump groups. |
| clump.id(CL_PNT) | Get the clump ID. |
| clump.inglobal(CL_PNT,VEC) | Rotate a vector from principal system. |
| clump.inprin(CL_PNT,VEC) | Rotate a vector to principal system. |
| clump.isbonded(CL_PNT<,INT,PNT>) | Get the clump bonded state. |
| clump.isgroup(CL_PNT,STR<,STR>) | Query the existence of a group. |
| clump.mass(CL_PNT) | Get the inertial clump mass. |
| clump.mass.real(CL_PNT) | Get the real (gravitational) clump mass. |
| clump.moi(CL_PNT<,INT<,INT>>) | Get the clump moment of inertia. |
| clump.moi.fix(CL_PNT) | Get/set the moment of inertia fixity state. |
| clump.moi.prin(CL_PNT<,INT>) | Get the clump principal moment of inertia. |
| clump.moi.prin.real(CL_PNT<,INT>) | Get/set the clump real principal moment of inertia. |
| clump.moi.real(CL_PNT<,INT<,INT>>) | Get/set the clump real moment of inertia. |
| clump.moment.app(CL_PNT<,INT>) | Get/set the clump applied moment. |
| clump.moment.contact(CL_PNT<,INT>) | Get/set the clump contact moment. |
| clump.moment.unbal(CL_PNT<,INT>) | Get the clump unbalanced moment. |
| clump.pebblelist(CL_PNT) | Get the pebbles of a clump. |
| clump.pos(CL_PNT<,INT>) | Get/set the clump position. |
| clump.prop(CL_PNT,STR) | Set a property of all pebbles. |
| clump.rotate(CL_PNT,VEC,FLT) | Rotate a clump. |
| clump.rotation(CL_PNT)(2D ONLY) | Get/set the clump orientation. |
| clump.scalesphere(CL_PNT,FLT) | Scale the clump to an equivalent sphere. |
| clump.scalevol(CL_PNT,FLT) | Scale the clump. |
| clump.spin(CL_PNT<,INT>) | Get/set the clump angular velocity. |
| clump.template(CL_PNT) | Get template associated with a clump. |
| clump.template.euler(CL_PNT<,INT>)(3D ONLY) | Get the clump template relative orientation. |
| clump.template.scale(CL_PNT) | Get clump template relative scaling factor. |
| clump.vel(CL_PNT<,INT>) | Get/set the clump velocity. |
| clump.vol(CL_PNT) | Get/set the clump volume. |
Clump Template Utilities
| clump.template.find(STR) | Find a clump template. |
| clump.template.findpebble(INT) | Find a clump template pebble. |
| clump.template.list | Get the global clump template list. |
| clump.template.maxid | Get the maximum clump template ID. |
| clump.template.num | Get the number of clump templates. |
| clump.template.typeid | Get the clump template type number. |
Clump Template Intrinsics
| clump.template.addpebble(CLT_PNT,FLT,VEC<,INT>) | Add a pebble to a clump template. |
| clump.template.clone(CLT_PNT,STR) | Clone a clump template. |
| clump.template.delete(CLT_PNT) | Delete a clump template. |
| clump.template.deletepebble(CLT_PNT,CLP_PNT) | Delete a pebble from a clump. |
| clump.template.make(CL_PNT,STR) | Make a clump template from a clump. |
| clump.template.moi.prin(CLT_PNT<,INT>) | Get the clump template principal moment of inertia. |
| clump.template.name(CLT_PNT) | Get the clump template name. |
| clump.template.origpos(CLT_PNT<,INT>) | Get/set the clump template original position. |
| clump.template.pebblelist(CLT_PNT) | Get the pebbles of a clump template. |
| clump.template.vol(CLT_PNT) | Get/set the clump template volume. |
Clump Pebble Utilities
| clump.pebble.find(INT) | Find a pebble. |
| clump.pebble.groupmap(STR<,INT>) | Get pebbles that belong to a group. |
| clump.pebble.inbox(VEC,VEC<,BOOL>) | Get clump pebbles with extents intersecting a box. |
| clump.pebble.list | Get the global pebble list. |
| clump.pebble.maxid | Get the maximum pebble ID. |
| clump.pebble.near(VEC<,FLT>) | Find the closest pebble to a point. |
| clump.pebble.num | Get the number of clump pebbles. |
| clump.pebble.typeid | Get the pebble type number. |
Clump Pebble Intrinsics
| Was this helpful? ... | PFC © 2019, Itasca | Updated: Apr 26, 2019 |