Index: PFC FISH Functions

Below is a comprehensive listing of FISH functions that are specific to PFC.

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

c ball c clump c wall c rblock c contact

See Index: Common FISH for a listing of FISH functions associated with common commands. See FISH Functions for a listing of FISH language intrinsic functions.

Ball FISH functions

ball.contact.list(B_PNT<,INT,PNT>)

ball.contact.list.all(B_PNT<,INT,PNT>)

ball.contactmap(B_PNT<,INT,PNT>)

ball.contactmap.all(B_PNT<,INT,PNT>)

ball.contactnum(B_PNT<,INT>)

ball.contactnum.all(B_PNT<,INT>)

ball.containing(VEC)

ball.convergence(B_PNT)

ball.create(FLT,VEC<,INT>)

ball.damp(B_PNT)

ball.delete(B_PNT)

ball.density(B_PNT)

ball.disp(B_PNT)

ball.energy(STR)

ball.euler(B_PNT)(3D ONLY)

ball.extra(B_PNT<,INT>)

ball.fix(B_PNT,INT)

ball.force.app(B_PNT)

ball.force.contact(B_PNT)

ball.force.unbal(B_PNT)

ball.fragment(B_PNT)

ball.group(B_PNT<,STR/IND>)

ball.group.list(STR/IND<,STR/IND>)

ball.group.remove(B_PNT,STR/IND<,STR/IND>)

ball.groupmap(STR/IND<,STR/IND>)

ball.inbox(VEC,VEC<,BOOL>)

ball.inside(B_PNT,VEC)

ball.isbonded(B_PNT<,INT,PNT>)

ball.isgroup(B_PNT,STR/IND<,STR/IND>)

ball.isprop(B_PNT,STR)

ball.mass(B_PNT)

ball.mass.real(B_PNT)

ball.mech.convergence

ball.mech.ratio.avg

ball.mech.ratio.local

ball.mech.ratio.max

ball.mech.unbal.max

ball.moi(B_PNT)

ball.moi.real(B_PNT)

ball.moment.app(B_PNT)

ball.moment.contact(B_PNT)

ball.moment.unbal(B_PNT)

ball.near(VEC<,FLT>)

ball.pos(B_PNT)

ball.prop(B_PNT,STR)

ball.radius(B_PNT)

ball.ratio(B_PNT)

ball.ratio.target(B_PNT)

ball.rotation(B_PNT)(2D ONLY)

ball.spin(B_PNT)

ball.stress(B_PNT)

ball.stress.full(B_PNT)

ball.vel(B_PNT)

ball.vol(B_PNT)

Clump FISH functions

clump.addpebble(CL_PNT,FLT,VEC<,INT>)

clump.calculate(CL_PNT<,FLT>)

clump.contact.list(CL_PNT<,INT><,PNT>)

clump.contact.list.all(CL_PNT<,INT><,PNT>)

clump.contactmap(CL_PNT<,INT><,PNT>)

clump.contactmap.all(CL_PNT<,INT><,PNT>)

clump.contactnum(CL_PNT<,INT>)

clump.contactnum.all(CL_PNT<,INT>)

clump.containing(VEC)

clump.convergence(CL_PNT)

clump.damp(CL_PNT)

clump.delete(CL_PNT)

clump.deletepebble(CL_PNT,CLP_PNT)

clump.density(CL_PNT)

clump.disp(CL_PNT)

clump.energy(STR)

clump.euler(CL_PNT)(3D ONLY)

clump.extra(CL_PNT<,INT>)

clump.find(INT)

clump.fix(CL_PNT,INT)

clump.force.app(CL_PNT)

clump.force.contact(CL_PNT)

clump.force.unbal(CL_PNT)

clump.fragment(CL_PNT)

clump.group(CL_PNT<,STR/IND>)

clump.group.list(STR/IND<,STR/IND>)

clump.group.remove(CL_PNT,STR/IND<,STR/IND>)

clump.groupmap(STR/IND<,STR/IND>)

clump.id(CL_PNT)

clump.inbox(VEC,VEC<,BOOL>)

clump.inglobal(CL_PNT,VEC)

clump.inprin(CL_PNT,VEC)

clump.inside(CL_PNT,VEC)

clump.isbonded(CL_PNT<,INT,PNT>)

clump.isgroup(CL_PNT,STR/IND<,STR/IND>)

clump.mass(CL_PNT)

clump.mass.real(CL_PNT)

clump.mech.convergence

clump.mech.ratio.avg

clump.mech.ratio.local

clump.mech.ratio.max

clump.mech.unbal.max

clump.moi(CL_PNT)

clump.moi.fix(CL_PNT)

