FISH Functions
The type specifiers used in the FISH function signatures are given in the “FISH Type Index” section.
- Wall Utilities
- Wall Intrinsics
- Wall Facet Utilities
- Wall Facet Intrinsics
- Wall Vertex Utilities
- Wall Vertex Intrinsics
Wall Utilities
| wall.energy(STR) | Get the wall total energy contribution. |
| wall.find(INT) | Find a wall. |
| wall.groupmap(STR<,INT>) | Get walls that belong to a group. |
| wall.inbox(VEC,VEC<,BOOL>) | Get walls with extents intersecting a box. |
| wall.list | Get the global wall list. |
| wall.maxid | Get the maximum wall ID. |
| wall.near(VEC<,FLT>) | Find the closest wall to a point. |
| wall.num | Get the number of walls. |
| wall.typeid | Get the wall type number. |
Wall Intrinsics
| wall.addfacet(W_PNT,VEC,ANY) | Add a facet. |
| wall.closed(W_PNT) | Get the wall closure status. |
| wall.contactmap(W_PNT<,INT><,PNT>) | Get active contacts around a wall. |
| wall.contactmap.all(W_PNT<,INT><,PNT>) | Get all contacts around a wall. |
| wall.contactnum(W_PNT<,INT>) | Get number of active contacts around a wall. |
| wall.contactnum.all(W_PNT<,INT>) | Get number of contacts around a wall. |
| wall.convex(W_PNT) | Get the convexity status. |
| wall.cutoff(W_PNT) | Get/set the cutoff angle. |
| wall.delete(W_PNT) | Delete a wall. |
| wall.disp(W_PNT<,INT>) | Get/set the wall displacement. |
| wall.euler(W_PNT<,INT>)(3D ONLY) | Get/set the wall orientation. |
| wall.extra(W_PNT<,INT>) | Get/set wall extra variable. |
| wall.facetlist(W_PNT) | Get the facets of a wall. |
| wall.force.contact(W_PNT<,INT>) | Get the sum of all contact forces acting on a... |
| wall.fragment(W_PNT) | Get/set wall fragment ID. |
| wall.group(W_PNT<,STR>) | Get/set wall groups. |
| wall.group.remove(W_PNT,STR) | Remove wall groups. |
| wall.id(W_PNT) | Get the wall ID. |
| wall.inside(W_PNT,VEC) | Test whether a point is inside a wall. |
| wall.isbonded(W_PNT<,INT,PNT>) | Get the wall bonded state. |
| wall.isgroup(W_PNT,STR<,STR>) | Query the existence of a group. |
| wall.moment.contact(W_PNT<,INT>) | Get the wall contact moment. |
| wall.name(W_PNT) | Get the wall name. |
| wall.pos(W_PNT<,INT>) | Get/set the wall position. |
| wall.prop(W_PNT,STR) | Set a property of all facets. |
| wall.rotation(W_PNT)(2D ONLY) | Get/set the wall orientation. |
| wall.rotation.center(W_PNT<,INT>) | Get/set the wall center of rotation. |
| wall.spin(W_PNT<,INT>) | Get/set the wall angular velocity. |
| wall.vel(W_PNT<,INT>) | Get/set the wall velocity. |
| wall.vertexlist(W_PNT) | Get the vertices of a wall. |
Wall Facet Utilities
| wall.facet.find(INT) | Find a facet. |
| wall.facet.groupmap(STR<,INT>) | Get facets that belong to a group. |
| wall.facet.inbox(VEC,VEC<,BOOL>) | Get facets with extents intersecting a box. |
| wall.facet.list | Get the global facet list. |
| wall.facet.maxid | Get the maximum facet ID. |
| wall.facet.near(VEC<,W_PNT,FLT>) | Find the closest facet to a point. |
| wall.facet.num | Get the number of facets. |
| wall.facet.typeid | Get the facet type number. |
Wall Facet Intrinsics
Wall Vertex Utilities
| wall.vertex.find(INT) | Find a vertex. |
| wall.vertex.inbox(VEC,VEC) | Get wall vertices in a box. |
| wall.vertex.list | Get the global vertex list. |
| wall.vertex.maxid | Get the maximum vertex ID. |
| wall.vertex.near(VEC<,FLT>) | Find the closest vertex to a point. |
| wall.vertex.num | Get the number of wall vertices. |
| wall.vertex.typeid | Get the vertex type number. |
Wall Vertex Intrinsics
| wall.vertex.delete(WV_PNT) | Delete the vertex. |
| wall.vertex.facetarray(WV_PNT) | Get the array of facets sharing a vertex. |
| wall.vertex.id(WV_PNT) | Get the vertex ID. |
| wall.vertex.pos(WV_PNT<,INT>) | Get/set the vertex position. |
| wall.vertex.vel(WV_PNT<,INT>) | Get/set the vertex velocity. |
| Was this helpful? ... | PFC © 2019, Itasca | Updated: Apr 26, 2019 |