FLAC3D FISH Index

Below is a listing of the FISH functions that are specific to FLAC3D.

Zone FISH Functions

zone.aspect(ZONE_PNT)	Get the measure of a zone’s aspect ratio.
zone.bad(ZONE_PNT)(2D ONLY)	Get the zone status based on the extruder criteria.
zone.code(ZONE_PNT)	Get the zone code.
zone.condition(ZONE_PNT<,INT>)	Get the zone condition number.
zone.containing(VEC+<,ZONE_PNT>)	Get the zone that encompasses the point v .
zone.copy(ZONE_PNT,ZONE_PNT)	Copies the zone state information from the source zone to...
zone.create.interface.elem(ZONE_PNT,INT,STR)	create new interface elements attached to a zone face.
zone.create.ratio(FLT,INT,INT)	Get a value calculated by a geometric progression, given a...
zone.creep.time.total	Get/set the total accumulated zone module creep time.
zone.creep.timestep	Get/set the timestep used by the zone creep module when...
zone.cycle.init(ZONE_PNT)	Initialize the zone for cycling.
zone.density(ZONE_PNT)	Get/set the density of the zone.
zone.dynamic.mul(ZONE_PNT)	Get the multiple calculated for that zone when dynamic multistepping...
zone.dynamic.time.total(ZONE_PNT)	Get/set the total accumulated zone module dynamic time.
zone.dynamic.timestep	Get/set the timestep used by the zone dynamic module when...
zone.extra(ZONE_PNT<,INT>)	Get/sets the value stored in the i th extra variable array...
zone.find(INT)	Get the zone with internally assigned ID number i .
zone.flow(ZONE_PNT<,INT>)	Get the specific discharge vector for the zone.
zone.fluid.density(ZONE_PNT)	Get/set the fluid density for the zone.
zone.fluid.model(ZONE_PNT)	Get/set the fluid flow constitituve model for the zone.
zone.fluid.prop(ZONE_PNT,STR)	Get/set the value for fluid property s in zone z .
zone.fluid.ratio	Get the current fluid convergence ratio for zones.
zone.fluid.stress.normal	Get the representative stress magnitude for the fast flow solution...
zone.fluid.time.total	Get/set the total accumulated zone module fluid time.
zone.fluid.timestep	Get/set the current fluid timestep.
zone.fluid.unbal.avg	Get the average unbalanced fluid volume limit for the fast...
zone.fluid.unbal.max	Get the maximum unbalanced fluid limit for the fast flow...
zone.flux(ZONE_PNT<,INT>)	Get the zone average heat flux vector.
zone.force.update	Flags the cycling logic so that a geometry update is...
zone.geom.test(ZONE_PNT)	Test the geometric fitness of a zone.
zone.gp(ZONE_PNT,INT)	Get the gridpoint associated with the zone at index i .
zone.gp.num(ZONE_PNT)	Get the number of unique gridpoints associated with this type...
zone.group(ZONE_PNT<,STR>)	Get/set the group name assigned to zone z in slot...
zone.group.remove(ZONE_PNT,STR)	Remove the group s from zone z , in all slots...
zone.head	Get the first zone in the list of all zones...
zone.hysteretic(ZONE_PNT,STR)	Get/set the hysteretic damping parameter s in zone z .
zone.id(ZONE_PNT)	Get the zone ID number, a unique number assigned by...
zone.inbox(VEC,VEC<,BOOL>)	Get zones with extents intersecting a box.
zone.isgroup(ZONE_PNT,STR<,STR>)	Check if the group s is associated with the zone.
zone.islive(ZONE_PNT)	Checks if the zone is “live”, meaning it has a...
zone.join(ZONE_PNT,INT)	Get the zone joined to face i of zone z .
zone.link.index(ZONE_PNT,INT)	Get the index of the next zone in the list...
zone.link.zone(ZONE_PNT,INT)	Get the next zone in the list of all zones...
zone.list	Get the list of all zones in the model.
zone.maxid	Get the maximum ID number assigned to any zone in...
zone.mech.convergence	Get the current maximum value of convergence in any gridpoint...
zone.mech.prop.name(ZONE_PNT,INT)	Get the name of the i th property in the list...
zone.mech.prop.num(ZONE_PNT)	Get the total number of properties accepted by the mechanical...
zone.mech.ratio	Get the current zone mechanical convergence ratio.
zone.mech.ratio.avg	Get the current zone mechanical average convergence ratio.
zone.mech.ratio.local	Get the current zone mechanical local convergence ratio.
zone.mech.ratio.max	Get the current zone mechanical maximum convergence ratio.
zone.mech.unbal.max	Get the zone maximum unbalanced force.
zone.model(ZONE_PNT)	Get/set the name of the current zone mechanical constitutive model.
zone.model.init(ZONE_PNT)	Initializes all constitutive models (mechanical, fluid, and thermal) assigned to...
zone.near(VEC+)	Get the zone with the centroid nearest v .
zone.near.all(VEC+)	Get the zone with the centroid nearest v .
zone.near.live(VEC+,BOOL,BOOL,BOOL,STR)	Get the zone with a centroid nearest point v .
zone.near.map(VEC+,FLT)	Finds all zones with centroids within f distance of position...
zone.next(ZONE_PNT)	Get the next zone after z in the list of...
zone.num	Get the total number of zones in the model.
zone.ortho	Get a measure of orthogonality for the zone.
zone.overlays(ZONE_PNT)	Get the number of overlays available in the zone.
zone.planarity(ZONE_PNT)	Get a measure of how planar the quadrilateral faces of...
zone.plane.traction(ZONE_PNT,VEC<,ARR_PNT>)	Get the traction on the zone in the place normal...
zone.pos(ZONE_PNT<,INT>)	Get the zone centroid position.
zone.pp(ZONE_PNT)	Get/set the average zone pore pressure.
zone.prop(ZONE_PNT,STR)	Get/set the value of property s in the zone.
zone.rotation.inc(ZONE_PNT<,INT<,INT>>)	Get the zone rotational increment tensor, or a component of...
zone.rotation.rate(ZONE_PNT<,INT<,INT>>)	Get the zone rotation rate tensor or component.
zone.state(ZONE_PNT)	Get/set the current plasticity state indicators for the zone.
zone.state.restore(ZONE_PNT)	Restores all zone state information from the currently open FISH ...
zone.state.save(ZONE_PNT)	Saves all zone state information to the currently open FISH ...
zone.strain.inc(ZONE_PNT<,INT<,INT>>)	Get the zone strain increment, based on the current displacement...
zone.strain.rate(ZONE_PNT,INT<,INT>)	Get the zone strain rate, based on the current velocity...
zone.strain.shear.inc(ZONE_PNT)	Get the zone shear strain increment based on the current...
zone.strain.shear.rate(ZONE_PNT)	Get the zone shear strain rate based on the current...
zone.strain.vol.inc(ZONE_PNT)	Get the zone volumetric strain increment based on the current...
zone.strain.vol.rate	Get the zone volumetric strain rate based on the current...
zone.stress(ZONE_PNT<,INT<,INT>>)	Get/set the zone stress.
zone.stress.effective(ZONE_PNT,INT<,INT>)	Get the zone effective stress.
zone.stress.int(ZONE_PNT)	Get the intermediate principal stress of the volume-weighted average of...
zone.stress.max(ZONE_PNT)	Get the maximum (most positive) principal value of the volume-averaged...
zone.stress.min(ZONE_PNT)	Get the minimum (most negative) principal value of the volume-averaged...
zone.stress.prin(ZONE_PNT<,INT>)	Get the zone principal stress, calculated from the volume-weighted average...
zone.stress.prin.dir(ZONE_PNT,ARR_PNT,ARR_PNT)	Get the zone principal stress directions, calculated from the volume-averaged...
zone.temp(ZONE_PNT)	Get/set the zone temperature.
zone.test.quality(ZONE_PNT,INT)	Get a measure of the zone quality, or how the...
zone.thermal.model(ZONE_PNT)	Get/set the thermal flow constitutive model for the zone.
zone.thermal.prop(ZONE_PNT,STR)	Get/set the value for thermal property s in zone z .
zone.thermal.ratio	Get the current thermal convergence ratio for zones.
zone.thermal.time.total	Get/set the total accumulated zone module thermal time.
zone.thermal.timestep	Get/set the current thermal timestep.
zone.typeid	Get an identifier that uniquely determines the type of object.
zone.unbal	Get the current maximum unbalanced force on any gridpoint in...
zone.vol(ZONE_PNT)	Get the zone volume calculated using the current position of...
zone.vol.deformed(ZONE_PNT)	Get the volume of a zone using gridpoint positions that...
zone.was.updated	Returns TRUE if the last validation check actually performed a...
zone.work.elastic.shear(ZONE_PNT)	Get the shear elastic work.
zone.work.elastic.total(ZONE_PNT)	Get the total elastic work.
zone.work.elastic.vol(ZONE_PNT)	Get the volumetric elastic work.
zone.work.plastic.shear(ZONE_PNT)	Get the shear plastic work dissipated.
zone.work.plastic.total(ZONE_PNT)	Get the total plastic work dissipated.
zone.work.plastic.vol(ZONE_PNT)	Get the volumetric plastic work dissipated.