clump.moi.prin(CL_PNT)

clump.moi.prin.real(CL_PNT)

clump.moi.real(CL_PNT)

clump.moment.app(CL_PNT)

clump.moment.contact(CL_PNT)

clump.moment.unbal(CL_PNT)

clump.near(VEC<,FLT>)

clump.pebble.clump(CLP_PNT)

clump.pebble.contact.list(CLP_PNT<,INT><,PNT>)

clump.pebble.contact.list.all(CLP_PNT<,INT><,PNT>)

clump.pebble.contactmap(CLP_PNT<,INT><,PNT>)

clump.pebble.contactmap.all(CLP_PNT<,INT><,PNT>)

clump.pebble.contactnum(CLP_PNT<,INT>)

clump.pebble.contactnum.all(CLP_PNT<,INT>)

clump.pebble.delete(CLP_PNT)

clump.pebble.extra(CLP_PNT<,INT>)

clump.pebble.find(INT)

clump.pebble.group(CLP_PNT<,STR/IND>)

clump.pebble.group.list(STR/IND<,STR/IND>)

clump.pebble.group.remove(CLP_PNT,STR/IND<,STR/IND>)

clump.pebble.groupmap(STR/IND<,STR/IND>)

clump.pebble.id(CLP_PNT)

clump.pebble.inbox(VEC,VEC<,BOOL>)

clump.pebble.isbonded(CL_PNT<,INT,PNT>)

clump.pebble.isgroup(CLP_PNT,STR/IND<,STR/IND>)

clump.pebble.isprop(CLP_PNT,STR)

clump.pebble.list

clump.pebble.maxid

clump.pebble.near(VEC<,FLT>)

clump.pebble.num

clump.pebble.pos(CLP_PNT)

clump.pebble.prop(CLP_PNT,STR)

clump.pebble.radius(CLP_PNT)

clump.pebble.typeid

clump.pebble.vel(CLP_PNT)

clump.pebblelist(CL_PNT)

clump.pos(CL_PNT)

clump.prop(CL_PNT,STR)

clump.ratio(CL_PNT)

clump.ratio.target(CL_PNT)

clump.rotate(CL_PNT,VEC,FLT)

clump.rotation(CL_PNT)(2D ONLY)

clump.scalesphere(CL_PNT,FLT)

clump.scalevol(CL_PNT,FLT)

clump.spin(CL_PNT)

clump.stress(CL_PNT)

clump.template(CL_PNT)

clump.template.addpebble(CLT_PNT,FLT,VEC<,INT>)

clump.template.clone(CLT_PNT,STR)

clump.template.delete(CLT_PNT)

clump.template.deletepebble(CLT_PNT,CLP_PNT)

clump.template.euler(CL_PNT)(3D ONLY)

clump.template.find(STR)

clump.template.findpebble(INT)

clump.template.list

clump.template.make(CL_PNT,STR)

clump.template.maxid

clump.template.moi(CL_PNT)

clump.template.moi.prin(CL_PNT)

clump.template.name(CLT_PNT)

clump.template.num

clump.template.origpos(CL_PNT)

clump.template.pebblelist(CLT_PNT)

clump.template.scale(CL_PNT)

clump.template.typeid

clump.template.vol(CLT_PNT)

clump.vel(CL_PNT)

clump.vol(CL_PNT)

Wall FISH functions

wall.addfacet(W_PNT,VEC,ANY)

wall.closed(W_PNT)

wall.contact.list(W_PNT<,INT><,PNT>)

wall.contact.list.all(W_PNT<,INT><,PNT>)

wall.contactmap(W_PNT<,INT><,PNT>)

wall.contactmap.all(W_PNT<,INT><,PNT>)

wall.contactnum(W_PNT<,INT>)

wall.contactnum.all(W_PNT<,INT>)

wall.convex(W_PNT)

wall.cutoff(W_PNT)

wall.delete(W_PNT)

wall.disp(W_PNT)

wall.energy(STR)

wall.euler(W_PNT)(3D ONLY)

wall.extra(W_PNT<,INT>)

wall.facet.active(WF_PNT)

wall.facet.contact.list(WF_PNT<,INT><,PNT>)

wall.facet.contact.list.all(WF_PNT<,INT><,PNT>)

wall.facet.contactmap(WF_PNT<,INT><,PNT>)

wall.facet.contactmap.all(WF_PNT<,INT><,PNT>)

wall.facet.contactnum(WF_PNT<,INT>)

wall.facet.contactnum.all(WF_PNT<,INT>)

wall.facet.conveyor(WF_PNT)

wall.facet.delete(WF_PNT)

wall.facet.extra(WF_PNT<,INT>)

