FISH Functions

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

Rigid Block Utilities

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

Rigid Block Intrinsics

rblock.aspect.ratio(RB_PNT) Get the rigid block aspect ratio.
rblock.ball.pos(RB_PNT<,INT>) Get the rigid block ball position.
rblock.ball.radius(RB_PNT) Get the rigid block ball radius.
rblock.collide(RB_PNT,RB_PNT) Get the intersection status of two rigid blocks.
rblock.contactmap(RB_PNT<,INT,PNT>) Get active contacts around a rblock.
rblock.contactmap.all(RB_PNT<,INT,PNT>) Get all contacts around a rigid block.
rblock.contactnum(RB_PNT<,INT>) Get number of active contacts around a rblock.
rblock.contactnum.all(RB_PNT<,INT>) Get number of contacts around a rblock.
rblock.damp(RB_PNT) Get/set rigid block local damping factor.
rblock.delete(RB_PNT) Delete a rigid block.
rblock.density(RB_PNT) Get/set rigid block density.
rblock.disp(RB_PNT<,INT>) Get/set the rigid block displacement.
rblock.euler(RB_PNT<,INT>)(3D ONLY) Get/set the rigid block orientation.
rblock.extra(RB_PNT<,INT>) Get/set rigid block extra variable.
rblock.facet.area(RB_PNT,INT) Get the rigid block facet area.
rblock.facet.centroid(RB_PNT,INT<,INT>) Get the facet centroid.
rblock.facet.closest(RB_PNT,INT,VEC<,INT>) Get the closest point on a facet.
rblock.facet.map(RB_PNT) Get the facet map.
rblock.facet.normal(RB_PNT,INT<,INT>) Get the facet normal.
rblock.facet.num(RB_PNT) Get the facet count.
rblock.facet.vertex.pos(RB_PNT,INT,INT<,INT>) Get the facet vertex position.
rblock.fix(RB_PNT,INT) Get/set rigid block fixity condition.
rblock.force.app(RB_PNT<,INT>) Get/set the rigid block applied force.
rblock.force.contact(RB_PNT<,INT>) Get/set the rigid block contact force.
rblock.force.unbal(RB_PNT<,INT>) Get the rigid block unbalanced force.
rblock.fragment(RB_PNT) Get/set rigid block fragment ID.
rblock.group(RB_PNT<,STR>) Get/set rigid block groups.
rblock.group.remove(RB_PNT,STR) Remove rigid block groups.
rblock.id(RB_PNT) Get the rigid block ID.
rblock.inglobal(RB_PNT,VEC) Rotate a vector from principal system.
rblock.inprin(RB_PNT,VEC) Rotate a vector to principal system.
rblock.isbonded(RB_PNT<,INT,PNT>) Get the rigid block bonded state.
rblock.isgroup(RB_PNT,STR<,STR>) Query the existence of a group.
rblock.isprop(RB_PNT,STR) Query the existence of a property.
rblock.mass(RB_PNT) Get the inertial rigid block mass.
rblock.mass.real(RB_PNT) Get the real (gravitational) rigid block mass.
rblock.moi(RB_PNT<,INT<,INT>>) Get the rigid block moment of inertia.
rblock.moi.fix(RB_PNT) Get/set the moment of inertia fixity state.
rblock.moi.prin(RB_PNT<,INT>) Get the rigid block principal moment of inertia.
rblock.moi.prin.real(RB_PNT<,INT>) Get/set the rigid block real principal moment of inertia.
rblock.moi.real(RB_PNT<,INT<,INT>>) Get/set the rigid block real moment of inertia.
rblock.moment.app(RB_PNT<,INT>) Get/set the rigid block applied moment.
rblock.moment.contact(RB_PNT<,INT>) Get/set the rigid block contact moment.
rblock.moment.unbal(RB_PNT<,INT>) Get the rigid block unbalanced moment.
rblock.pos(RB_PNT<,INT>) Get/set the rigid block position.
rblock.prop(RB_PNT,STR) Get/set a rigid block property.
rblock.rotation(RB_PNT)(2D ONLY) Get/set the rigid block orientation.
rblock.rounding(RB_PNT) Get the rigid block rounding.
rblock.scalesphere(RB_PNT,FLT) Scale the rigid block to an equivalent sphere.
rblock.scalevol(RB_PNT,FLT) Scale the rigid block.
rblock.spin(RB_PNT<,INT>) Get/set the rigid block angular velocity.
rblock.stress(RB_PNT<,INT,INT>) Get the stress tensor arising from all contacts acting on...
rblock.vel(RB_PNT<,INT>) Get/set the rigid block velocity.
rblock.vertex.map(RB_PNT) Get the vertex map.
rblock.vertex.num(RB_PNT) Get the vertex count.
rblock.vertex.pos(RB_PNT,INT) Get the vertex position.
rblock.vol(RB_PNT) Get/set the rigid block volume.

Rigid Block Template Utilities

rblock.template.find(INT) Find a rigid block template.
rblock.template.list Get the global rigid block template list.
rblock.template.maxid Get the maximum rigid block template ID.
rblock.template.num Get the number of rigid block templates.
rblock.template.typeid Get the rigid block template type number.

Rigid Block Template Intrinsics

rblock.template.delete(RBT_PNT) Delete a rigid block template.
rblock.template.moi(RBT_PNT<,INT<,INT>>) Get the rigid block template moment of inertia.
rblock.template.moi.prin(RBT_PNT<,INT>) Get the rigid block template principal moment of inertia.
rblock.template.name(RBT_PNT) Get the rigid block template name.
rblock.template.vol(RBT_PNT) Get/set the rigid block template volume.