Extrude FISH Functions

Extrude Block functions

extrude.block.area(EXT_BLOCK_PNT)	Get the area of a block.
extrude.block.block(EXT_BLOCK_PNT,INT)	Get a block neighbor.
extrude.block.center(EXT_BLOCK_PNT)	Get the center point of a block.
extrude.block.check(EXT_BLOCK_PNT)	Get the validity of a block.
extrude.block.countzones(EXT_BLOCK_PNT)	Get the total number of zones in the block.
extrude.block.edge(EXT_BLOCK_PNT,INT)	Get a pointer to a block edge.
extrude.block.extra(EXT_BLOCK_PNT<,INT>)	Get/sets the value stored in the i th extra variable array...
extrude.block.find(EXT_SET_PNT,INT)	Get the block with ID i .
extrude.block.flip(EXT_BLOCK_PNT,INT)	Get the “flipped” state of a block edge.
extrude.block.grid.pos(EXT_BLOCK_PNT,INT,INT)	The function only applies to regular (3- or 4-sided) blocks...
extrude.block.group(EXT_BLOCK_PNT<,STR>)	Get/set the group name assigned to block bp in slot...
extrude.block.group.remove(EXT_BLOCK_PNT,STR/GROUP_PNT)	Remove the group s from block bp in all slots...
extrude.block.id(EXT_BLOCK_PNT)	Get the block ID number, a unique number assigned by...
extrude.block.irregular.typeid	Get an identifier that uniquely determines the type of the...
extrude.block.isgroup(EXT_BLOCK_PNT,STR/GROUP_PNT<,STR/IND>)	Check if the group s is associated with the block.
extrude.block.list(EXT_SET_PNT)	Get a pointer to the container of all blocks in...
extrude.block.maxid(EXT_SET_PNT)	Get the maximum ID number assigned to any block in...
extrude.block.multiplier(EXT_BLOCK_PNT)	The function only applies to regular (3- or 4-sided) blocks...
extrude.block.next.block(EXT_BLOCK_PNT,INT)	Get the next block connected to an edge with local...
extrude.block.next.index(EXT_BLOCK_PNT,INT)	Get local index ir of an edge within the next...
extrude.block.nodes(EXT_SET_PNT,EXT_BLOCK_PNT,INT)	Get the list of 2D vectors wich correspond to the...
extrude.block.num(EXT_SET_PNT)	Get the total number of blocks in the set sp .
extrude.block.param.pos(EXT_BLOCK_PNT,FLT,FLT)	The function only applies to regular (3- or 4-sided) blocks...
extrude.block.point(EXT_BLOCK_PNT,INT)	Get a point (vertex) of a block.
extrude.block.regular.typeid	Get an identifier that uniquely determines the type of the...
extrude.block.size(EXT_BLOCK_PNT)	Get the number of edges of a block (including internal...
extrude.block.typeid	Get an identifier that uniquely determines the type of object.
extrude.block.zones.i(EXT_BLOCK_PNT)	Get number of zones along the local x edge.
extrude.block.zones.j(EXT_BLOCK_PNT)	Get number of zones along the local y edge.

Extrude Edge functions

extrude.edge.blocked(EXT_EDGE_PNT)	Get block attachment state of an edge.
extrude.edge.center(EXT_EDGE_PNT)	Get the position (2D vector) of an edge midpoint.
extrude.edge.curve(EXT_EDGE_PNT)	Get edge curvature state.
extrude.edge.direction(EXT_EDGE_PNT)	Get the direction of an edge.
extrude.edge.grid.ratio(EXT_EDGE_PNT)	Get/set the ratio setting of an edge.
extrude.edge.grid.ratio.isolate(EXT_EDGE_PNT)	Get/set the ratio-isolate flag.
extrude.edge.grid.size(EXT_EDGE_PNT)	Get/set the zone grid size along an edge.
extrude.edge.gridpos(EXT_EDGE_PNT,INT)	Get the position of a grid point.
extrude.edge.length(EXT_EDGE_PNT)	Get the length of an edge.
extrude.edge.next.edge(EXT_EDGE_PNT,INT)	Get the next edge on the edge list.
extrude.edge.next.index(EXT_EDGE_PNT,INT)	Get the index of the next edge on the edge...
extrude.edge.parampos(EXT_EDGE_PNT,FLT)	Get the position of parameterized location v .
extrude.edge.point(EXT_EDGE_PNT,INT)	Get a point of an edge.
extrude.edge.poly.add(EXT_EDGE_PNT,VEC)	Add a control point.
extrude.edge.poly.localu(EXT_EDGE_PNT,INT)	Get/set the local parametric f coordinate of an edge control...
extrude.edge.poly.localv(EXT_EDGE_PNT,INT)	Get/set the local parametric f coordinate of an edge control...
extrude.edge.poly.point(EXT_EDGE_PNT,INT)	Get/set the position of a control point on an edge.
extrude.edge.poly.remove(EXT_EDGE_PNT,INT)	Remove a control point from an edge.
extrude.edge.poly.size(EXT_EDGE_PNT)	Get the number of the control points on an edge.
extrude.edge.simple(EXT_EDGE_PNT)	Get the control point usage of an edge.
extrude.edge.start.block(EXT_EDGE_PNT)	Get the first block on the list of blocks attached...
extrude.edge.start.index(EXT_EDGE_PNT)	Get the index of the first block on the list...
extrude.edge.type(EXT_EDGE_PNT)	Get/set the edge type.

Extrude Point functions

extrude.point.blocks(EXT_POINT_PNT)	Get the list of all blocks connected to the point...
extrude.point.edges(EXT_POINT_PNT)	Get the list of all edges connected to the point...
extrude.point.extra(EXT_POINT_PNT<,INT>)	Get/sets the value stored in the i th extra variable array...
extrude.point.find(EXT_SET_PNT,INT)	Get the point with ID i .
extrude.point.group(EXT_POINT_PNT<,STR>)	Get/set the group name assigned to point p in slot...
extrude.point.group.remove(EXT_POINT_PNT,STR/GROUP_PNT)	Remove the group s from point p in all slots...
extrude.point.id(EXT_POINT_PNT)	Get the point ID number, a unique number assigned by...
extrude.point.isgroup(EXT_POINT_PNT,STR/GROUP_PNT<,STR/IND>)	Check if the group s is associated with the point.
extrude.point.list(EXT_SET_PNT)	Get a pointer to the container of all points in...
extrude.point.maxid(EXT_SET_PNT)	Get the maximum ID number assigned to any point in...
extrude.point.num(EXT_SET_PNT)	Get the total number of points in the set sp .
extrude.point.pos(EXT_POINT_PNT)	Get/set the position of a point.
extrude.point.start.edge(EXT_POINT_PNT)	Get the first edge on the list of edges connected...
extrude.point.typeid	Get an identifier that uniquely determines the type of object.

Extrude Segment functions

extrude.segment.count(EXT_SET_PNT)	Get the number segments in the extrude set.
extrude.segment.grid.ratio(EXT_SET_PNT,INT)	Get/set ratio setting for the segment grid.
extrude.segment.grid.size(EXT_SET_PNT,INT)	Get/set the number of zones along a segment.
extrude.segment.group(EXT_SET_PNT,INT<,STR>)	Get the group name of a segment.
extrude.segment.isgroup(EXT_SET_PNT,INT,STR<,STR>)	Get segment node’s group status.
extrude.segment.length(EXT_SET_PNT,INT)	Get/set the length of a segment.
extrude.segment.node.add(EXT_SET_PNT,FLT)	Add a segment node by position.
extrude.segment.node.delete(EXT_SET_PNT,INT)	Delete a segment (node).
extrude.segment.node.group(EXT_SET_PNT,INT<,STR>)	Get/set segment node group.
extrude.segment.node.isgroup(EXT_SET_PNT,INT,STR)	Remove a segment node group assignment.
extrude.segment.node.pos(EXT_SET_PNT,INT)	Get segment node position.
extrude.segment.node.removegroup(EXT_SET_PNT,INT,STR)	Remove a segment node group assignment.
extrude.segment.removegroup(EXT_SET_PNT,INT,STR)	Remove a segment group assignment.

Extrude Set functions

extrude.set.axis.n(EXT_SET_PNT)	Get/set the normal axis.
extrude.set.axis.u(EXT_SET_PNT)	Get/set the u -axis.
extrude.set.axis.v(EXT_SET_PNT)	Get/set the v -axis.
extrude.set.badzones(EXT_SET_PNT)	Return whether or not any regions have bad geometries based...
extrude.set.block.delete(EXT_SET_PNT,EXT_BLOCK_PNT)	Delete a block.
extrude.set.block.find(EXT_SET_PNT,INT)	Get a block by ID.
extrude.set.block.list(EXT_SET_PNT)	Get a block list pointer.
extrude.set.block.near(EXT_SET_PNT,VEC<,FLT>)	Get the block nearest to a position.
extrude.set.block.size(EXT_SET_PNT)	Get the number of blocks in the extrude set.
extrude.set.create(STR)	Create an extrude set.
extrude.set.delete(EXT_SET_PNT)	Delete an extrude set.
extrude.set.edge.create(EXT_SET_PNT,INT,INT)	Create an edge from two points.
extrude.set.edge.delete(EXT_SET_PNT,EXT_EDGE_PNT)	Delete an edge.
extrude.set.edge.find(EXT_SET_PNT,INT)	Get an edge by ID.
extrude.set.edge.list(EXT_SET_PNT)	Get a list of edges.
extrude.set.edge.near(EXT_SET_PNT,VEC<,FLT>)	Get the edge nearest a position.
extrude.set.edge.size(EXT_SET_PNT)	Get number of edges in the extrude set.
extrude.set.find	Get an extrude set by name or ID.
extrude.set.id(EXT_SET_PNT)	Get the ID of an extrude set.
extrude.set.list	Get a list of extrude sets.
extrude.set.metadata.find(EXT_SET_PNT,STR)	Get a metadata value from a metadata key.
extrude.set.metadata.key(EXT_SET_PNT,INT)	Get a metadata key from a metadata vector index.
extrude.set.metadata.size(EXT_SET_PNT)	Get the number of MetaData objects in the Metadata vector.
extrude.set.metadata.value(EXT_SET_PNT,STR)	Get a metadata value from a metadata key.
extrude.set.name(EXT_SET_PNT)	Get the name of an extrude set.
extrude.set.origin(EXT_SET_PNT)	Get/set the origin of the extrusion transformation.
extrude.set.point.create(EXT_SET_PNT,VEC)	Create a point at a position.
extrude.set.point.delete(EXT_SET_PNT,EXT_POINT_PNT)	Delete a point.
extrude.set.point.find(EXT_SET_PNT,INT)	Get a point by ID.
extrude.set.point.list(EXT_SET_PNT)	Get a list of points.
extrude.set.point.near(EXT_SET_PNT,V2<,FLT>)	Get the edge nearest a position.
extrude.set.point.size(EXT_SET_PNT)	Get number of points in the extrude set.
extrude.set.region.element.num(EXT_SET_PNT,INT)	Get the number of elements in a region.
extrude.set.region.map(EXT_SET_PNT)	Get the positions of all nodes in all blocks present...
extrude.set.region.nodes(EXT_SET_PNT,INT,INT)	Get the list of 2D vectors wich correspond to the...
extrude.set.set.un(EXT_SET_PNT,VEC,VEC)	Sets both the u -axis and n -axis (normal axis).
extrude.set.set.uv(EXT_SET_PNT,VEC,VEC)	Sets both the u -axis and v -axis.
extrude.set.set.vn(EXT_SET_PNT,VEC,VEC)	Sets both the v -axis and n -axis (normal axis).
extrude.set.zone.auto(EXT_SET_PNT)	Get/set the flag that controls auto-zoning.
extrude.set.zone.count2(EXT_SET_PNT)	Get the number of 2D zones in the plane.
extrude.set.zone.count3(EXT_SET_PNT)	Get the total number of zones.
extrude.set.zone.target.autodir(EXT_SET_PNT)	Get/set the flag for auto-zoning direction.
extrude.set.zone.target.edge(EXT_SET_PNT)	Get/set the auto-zoning edge length.
extrude.set.zone.target.size(EXT_SET_PNT)	Get/set the autozoning size (number of zones).
extrude.set.zone.target.total(EXT_SET_PNT)	Get/set the auto-zoning total (number of zones).