wall.facet.find(INT)

wall.facet.group(WF_PNT<,STR/IND>)

wall.facet.group.list(STR/IND<,STR/IND>)

wall.facet.group.remove(WF_PNT,STR/IND<,STR/IND>)

wall.facet.groupmap(STR/IND<,STR/IND>)

wall.facet.id(WF_PNT)

wall.facet.inbox(VEC,VEC<,BOOL>)

wall.facet.isbonded(WF_PNT<,INT,PNT>)

wall.facet.isgroup(WF_PNT,STR/IND<,STR/IND>)

wall.facet.isprop(WF_PNT,STR)

wall.facet.list

wall.facet.maxid

wall.facet.near(VEC<,W_PNT,FLT>)

wall.facet.normal(WF_PNT)

wall.facet.pair(WF_PNT,INT)

wall.facet.pointnear(WF_PNT,VEC)

wall.facet.pos(WF_PNT)

wall.facet.prop(WF_PNT,STR)

wall.facet.typeid

wall.facet.vertex(WF_PNT,INT)

wall.facet.wall(WF_PNT)

wall.facetlist(W_PNT)

wall.find(STR/INT)

wall.force.contact(W_PNT)

wall.fragment(W_PNT)

wall.group(W_PNT<,STR/IND>)

wall.group.list(STR/IND<,STR/IND>)

wall.group.remove(W_PNT,STR/IND<,STR/IND>)

wall.groupmap(STR/IND<,STR/IND>)

wall.inbox(VEC,VEC<,BOOL>)

wall.inside(W_PNT,VEC)

wall.isbonded(W_PNT<,INT,PNT>)

wall.isgroup(W_PNT,STR/IND<,STR/IND>)

wall.moment.contact(W_PNT)

wall.name(W_PNT)

wall.near(VEC<,FLT>)

wall.pos(W_PNT)

wall.prop(W_PNT,STR)

wall.rotation(W_PNT)(2D ONLY)

wall.rotation.center(W_PNT)

wall.spin(W_PNT)

wall.vel(W_PNT)

wall.vertex.delete(WV_PNT)

wall.vertex.facetarray(WV_PNT)

wall.vertex.find(INT)

wall.vertex.id(WV_PNT)

wall.vertex.inbox(VEC,VEC)

wall.vertex.list

wall.vertex.maxid

wall.vertex.near(VEC<,FLT>)

wall.vertex.num

wall.vertex.pos(WV_PNT)

wall.vertex.typeid

wall.vertex.vel(WV_PNT)

wall.vertexlist(W_PNT)

Rblock FISH functions

rblock.angle(RB_PNT)(2D ONLY)

rblock.aspect.ratio(RB_PNT)

rblock.axis.angle(RB_PNT)(3D ONLY)

rblock.axis.long(RB_PNT)

rblock.ball.pos(RB_PNT)

rblock.ball.radius(RB_PNT)

rblock.collide(RB_PNT,RB_PNT)

rblock.contact.list(RB_PNT<,INT,PNT>)

rblock.contact.list.all(RB_PNT<,INT,PNT>)

rblock.contactmap(RB_PNT<,INT,PNT>)

rblock.contactmap.all(RB_PNT<,INT,PNT>)

rblock.contactnum(RB_PNT<,INT>)

rblock.contactnum.all(RB_PNT<,INT>)

rblock.containing(VEC)

rblock.convergence(RB_PNT)

rblock.copy(RB_PNT)

rblock.damp(RB_PNT)

rblock.delete(RB_PNT)

rblock.density(RB_PNT)

rblock.disp(RB_PNT)

rblock.energy(STR)

rblock.euler(RB_PNT)(3D ONLY)

rblock.extra(RB_PNT<,INT>)

rblock.facet(,group)

rblock.facet.area(RB_PNT,INT)

rblock.facet.centroid(RB_PNT,INT)

rblock.facet.closest(RB_PNT,INT,VEC)

rblock.facet.group(RB_PNT,INT<,STR>)

rblock.facet.isgroup(RB_PNT,INT,STR/IND<,STR/IND>)

rblock.facet.list(RB_PNT)

rblock.facet.map(RB_PNT)

rblock.facet.normal(RB_PNT,INT)

rblock.facet.num(RB_PNT)

rblock.facet.vertex.pos(RB_PNT,INT,INT)

rblock.find(INT)

rblock.fix(RB_PNT,INT)

rblock.force.app(RB_PNT)

rblock.force.contact(RB_PNT)

rblock.force.unbal(RB_PNT)

rblock.fragment(RB_PNT)

rblock.group(RB_PNT<,STR/IND>)

rblock.group.list(STR/IND<,STR/IND>)

rblock.group.remove(RB_PNT,STR/IND<,STR/IND>)

rblock.groupmap(STR/IND<,STR/IND>)

rblock.id(RB_PNT)

rblock.inbox(VEC,VEC<,BOOL>)

rblock.inglobal(RB_PNT,VEC)

rblock.inprin(RB_PNT,VEC)

rblock.inside(RB_PNT,VEC)

rblock.isbonded(RB_PNT<,INT,PNT>)

rblock.isgroup(RB_PNT,STR/IND<,STR/IND>)

rblock.isprop(RB_PNT,STR)

rblock.length.max(RB_PNT)

rblock.length.min(RB_PNT)

rblock.mass(RB_PNT)

rblock.mass.real(RB_PNT)

rblock.mech.convergence

rblock.mech.ratio.avg

rblock.mech.ratio.local

rblock.mech.ratio.max

rblock.mech.unbal.max

rblock.moi(RB_PNT)

rblock.moi.fix(RB_PNT)

rblock.moi.prin(RB_PNT)

rblock.moi.prin.real(RB_PNT)

rblock.moi.real(RB_PNT)

rblock.moment.app(RB_PNT)

rblock.moment.contact(RB_PNT)

rblock.moment.unbal(RB_PNT)

rblock.near(VEC<,FLT>)

rblock.pos(RB_PNT)

rblock.prin.angle(RB_PNT)(2D ONLY)

rblock.prin.axis.angle(RB_PNT)(3D ONLY)

rblock.prin.euler(RB_PNT)(3D ONLY)

rblock.prop(RB_PNT,STR)

rblock.ratio(RB_PNT)

rblock.ratio.target(RB_PNT)

rblock.rotation(RB_PNT)(2D ONLY)

rblock.rounding(RB_PNT)

rblock.scalesphere(RB_PNT,FLT)

rblock.scalevol(RB_PNT,FLT)

rblock.spin(RB_PNT)

rblock.stress(RB_PNT)

rblock.template.delete(RBT_PNT)

rblock.template.find(STR)

rblock.template.list

rblock.template.maxid

rblock.template.moi(RBT_PNT)

rblock.template.moi.prin(RBT_PNT)

rblock.template.name(RBT_PNT)

rblock.template.num

rblock.template.typeid

rblock.template.vol(RBT_PNT)

rblock.unbond(RB_PNT)

rblock.vel(RB_PNT)

rblock.vertex.list(RB_PNT)

rblock.vertex.map(RB_PNT)

rblock.vertex.num(RB_PNT)

rblock.vertex.pos(RB_PNT,INT)

rblock.vol(RB_PNT)

Contact FISH functions

contact.activate(C_PNT)

contact.active(C_PNT)

contact.area(C_PNT)

contact.end1(C_PNT)

contact.end2(C_PNT)

contact.energy(C_PNT,STR)

contact.energy.sum(STR<,STR>)

contact.extra(C_PNT<,INT>)

contact.fid(C_PNT)

contact.find(STR/INT,INT<,INT>)

contact.gap(C_PNT)

contact.gps(C_PNT)

contact.group(C_PNT<,STR/IND>)

contact.group.list(STR/IND<,STR/IND,STR>)

contact.group.list.all(STR/IND<,STR/IND,STR>)

contact.group.remove(C_PNT,STR/IND<,STR/IND>)

contact.groupmap(STR/IND<,STR/IND,STR>)

contact.groupmap.all(STR/IND<,STR/IND,STR>)

contact.id(C_PNT)

contact.inherit(C_PNT,STR)

contact.inhibit(C_PNT)

contact.isbonded(C_PNT)

contact.isenergy(C_PNT,STR)

contact.isgroup(C_PNT,STR/IND<,STR/IND>)

contact.isprop(C_PNT,ANY)

contact.joint(C_PNT)

contact.list(<STR>)

contact.list.all(<STR>)

contact.method(C_PNT,STR<,ARR_PNT>)

contact.model(C_PNT)

contact.model.prop.index(STR,STR)

contact.normal(C_PNT)

contact.num(<STR>)

contact.num.all(<STR>)

contact.offset(C_PNT)

contact.otherend(C_PNT,SYM)

contact.persist(C_PNT)

contact.pos(C_PNT)

contact.prop(C_PNT,ANY)

contact.prop.index(C_PNT,STR)

contact.shear(C_PNT)

contact.typeid(STR)

contact.unbond(C_PNT)

⇄

Itasca Software 9.3 documentation »
PFC »

⇐ Index: PFC Commands | 3DEC ⇒

Was this helpful? ...

Itasca Software © 2024, Itasca

Updated: Dec 19, 2024

9.3.24