FISH Index

All FISH functions that appear in this documentation are listed here.

array.command(ARR_PNT) Run commands in an array.
array.convert(MAT_PNT/TEN_PNT) Convert a matrix or tensor to an array.
array.copy(ARR_PNT) Copy an array.
array.create(INT<,NUM>) Create an array.
array.delete(ARR_PNT) Delete an array.
array.dim(ARR_PNT) Get the array dimension.
array.size(ARR_PNT,INT) Get the size of an array dimension.
attach.create(GP_PNT,GP_PNT/ZONE_PNT<,GP_PNT/INT>) If only one gridpoint pointer is given as a parameter,...
attach.delete(ATTACH_PNT) Deletes an attachment, return value is undefined.
attach.extra(ATTACH_PNT<,INT>) Get/set the value stored in the i th extra variable array...
attach.find(INT) Get the pointer to the attach condition with ID i .
attach.group(ATTACH_PNT<,STR>) Check if the group s is associated with the attach.
attach.group.remove(ATTACH_PNT,STR) Remove the attach condition with the group name.
attach.id(ATTACH_PNT) Get the ID number of the given attach condition.
attach.list Get the list of all attaches in the model.
attach.master(ATTACH_PNT<,INT>) Get the master gridpoint pointer.
attach.master.face(ATTACH_PNT) Get the face side associated with this attach condition (from...
attach.master.zone(ATTACH_PNT) Get a pointer to the master zone for type 3...
attach.maxid Get the maximum ID number assigned to any attach condition...
attach.num Get the total number of attach conditions in the model.
attach.pos(ATTACH_PNT<,INT>) Get the attach position.
attach.slave(ATTACH_PNT) Get a pointer to the slave gridpoint.
attach.snap(ATTACH_PNT) Get/set snap option for attach.
attach.type(ATTACH_PNT) Get 1, 2, or 3, indicating that the attachment is...
attach.typeid Get an identifier that uniquely determines the type of object.
attach.weight.edge(ATTACH_PNT) Get a value in the range 0 to 1.
attach.weight.face(ATTACH_PNT) Get a vector with all components in the range 0...
ball.cfd.ball(BCF_PNT) Get the pointer to the host mechanical ball.
ball.cfd.elementmap(BCF_PNT) Get the CFD element associated with a ball.
ball.cfd.extra(BCF_PNT<,INT>) Get/set the CFD ball extra variable.
ball.cfd.find(INT) Find a CFD ball.
ball.cfd.force(BCF_PNT<,INT>) Get/set the CFD ball force.
ball.cfd.group(BCF_PNT<,INT>) Get/set CFD ball groups.
ball.cfd.group.remove(BCF_PNT,STR) Remove CFD ball groups.
ball.cfd.id(BCF_PNT) Get the CFD ball ID.
ball.cfd.inbox(VEC,VEC<,BOOL>) Get CFD balls with extents intersecting a box.
ball.cfd.isgroup(BCF_PNT,STR<,STR>) Query the existence of a group.
ball.cfd.list Get the global CFD ball list.
ball.cfd.near(VEC<,FLT>) Find the closest CFD ball to a point.
ball.cfd.num Get the number of CFD balls.
ball.cfd.pos(BCF_PNT<,INT>) Get the CFD ball position.
ball.cfd.typeid Get the CFD ball type number.
ball.contactmap(B_PNT<,INT,PNT>) Get active contacts around a ball.
ball.contactmap.all(B_PNT<,INT,PNT>) Get all contacts around a ball.
ball.contactnum(B_PNT<,INT>) Get number of active contacts around a ball.
ball.contactnum.all(B_PNT<,INT>) Get number of contacts around a ball.
ball.create(FLT,VEC<,INT>) Create a ball.
ball.damp(B_PNT) Get/set ball local damping factor.
ball.delete(B_PNT) Delete a ball.
ball.density(B_PNT) Get/set ball density.
ball.disp(B_PNT<,INT>) Get/set the ball displacement.
ball.energy(STR) Get the ball total energy contribution.
ball.euler(B_PNT<,INT>)(3D ONLY) Get/set the ball orientation.
ball.extra(B_PNT<,INT>) Get/set ball extra variable.
ball.find(INT) Find a ball.
ball.fix(B_PNT,INT) Get/set ball fixity condition.
ball.force.app(B_PNT<,INT>) Get/set the ball applied force.
ball.force.contact(B_PNT<,INT>) Get/set the ball contact force.
ball.force.unbal(B_PNT<,INT>) Get the ball unbalanced force.
ball.fragment(B_PNT) Get/set ball fragment ID.
ball.group(B_PNT<,STR>) Get/set ball groups.
ball.group.remove(B_PNT,STR) Remove ball groups.
ball.groupmap(STR<,INT>) Get balls that belong to a group.
ball.id(B_PNT) Get the ball ID.
ball.inbox(VEC,VEC<,BOOL>) Get balls with extents intersecting a box.
ball.isbonded(B_PNT<,INT,PNT>) Get the ball bonded state.
ball.isgroup(B_PNT,STR<,STR>) Query the existence of a group.
ball.isprop(B_PNT,STR) Query the existence of a property.
ball.list Get the global ball list.
ball.mass(B_PNT) Get the inertial ball mass.
ball.mass.real(B_PNT) Get the real (gravitational) ball mass.
ball.maxid Get the maximum ball ID.
ball.mech.ratio.avg Get the ball average unbalanced force ratio.
ball.mech.ratio.local Get the ball maximum local unbalanced force ratio.
ball.mech.ratio.max Get the ball maximum unbalanced force ratio.
ball.mech.unbal.max Get the ball maximum unbalanced force.
ball.moi(B_PNT) Get the ball moment of inertia.
ball.moi.real(B_PNT) Get the real (gravitational) ball moment of inertia.
ball.moment.app(B_PNT<,INT>) Get/set the ball applied moment.
ball.moment.contact(B_PNT<,INT>) Get/set the ball contact moment.
ball.moment.unbal(B_PNT<,INT>) Get the ball unbalanced moment.
ball.near(VEC<,FLT>) Find the closest ball to a point.
ball.num Get the number of balls.
ball.pos(B_PNT<,INT>) Get/set the ball position.
ball.prop(B_PNT,STR) Get/set a ball property.
ball.radius(B_PNT) Get/set ball radius.
ball.rotation(B_PNT)(2D ONLY) Get/set the ball orientation.
ball.spin(B_PNT<,INT>) Get/set the ball angular velocity.
ball.stress(B_PNT<,INT,INT>) Get the stress tensor arising from all contacts acting on...
ball.stress.full(B_PNT) Get the full stress tensor arising from all contacts acting...
ball.thermal.ball(BTH_PNT) Get the pointer to the host mechanical ball.
ball.thermal.contactmap(BTH_PNT<,INT,PNT>) Get active thermal contacts around a thermal ball.
ball.thermal.contactmap.all(BTH_PNT<,INT,PNT>) Get all thermal contacts around a thermal ball.
ball.thermal.contactnum(BTH_PNT<,INT>) Get number of active thermal contacts around a thermal ball.
ball.thermal.contactnum.all(BTH_PNT<,INT>) Get total number of thermal contacts around a thermal ball.
ball.thermal.expansion(BTH_PNT) Get/set the thermal expansion coefficient.
ball.thermal.extra(BTH_PNT<,INT>) Get/set the thermal ball extra variable.
ball.thermal.find(INT) Find a thermal ball.
ball.thermal.fix(BTH_PNT) Get/set the temperature fixity condition.
ball.thermal.group(BTH_PNT<,INT>) Get/set thermal ball groups.
ball.thermal.group.remove(BTH_PNT,STR) Remove thermal ball groups.
ball.thermal.id(BTH_PNT) Get the thermal ball ID.
ball.thermal.inbox(VEC,VEC<,BOOL>) Get thermal balls with extents intersecting a box.
ball.thermal.isgroup(BTH_PNT,STR<,STR>) Query the existence of a group.
ball.thermal.isprop(BTH_PNT,STR) Query the existence of a property.
ball.thermal.list Get the global thermal ball list.
ball.thermal.near(VEC<,FLT>) Find the closest thermal ball to a point.
ball.thermal.num Get the number of thermal balls.
ball.thermal.power.app(BTH_PNT) Get/set the thermal applied power.
ball.thermal.power.unbal(BTH_PNT) Get the unbalanced thermal power.
ball.thermal.prop(BTH_PNT,STR) Get/set a thermal ball property.
ball.thermal.specific.heat(BTH_PNT) Get/set the specific heat coefficient.
ball.thermal.temp(BTH_PNT) Get/set the temperature.
ball.thermal.temp.increment(BTH_PNT) Get/set the current temperature increment.
ball.thermal.typeid Get the thermal ball type number.
ball.typeid Get the ball type number.
ball.vel(B_PNT<,INT>) Get/set the ball velocity.
ball.vol(B_PNT) Get ball volume.
ball.zone.ball.ball(B_PNT) Get the ball pointer.
ball.zone.ball.list Get the global list of ball-zone coupled balls.
ball.zone.ball.mass.factor(BZB_PNT) Get/set the ball-zone coupled ball mass factor.
ball.zone.ball.typeid Get the ball-zone coupled ball type number.
ball.zone.gp.gp(GP_PNT) Get the gridpoint pointer.
ball.zone.gp.list Get the global list of ball-zone coupled gridpoints.
ball.zone.gp.mass.factor(BZGP_PNT) Get/set the ball-zone coupled gridpoint mass factor.
ball.zone.gp.typeid Get the ball-zone coupled gridpoint type number.
boolean(BOOL/NUM/PNT) Create a Boolean.
brick.assemble(BR_PNT,VEC<,INT><,INT><,INT>) Replicate a brick.
brick.delete(BR_PNT) Delete a brick.
brick.find(INT) Find a brick.
brick.id(BR_PNT) Get the brick ID.
brick.list Get the global brick list.
brick.maxid Get the maximum brick ID.
brick.num Get the number of bricks.
brick.typeid Get the brick type number.
building_blocks.block.ablock(BB_BLOCK_PNT,BB_FACE_PNT) Get an attached block.
building_blocks.block.center(BB_BLOCK_PNT) Get the center point of a block.
building_blocks.block.check(BB_BLOCK_PNT) Get the validity of a block.
building_blocks.block.edge(BB_BLOCK_PNT,INT) Get a block edge.
building_blocks.block.face(BB_BLOCK_PNT,INT) Get a block face.
building_blocks.block.multiplier(BB_BLOCK_PNT) Get the block multiplier.
building_blocks.block.point(BB_BLOCK_PNT,INT) Get a block point.
building_blocks.block.size(BB_BLOCK_PNT) Get the number of block faces.
building_blocks.edge.center(BB_EDGE_PNT) Get the center point of an edge.
building_blocks.edge.cp.add(BB_EDGE_PNT,VEC) Add a control point to an edge.
building_blocks.edge.cp.delete(BB_EDGE_PNT,INT) Delete a control point on an edge.
building_blocks.edge.cp.localu(BB_EDGE_PNT,INT) Get a local edge coordinate of a control point.
building_blocks.edge.cp.point(BB_EDGE_PNT,INT) Get the 3D coordinates of a control point.
building_blocks.edge.cp.size(BB_EDGE_PNT) Get the number of control points on an edge.
building_blocks.edge.curve(BB_EDGE_PNT) Get edge curvature.
building_blocks.edge.direction(BB_EDGE_PNT) Get edge direction.
building_blocks.edge.grid.ratio(BB_EDGE_PNT) Get the ratio parameter of an edge.
building_blocks.edge.grid.ratio.isolate(BB_EDGE_PNT) Get the state of the ratio-isolate flag.
building_blocks.edge.grid.size(BB_EDGE_PNT) Get the number of zones along an edge.
building_blocks.edge.length(BB_EDGE_PNT) Get the length of an edge.
building_blocks.edge.next.edge(BB_EDGE_PNT,INT) Get the next edge in a list.
building_blocks.edge.next.index(BB_EDGE_PNT,INT) Get the index of the next edge in a list.
building_blocks.edge.point(BB_EDGE_PNT,INT) Get an edge point.
building_blocks.edge.start.face(BB_EDGE_PNT) Get the first face in a list.
building_blocks.edge.start.index(BB_EDGE_PNT) Get the index of the first face in a list.
building_blocks.edge.toglobal(BB_EDGE_PNT,FLT) Get the global coordinates of a point from local coordinates.
building_blocks.edge.tolocal(BB_EDGE_PNT,VEC) Get the local coordinate of a point from global coordinates.
building_blocks.edge.type(BB_EDGE_PNT) Get edge type.
building_blocks.face.area(BB_FACE_PNT) Get the area of a face.
building_blocks.face.center(BB_FACE_PNT) Get the center point of a face.
building_blocks.face.check(BB_FACE_PNT) Get the validity of the face.
building_blocks.face.edge(BB_FACE_PNT,INT) Get an edge of a face.
building_blocks.face.flip(BB_FACE_PNT,INT) Get edge “flipped” status.
building_blocks.face.gridsizei(BB_FACE_PNT,BB_BLOCK_PNT) Get number of zones along the local “x” edge of...
building_blocks.face.gridsizej(BB_FACE_PNT,BB_BLOCK_PNT) Get number of zones along the local “y” edge of...
building_blocks.face.next.face(BB_FACE_PNT,INT) Get the next face in a list.
building_blocks.face.next.index(BB_FACE_PNT,INT) Get the index of the next face in a list.
building_blocks.face.point(BB_FACE_PNT,INT) Get a point of a face.
building_blocks.face.size(BB_FACE_PNT) Get the number of face edges.
building_blocks.face.toglobal(BB_FACE_PNT,VEC) Get the global coordinates of a point from local coordinates.
building_blocks.face.tolocal(BB_FACE_PNT,VEC) Get the local coordinates of a point from global coordinates.
building_blocks.point.pos(BB_POINT_PNT) Get point position.
building_blocks.point.start.edge(BB_POINT_PNT) Get the first edge in a list.
building_blocks.point.start.index(BB_POINT_PNT) Get the index of this point on the first edge...
building_blocks.set.block.create(BB_SET_PNT,STR,VEC,VEC,VEC,VEC<,VEC><,VEC><,VEC><,VEC>) Create a block.
building_blocks.set.block.find(BB_SET_PNT,INT) Get a block by ID.
building_blocks.set.block.list(BB_SET_PNT) Get a block container from a set.
building_blocks.set.block.remove(BB_SET_PNT,BB_BLOCK_PNT) Remove a block from a set.
building_blocks.set.block.size(BB_SET_PNT) Get the number of blocks in a set.
building_blocks.set.create(STR<,INT>) Create a building blocks set.
building_blocks.set.delete(BB_SET_PNT) Delete a building blocks set.
building_blocks.set.edge.find(BB_SET_PNT,INT) Get an edge by ID.
building_blocks.set.edge.list(BB_SET_PNT) Get an edge container from a set.
building_blocks.set.edge.near(BB_SET_PNT,VEC<,FLT>) Get the nearest edge from coordinates.
building_blocks.set.edge.size(BB_SET_PNT) Get the number of edges.
building_blocks.set.face.find(BB_SET_PNT,INT) Get face by ID.
building_blocks.set.face.list(BB_SET_PNT) Get a face container from a set.
building_blocks.set.face.near(BB_SET_PNT,VEC<,FLT>) Get the nearest face from coordinates.
building_blocks.set.face.size(BB_SET_PNT) Get the number of faces in a set.
building_blocks.set.find(INT/STR) Get a set by the name or by ID.
building_blocks.set.id(BB_SET_PNT) Get the building blocks set ID.
building_blocks.set.list Get a container of building blocks sets.
building_blocks.set.name(BB_SET_PNT) Get the name of the building blocks set.
building_blocks.set.point.find(BB_SET_PNT,INT) Get a point by ID.
building_blocks.set.point.list(BB_SET_PNT) Get a point container from a set.
building_blocks.set.point.near(BB_SET_PNT,VEC<,FLT>) Get the nearest point from coordinates.
building_blocks.set.point.size(BB_SET_PNT) Get the number of points in a set.
cfd.age Get the CFD age.
cfd.cycle Get the CFD cycles.
clump.addpebble(CL_PNT,FLT,VEC<,INT>) Add a pebble to a clump.
clump.calculate(CL_PNT<,FLT>) Calculate the inertial properties.
clump.cfd.clump(CLCF_PNT) Get the pointer to the host mechanical clump.
clump.cfd.elementmap(CLCF_PNT) Get the CCFD element associated with a clump.
clump.cfd.extra(CLCF_PNT<,INT>) Get/set the CFD clump extra variable.
clump.cfd.find(INT) Find a CFD clump.
clump.cfd.force(CLCF_PNT<,INT>) Get/set the CFD clump force.
clump.cfd.group(CLCF_PNT<,INT>) Get/set CFD clump groups.
clump.cfd.group.remove(CLCF_PNT,STR) Remove CFD clump groups.
clump.cfd.id(CLCF_PNT) Get the CFD clump ID.
clump.cfd.inbox(VEC,VEC<,BOOL>) Get CFD clumps with extents intersecting a box.
clump.cfd.isgroup(CLCF_PNT,STR<,STR>) Query the existence of a group.
clump.cfd.list Get the global CFD clump list.
clump.cfd.near(VEC<,FLT>) Find the closest CFD clump to a point.
clump.cfd.num Get the number of CFD clumps.
clump.cfd.pebble.clump(CLPCF_PNT) Get the CFD pebble’s CFD clump.
clump.cfd.pebble.find(INT) Find a CFD pebble.
clump.cfd.pebble.group(CLPCF_PNT<,STR>) Get/set CFD pebble groups.
clump.cfd.pebble.group.remove(CLPCF_PNT,STR) Remove CFD pebble groups.
clump.cfd.pebble.id(CLPCF_PNT) Get/set the CFD pebble ID.
clump.cfd.pebble.inbox(VEC,VEC<,BOOL>) Get CFD pebbles with extents intersecting a box.
clump.cfd.pebble.isgroup(CLPCF_PNT,STR<,STR>) Query the existence of a group.
clump.cfd.pebble.list Get the global CFD pebble list.
clump.cfd.pebble.near(VEC<,FLT>) Find the closest CFD pebble to a point.
clump.cfd.pebble.num Get the number of CFD pebbles.
clump.cfd.pebble.pebble(CLPCF_PNT) Get the host mechanical pebble.
clump.cfd.pebble.typeid Get the CFD pebble type number.
clump.cfd.pebblelist(CLCF_PNT) Get the CFD pebbles of a CCFD clump.
clump.cfd.pos(CLCF_PNT<,INT>) Get the CFD clump position.
clump.cfd.typeid Get the CFD clump type number.
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.energy(STR) Get the clump total energy contribution.
clump.euler(CL_PNT<,INT>)(3D ONLY) Get/set the clump orientation.
clump.extra(CL_PNT<,INT>) Get/set a clump extra variable.
clump.find(INT) Find a clump.
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.groupmap(STR<,INT>) Get clumps that belong to a group.
clump.id(CL_PNT) Get the clump ID.
clump.inbox(VEC,VEC<,BOOL>) Get clumps with extents intersecting a box.
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.list Get the global clump list.
clump.mass(CL_PNT) Get the inertial clump mass.
clump.mass.real(CL_PNT) Get the real (gravitational) clump mass.
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.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.near(VEC<,FLT>) Find the closest clump to a point.
clump.num Get the number of clumps.
clump.pebble.clump(CLP_PNT) Get the pebble’s clump.
clump.pebble.contactmap(CLP_PNT<,INT><,PNT>) Get active contacts around a ball.
clump.pebble.contactmap.all(CLP_PNT<,INT><,PNT>) Get all contacts around a pebble.
clump.pebble.contactnum(CLP_PNT<,INT>) Get number of active contacts around a pebble.
clump.pebble.contactnum.all(CLP_PNT<,INT>) Get number of contacts around a pebble.
clump.pebble.delete(CLP_PNT) Delete a pebble.
clump.pebble.extra(CLP_PNT<,INT>) Get/set pebble extra variable.
clump.pebble.find(INT) Find a pebble.
clump.pebble.group(CLP_PNT<,STR>) Get/set pebble groups.
clump.pebble.group.remove(CL_PNT,STR) Remove pebble groups.
clump.pebble.groupmap(STR<,INT>) Get pebbles that belong to a group.
clump.pebble.id(CLP_PNT) Get the pebble ID.
clump.pebble.inbox(VEC,VEC<,BOOL>) Get clump pebbles with extents intersecting a box.
clump.pebble.isbonded(CL_PNT<,INT,PNT>) Get the clump pebble bonded state.
clump.pebble.isgroup(CLP_PNT,STR<,STR>) Query the existence of a group.
clump.pebble.isprop(CLP_PNT,STR) Query the existence of a property.
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.pos(CLP_PNT<,INT>) Get/set the pebble position.
clump.pebble.prop(CLP_PNT,STR) Get/set a pebble property.
clump.pebble.radius(CLP_PNT) Get/set the pebble radius.
clump.pebble.typeid Get the pebble type number.
clump.pebble.vel(CLP_PNT<,INT>) Get the pebble velocity.
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.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.euler(CL_PNT<,INT>)(3D ONLY) Get the clump template relative orientation.
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.make(CL_PNT,STR) Make a clump template from a clump.
clump.template.maxid Get the maximum clump template ID.
clump.template.moi(CLT_PNT<,INT<,INT>>) Get the clump template moment of inertia.
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.num Get the number of clump templates.
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.scale(CL_PNT) Get clump template relative scaling factor.
clump.template.typeid Get the clump template type number.
clump.template.vol(CLT_PNT) Get/set the clump template volume.
clump.thermal.clump(CLTH_PNT) Get the pointer to the host mechanical clump.
clump.thermal.contactmap(CLTH_PNT<,INT,PNT>) Get active thermal contacts around a thermal clump.
clump.thermal.contactmap.all(CLTH_PNT<,INT,PNT>) Get all thermal contacts around a thermal clump.
clump.thermal.contactnum(CLTH_PNT<,INT>) Get the number of active thermal contacts around a thermal...
clump.thermal.contactnum.all(CLTH_PNT<,INT>) Get the number of thermal contacts around a thermal clump.
clump.thermal.expansion(CLTH_PNT) Get/set the thermal expansion coefficient.
clump.thermal.extra(CLTH_PNT<,INT>) Get/set the thermal clump extra variable.
clump.thermal.find(INT) Find a thermal clump.
clump.thermal.fix(CLTH_PNT) Get/set the temperature fixity condition.
clump.thermal.group(CLTH_PNT<,INT>) Get/set thermal clump groups.
clump.thermal.group.remove(CLTH_PNT,STR) Remove thermal clump groups.
clump.thermal.id(CLTH_PNT) Get the thermal clump ID.
clump.thermal.inbox(VEC,VEC<,BOOL>) Get thermal clumps with extents intersecting a box.
clump.thermal.isgroup(CLT_PNT,STR<,STR>) Query the existence of a group.
clump.thermal.list Get the global thermal clump list.
clump.thermal.near(VEC<,FLT>) Find the closest thermal clump to a point.
clump.thermal.num Get the number of thermal clumps.
clump.thermal.pebble.clump(CLPTH_PNT) Get the thermal pebble’s thermal clump.
clump.thermal.pebble.contactmap(CLPTH_PNT<,INT,PNT>) Get active thermal contacts around a thermal pebble.
clump.thermal.pebble.contactnum(CLPTH_PNT<,INT>) Get the number of active thermal contacts around a thermal...
clump.thermal.pebble.contactnum.all(CLPTH_PNT<,INT>) Get the number of thermal contacts around a thermal pebble.
clump.thermal.pebble.find(INT) Find a thermal pebble.
clump.thermal.pebble.group(CLPTH_PNT<,STR>) Get/set thermal pebble groups.
clump.thermal.pebble.group.remove(CLPTH_PNT,STR) Remove thermal pebble groups.
clump.thermal.pebble.id(CLPTH_PNT) Get/set the thermal pebble ID.
clump.thermal.pebble.inbox(VEC,VEC<,BOOL>) Get thermal pebbles with extents intersecting a box.
clump.thermal.pebble.isgroup(CLPTH_PNT,STR<,STR>) Query the existence of a group.
clump.thermal.pebble.isprop(CLPTH_PNT,STR) Query the existence of a property.
clump.thermal.pebble.list Get the global thermal pebble list.
clump.thermal.pebble.near(VEC<,FLT>) Find the closest thermal pebble to a point.
clump.thermal.pebble.num Get the number of thermal pebbles.
clump.thermal.pebble.pebble(CLPTH_PNT) Get the host mechanical pebble.
clump.thermal.pebble.prop(CLPTH_PNT,STR) Get/set a thermal pebble property.
clump.thermal.pebble.typeid Get the thermal pebble type number.
clump.thermal.pebblelist(CLTH_PNT) Get the thermal pebbles of a thermal clump.
clump.thermal.power.app(CLTH_PNT) Get/set the thermal applied power.
clump.thermal.power.unbal(CLTH_PNT) Get the unbalanced thermal power.
clump.thermal.prop(CLTH_PNT,STR) Set a property of all thermal pebbles.
clump.thermal.specific.heat(CLTH_PNT) Get/set the specific heat coefficient.
clump.thermal.temp(CLTH_PNT) Get/set the temperature.
clump.thermal.temp.increment(CLTH_PNT) Get/set the current temperature increment.
clump.thermal.typeid Get the thermal clump type number.
clump.typeid Get the clump type number.
clump.vel(CL_PNT<,INT>) Get/set the clump velocity.
clump.vol(CL_PNT) Get/set the clump volume.
code.debug Get the code debug status.
code.name Get the code name.
comp(VEC/MAT_PNT/TEN_PNT,INT<,INT>) Get/set the vector/tensor component.
contact.activate(C_PNT) Get/set the contact always active flag.
contact.active(C_PNT) Get the contact activity state .
contact.branch(C_PNT<,INT>) Get the contact branch vector.
contact.end1(C_PNT) Get a pointer to the first end of a contact.
contact.end2(C_PNT) Get a pointer to the second end of a contact.
contact.energy(C_PNT,STR) Get the current value of an energy partition.
contact.energy.sum(STR<,STR>) Get the current value of an energy partition accumulated over...
contact.extra(C_PNT<,INT>) Get/set contact extra variable.
contact.fid(C_PNT) Get the contact fracture ID.
contact.find(STR/INT,INT<,INT>) Find a contact.
contact.force.from.stress(C_PNT,MAT_PNT/TEN_PNT) Get the equivalent contact force.
contact.force.global(C_PNT<,INT>) Get the contact force in the global coordinate system.
contact.force.local(C_PNT<,INT>) Get the contact force in the local coordinate system.
contact.force.normal(C_PNT) Get the signed magnitude of the normal force.
contact.force.shear(C_PNT) Get the magnitude of the shear force.
contact.gap(C_PNT) Get the current value of the contact gap.
contact.group(C_PNT<,STR>) Get/set contact groups.
contact.group.remove(C_PNT,STR) Remove contact groups.
contact.groupmap(STR<,INT,STR>) Get active contacts that belong to a group.
contact.groupmap.all(STR<,INT,STR>) Get all contacts that belong to a group.
contact.id(C_PNT) Get the contact ID.
contact.inherit(C_PNT,STR) Get/set the property inheritance.
contact.inhibit(C_PNT) Get/set the contact inhibit flag.
contact.isbonded(C_PNT) Get the bonded status.
contact.isenergy(C_PNT,STR) Query the existence of a contact model energy partition.
contact.isgroup(C_PNT,STR<,STR>) Query the existence of a group.
contact.isprop(C_PNT,STR) Query the existence of a contact model property.
contact.list(<STR>) Access the active contacts list.
contact.list.all(<STR>) Access the entire contact list, including inactive contacts.
contact.method(C_PNT,STR<,ARR_PNT>) Execute a contact model method.
contact.model(C_PNT) Get/set a contact model.
contact.moment.on1.global(C_PNT<,INT>) Get the contact moment acting on end1 expressed in the...
contact.moment.on1.local(C_PNT<,INT>) Get the contact moment acting on end1 expressed in the...
contact.moment.on2.global(C_PNT<,INT>) Get the contact moment acting on end2 expressed in the...
contact.moment.on2.local(C_PNT<,INT>) Get the contact moment acting on end2 expressed in the...
contact.normal(C_PNT<,INT>) Get the contact unit normal.
contact.num(<STR>) Return the number of active contacts.
contact.num.all(<STR>) Return the number of contacts, including inactive ones.
contact.offset(C_PNT<,INT>) Get the contact offset.
contact.otherend(C_PNT,SYM) Get the other end of a contact.
contact.persist(C_PNT) Get/set the persistence flag.
contact.pos(C_PNT<,INT>) Get the contact position.
contact.prop(C_PNT,STR) Get/set a contact model property.
contact.shear(C_PNT<,INT>) Get the contact shear direction.
contact.thermal.power(CTH_PNT) Get the contact thermal power.
contact.to.global(C_PNT,VEC) Transform a vector from the local to global coordinate system.
contact.to.local(C_PNT,VEC) Transform a vector from the global to local coordinate system.
contact.typeid(STR) Get the unique integer identifier associated with a contact type.
creep.active Get the status of creep calculations in the current cycle.
creep.age Get the accumulated age.
creep.cycle Get the current step/cycle number.
creep.safety.factor Get the factor of safety.
creep.solve(STR) Get a current solve limit.
creep.step Get the current step/cycle number.
creep.time.total Get the accumulated age.
creep.timestep Get the creep timestep.
creep.timestep.given Get the given timestep.
creep.timestep.max Get the maximum allowed timestep.
data.label.arrow(UDL_PNT) Get/set arrow status.
data.label.create(VEC<,INT/STR>) Create a label.
data.label.delete(UDL_PNT) Delete a label.
data.label.end(UDL_PNT<,INT>) Get/set the end position.
data.label.find(INT/STR) Find a label.
data.label.head Get the head of the global label list.
data.label.list Get the global label list.
data.label.maxid Get the maximum label ID.
data.label.name(UDL_PNT) Get the label name.
data.label.next(UDL_PNT) Get the next label.
data.label.num Get the number of labels.
data.label.pos(UDL_PNT<,INT>) Get/set the position.
data.label.text(UDL_PNT) Get/set the label text.
data.label.typeid Get the label type ID number.
data.scalar.create(VEC) Create a scalar.
data.scalar.delete(UDS_PNT) Delete the scalar.
data.scalar.extra(UDS_PNT<,INT>) Get/set a scalar extra variable.
data.scalar.find(INT) Find a scalar.
data.scalar.group(UDS_PNT<,INT/STR>) Get/set a scalar group.
data.scalar.group.remove(UDS_PNT,INT/STR) Remove scalar groups.
data.scalar.head Get the head of the global list of scalars.
data.scalar.id(UDS_PNT) Get the scalar ID.
data.scalar.isgroup(UDS_PNT,INT/STR<,INT/STR>) Query the existence of a group.
data.scalar.list Get the global scalar list.
data.scalar.maxid Get the maximum scalar ID.
data.scalar.near(VEC<,FLT>) Find the closest scalar to a point.
data.scalar.next(UDS_PNT) Get the next scalar.
data.scalar.num Get the number of scalars.
data.scalar.pos(UDS_PNT<,INT>) Get/set the scalar position.
data.scalar.typeid Get the scalar type ID number.
data.scalar.value(UDS_PNT) Get/set the scalar value.
data.tensor.create(VEC) Create a tensor.
data.tensor.delete(UDT_PNT) Delete the tensor.
data.tensor.extra(UDT_PNT<,INT>) Get/set a tensor extra variable.
data.tensor.find(INT) Find a tensor.
data.tensor.group(UDT_PNT<,INT/STR>) Get/set a tensor group.
data.tensor.group.remove(UDT_PNT,INT/STR) Remove tensor groups.
data.tensor.head Get the head of the global list of tensors.
data.tensor.id(UDT_PNT) Get the tensor ID.
data.tensor.isgroup(UDT_PNT,INT/STR<,INT/STR>) Query the existence of a group.
data.tensor.list Get the global tensor list.
data.tensor.maxid Get the maximum tensor ID.
data.tensor.near(VEC<,FLT>) Find the closest tensor to a point.
data.tensor.next(UDT_PNT) Get the next tensor.
data.tensor.num Get the number of tensors.
data.tensor.pos(UDT_PNT<,INT>) Get/set the tensor position.
data.tensor.typeid Get the tensor type ID number.
data.tensor.value(UDT_PNT<,INT<,INT>>) Get/set the tensor value.
data.vector.create(VEC) Create a vector.
data.vector.ddir(UDV_PNT)(3D only) Get/set the vector dip direction.
data.vector.delete(UDV_PNT) Delete the vector.
data.vector.dip(UDV_PNT) Get/set the vector dip.
data.vector.extra(UDV_PNT<,INT>) Get/set a vector extra variable.
data.vector.find(INT) Find a vector.
data.vector.group(UDV_PNT<,INT/STR>) Get/set vector groups.
data.vector.group.remove(UDV_PNT,INT/STR) Remove vector groups.
data.vector.head Get the head of the global list of vectors.
data.vector.id(UDV_PNT) Get the vector ID.
data.vector.isgroup(UDV_PNT,INT/STR<,INT/STR>) Query the existence of a group.
data.vector.list Get the global vector list.
data.vector.maxid Get the maximum vector ID.
data.vector.near(VEC<,FLT>) Find the closest vector to a point.
data.vector.next(UDV_PNT) Get the next vector.
data.vector.num Get the number of vectors.
data.vector.pos(UDV_PNT<,INT>) Get/set the vector position.
data.vector.typeid Get the vector type ID number.
data.vector.value(UDV_PNT<,INT>) Get/set the vector value.
dfn.contactmap(D_PNT<,INT>) Get active contacts associated with a DFN.
dfn.contactmap.all(D_PNT<,INT>) Get all contacts associated with a DFN.
dfn.create(<INT><,STR>) Create a DFN.
dfn.delete(D_PNT) Delete a DFN.
dfn.dominance(D_PNT) Get/set the DFN dominance.
dfn.extra(D_PNT<,INT>) Get/set a DFN extra variable.
dfn.find(INT/STR) Find a DFN.
dfn.fracturelist(D_PNT) Get the fracture list of the DFN.
dfn.fracturenum(D_PNT) Get the number of fractures.
dfn.group(D_PNT<,STR>) Get/set DFN groups.
dfn.group.remove(D_PNT,STR) Remove DFN groups.
dfn.id(D_PNT) Get the DFN ID.
dfn.isgroup(D_PNT,STR<,STR>) Indicate DFN group status.
dfn.list Get the global DFN list.
dfn.maxid Get the maximum DFN ID.
dfn.name(D_PNT) Get the DFN name.
dfn.num Get the number of DFNs.
dfn.prop(D_PNT,STR) Set a property of all fractures in a DFN.
dfn.template(D_PNT) Get the fracture template.
dfn.typeid Get the DFN type number.
domain.condition(STR) Get/set the domain conditions.
domain.max(<INT>) Get/set the upper domain corner.
domain.min(<INT>) Get/set the lower domain corner.
domain.strain.rate(<INT,INT>) Get/set the domain strain rate.
domain.tolerance Get/set the domain remapping tolerance.
dynamic.active Get the status of dynamic calculations in the current cycle.
dynamic.age Get the accumulated age.
dynamic.cycle Get the current step/cycle number.
dynamic.safety.factor Get the factor of safety.
dynamic.solve(STR) Get a current solve limit.
dynamic.step Get the current step/cycle number.
dynamic.time.total Get the accumulated age.
dynamic.timestep Get the dynamic timestep.
dynamic.timestep.given Get the given timestep.
dynamic.timestep.max Get the maximum allowed timestep.
element.cfd.density(ECF_PNT) Get/set the CFD element fluid density.
element.cfd.dragforce(ECF_PNT<,INT>) Get/set the CFD element drag force.
element.cfd.edge.adjacentmap(ECF_PNT) Get CCFD elements sharing a edge.
element.cfd.extra(ECF_PNT<,INT>) Get/set the CFD element extra variable.
element.cfd.face.adjacent(ECF_PNT,INT) Get the CFD element adjacent to a face.
element.cfd.face.adjacentmap(ECF_PNT) Get CFD elements sharing a face.
element.cfd.face.num Get the number of faces per CFD element.
element.cfd.find(INT) Find a CFD element.
element.cfd.group(ECF_PNT<,INT>) Get/set CFD element groups.
element.cfd.group.remove(ECF_PNT,STR) Remove CFD element groups.
element.cfd.id(ECF_PNT) Get the CFD element ID.
element.cfd.inbox(VEC,VEC<,BOOL>) Get CFD elements with extents intersecting a box.
element.cfd.isgroup(ECF_PNT,STR<,STR>) Query the existence of a group.
element.cfd.list Get the global CFD element list.
element.cfd.near(VEC<,FLT>) Find the closest CFD element to a point.
element.cfd.node.adjacentmap(ECF_PNT) Get CFD elements sharing a node.
element.cfd.node.num Get the number of nodes per CFD element.
element.cfd.node.pos(ECF_PNT,INT<,INT>) Get the CFD element node position.
element.cfd.num Get the number of CFD elements.
element.cfd.porosity(ECF_PNT) element.
element.cfd.pos(ECF_PNT<,INT>) Get the CFD element position.
element.cfd.presgradient(ECF_PNT<,INT>) Get/set the CFD element pressure gradient.
element.cfd.pressure(ECF_PNT) Get/set the CFD element fluid pressure.
element.cfd.typeid Get the CFD element type number.
element.cfd.vel(ECF_PNT<,INT>) Get/set the CFD element velocity.
element.cfd.viscosity(ECF_PNT) Get/set the CFD element fluid viscosity.
element.cfd.vol(ECF_PNT) Get the CFD element volume.
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.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.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.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.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).
false Create a false Boolean.
file.close(<FILE_PNT>) Close a file.
file.open(STR,INT,INT) Open a file for reading/writing.
file.open.pointer(STR,INT,INT) Open a file for reading/writing.
file.pos(<FILE_PNT>) Get/set the current position in bytes.
file.read(ARR_PNT/STR,INT<,FILE_PNT/ARR_PNT><,INT><,INT>) Read the contents of a file.
file.write(ARR_PNT/STR,INT<,FILE_PNT/ARR_PNT><,INT><,INT>) Write data to a file.
float(BOOL/NUM/STR) Create a float.
fluid.active Get the status of fluid calculations in the current cycle.
fluid.age Get the accumulated age.
fluid.cycle Get the current step/cycle number.
fluid.safety.factor Get the factor of safety.
fluid.solve(STR) Get a current solve limit.
fluid.step Get the current step/cycle number.
fluid.time.total Get the accumulated age.
fluid.timestep Get the fluid timestep.
fluid.timestep.given Get the given timestep.
fluid.timestep.max Get the maximum allowed timestep.
fracture.aperture(FR_PNT) Get/set the fracture aperture.
fracture.area(FR_PNT)(3D only) Get/set the fracture area.
fracture.centerdensity(<VEC><,VEC><,D_PNT>) Get the fracture center density.
fracture.contactmap(FR_PNT<,INT>) Get active contacts associated with a fracture.
fracture.contactmap.all(FR_PNT<,INT>) Get all contacts associated with a fracture.
fracture.copy(FR_PNT<,D_PNT,INT>) Copy a fracture.
fracture.create(D_PNT,ARR_PNT<,INT>) Create a fracture.
fracture.ddir(FR_PNT)(3D only) Get/set the fracture dip direction.
fracture.delete(FR_PNT) Delete a fracture.
fracture.density(<VEC><,VEC><,D_PNT>) Get the fracture mass density.
fracture.dfn(FR_PNT) Get the fracture’s DFN.
fracture.diameter(FR_PNT)(3D only) Get/set the fracture diameter.
fracture.dip(FR_PNT) Get/set the fracture dip.
fracture.extra(FR_PNT<,INT>) Get/set a fracture extra variable.
fracture.find(INT) Find a fracture.
fracture.genpos(FR_PNT<,INT>) Get the fracture generation position.
fracture.gensize(FR_PNT) Get the fracture generation {length in 2D; diameter in 3D}.
fracture.geomp10(GSET_PNT<,D_PNT>) Get the P10 of edges.
fracture.geomp20(GSET_PNT<,D_PNT>)(3D only) Get the P20 of polygons.
fracture.geomp21(GSET_PNT<,D_PNT>)(3D only) Get the P21 of polygons.
fracture.geomtrace(GSET_PNT<,D_PNT>)(3D only) Get polygon average trace length.
fracture.gintersect(FR_PNT,GSET_PNT) Get the fracture/geometry intersection status.
fracture.group(FR_PNT<,STR>) Get/set fracture groups.
fracture.group.remove(FR_PNT,STR) Remove fracture groups.
fracture.id(FR_PNT) Get the fracture ID.
fracture.inbox(VEC,VEC<,D_PNT>) Get fractures intersecting or contained within a box.
fracture.interarray(FR_PNT<,D_PNT>) Get an array of fracture intersections.
fracture.intersect(FR_PNT,FR_PNT) Get the fracture/fracture intersection status.
fracture.intersect.end1(FI_PNT) Get the first fracture in an intersection.
fracture.intersect.end2(FI_PNT) Get the second intersecting object.
fracture.intersect.find(INT) Find a fracture intersection.
fracture.intersect.len(FI_PNT)(3D only) Get the intersection length.
fracture.intersect.list Get the fracture intersection list.
fracture.intersect.maxid Get the maximum fracture intersection ID.
fracture.intersect.npolylinept(FI_PNT)(3D only) Get the number of polyline points in an intersection.
fracture.intersect.num Get the number of fracture intersections.
fracture.intersect.polylinept(FI_PNT)(3D only) Get a polyline point position in an intersection.
fracture.intersect.pos1(FI_PNT<,INT>) Get the first fracture intersection end position.
fracture.intersect.pos2(FI_PNT<,INT>)(3D only) Get the second fracture intersection end position.
fracture.intersect.set(FI_PNT) Get the intersection set.
fracture.intersect.set.delete(FIS_PNT) Delete a fracture intersection set.
fracture.intersect.set.find(INT/STR) Find a fracture intersection set.
fracture.intersect.set.id(FIS_PNT) Get the fracture intersection set ID.
fracture.intersect.set.interlist(FIS_PNT) Get the fracture intersection list.
fracture.intersect.set.internum(FIS_PNT) Get the number of intersections in the set.
fracture.intersect.set.list Get the fracture intersection set list.
fracture.intersect.set.maxid Get the maximum fracture intersection set ID.
fracture.intersect.set.name(FIS_PNT) Get the fracture intersection set name.
fracture.intersect.set.num Get the number of fracture intersection sets.
fracture.intersect.set.path(FIS_PNT,FR_PNT,FR_PNT) Get the path between fractures.
fracture.intersect.set.typeid Get the fracture intersection set type number.
fracture.intersect.typeid Get the fracture intersection type number.
fracture.isdisk(FR_PNT)(3D only) Get the fracture disk status.
fracture.isgroup(FR_PNT,STR<,INT>) Indicate fracture group status.
fracture.isprop(FR_PNT,STR) Query the existence of a property.
fracture.len(FR_PNT)(2D only) Get/set the fracture length.
fracture.list Get the global fracture list.
fracture.maxid Get the maximum fracture ID.
fracture.near(VEC<,FLT><,D_PNT>) Find the closest fracture to a point.
fracture.normal(FR_PNT<,INT>) Get/set the fracture normal.
fracture.num Get the total number of fractures.
fracture.p10(VEC,VEC<,D_PNT>) Get the P10 along a transect.
fracture.percolation(<VEC><,VEC><,D_PNT>) Get the fracture percolation.
fracture.pointnear(FR_PNT,VEC) Get the closest point on a fracture.
fracture.pos(FR_PNT<,INT>) Get/set the fracture position.
fracture.prop(FR_PNT,STR) Get/set a fracture property.
fracture.template.ddirmax(DT_PNT)(3D only) Get/set the maximum dip direction.
fracture.template.ddirmin(DT_PNT)(3D only) Get/set the minimum dip direction.
fracture.template.dipmax(DT_PNT) Get/set the maximum dip.
fracture.template.dipmin(DT_PNT) Get/set the minimum dip.
fracture.template.find(INT/STR) Find a DFN template.
fracture.template.id(DT_PNT) Get the DFN template ID.
fracture.template.list Get the DFN template list.
fracture.template.maxid Get the maximum DFN template ID.
fracture.template.name(DT_PNT) Get the DFN template name.
fracture.template.norientparam(DT_PNT) Get the number of orientation parameters.
fracture.template.nposparam(DT_PNT) Get the number of position parameters.
fracture.template.nsizeparam(DT_PNT) Get the number of size parameters.
fracture.template.num Get the number of DFN templates.
fracture.template.orientparam(DT_PNT,INT) Get/set an orientation parameter.
fracture.template.orienttype(DT_PNT) Get/set the DFN template orientation type name.
fracture.template.posparam(DT_PNT,INT) Get/set a position parameter.
fracture.template.postype(DT_PNT) Get/set the DFN template position type name.
fracture.template.sizemax(DT_PNT) Get/set the maximum size.
fracture.template.sizemin(DT_PNT) Get/set the minimum size.
fracture.template.sizeparam(DT_PNT,INT) Get/set a size parameter.
fracture.template.sizetype(DT_PNT) Get/set the DFN template size type name.
fracture.template.typeid Get the DFN template type number.
fracture.typeid Get the fracture type number.
fracture.vertex.find(INT) Find a fracture vertex.
fracture.vertex.list Get the fracture vertex list.
fracture.vertex.maxid Get the maximum fracture vertex ID.
fracture.vertex.num Get the number of fracture vertices.
fracture.vertex.pos(FV_PNT<,INT>) Get the fracture vertex position.
fracture.vertex.typeid Get the fracture vertex type number.
fracture.vertexarray(FR_PNT) Get an array of fracture vertices.
fragment.bodymap(FG_PNT<,INT>) Get the bodies of a fragment.
fragment.bodynum(FG_PNT<,INT>) Get the fragment body count.
fragment.catalog Get the fragment catalog.
fragment.catalog.num(<flt>) Get the fragment catalog number.
fragment.childmap(FG_PNT) Get the children fragment IDs.
fragment.find(INT) Find a fragment.
fragment.history(BODY_PNT) Get the body fragment history.
fragment.id(FG_PNT) Get the fragment ID.
fragment.index(BODY_PNT<,INT>) Get the body fragment ID.
fragment.map(<INT>) Get a map of fragments.
fragment.num(INT) Get the fragment count.
fragment.parent(FG_PNT) Get the parent fragment ID.
fragment.pos(FG_PNT<,INT>) Get the fragment position.
fragment.pos.catalog(FG_PNT,INT<,INT>) Get the fragment position at a state.
fragment.vol(FG_PNT<,int>) Get the fragment volume.
geom.edge.create(GSET_PNT,INT/GN_PNT,INT/GN_PNT) Create an edge.
geom.edge.delete(GSET_PNT,GE_PNT) Delete an edge.
geom.edge.dir(GE_PNT<,INT>) Get the edge direction.
geom.edge.extra(GE_PNT,INT) Get/set edge extra variable.
geom.edge.find(GSET_PNT,INT) Find an edge.
geom.edge.group(GE_PNT<,STR>) Get/set edge groups.
geom.edge.group.remove(GE_PNT,STR) Remove edge groups.
geom.edge.id(GE_PNT) Get the edge ID.
geom.edge.isgroup(GE_PNT,STR<,STR>) Query the existence of a group.
geom.edge.list(GSET_PNT) Get the edge list of a geometry set.
geom.edge.near(GSET_PNT,VEC<,FLT>) Find the closest edge to a point.
geom.edge.next.edge(GE_PNT,INT) Get the edge connected to a node.
geom.edge.next.index(GE_PNT,INT) Get the edge index connected to a node.
geom.edge.node(GE_PNT,INT) Get an edge node.
geom.edge.node.pos(GE_PNT,INT<,INT>) Get/set the node position.
geom.edge.pos(GE_PNT<,INT>) Get the edge position.
geom.edge.remove(GSET_PNT,GE_PNT) Delete an edge.
geom.edge.start.index(GE_PNT) Index of the first polygon attached to an edge.
geom.edge.start.poly(GE_PNT) Get the first polygon attached to an edge.
geom.edge.typeid Get the edge type number.
geom.node.create(GSET_PNT,VEC) Create a node.
geom.node.delete(GSET_PNT,GN_PNT) Delete a node.
geom.node.extra(GN_PNT,INT) Get/set node extra variable.
geom.node.find(GSET_PNT,INT) Find a node.
geom.node.group(GN_PNT<,STR>) Get/set node groups.
geom.node.group.remove(GN_PNT,STR) Remove node groups.
geom.node.id(GN_PNT) Get the node ID.
geom.node.isgroup(GN_PNT,STR<,STR>) Query the existence of a group.
geom.node.list(GSET_PNT) Get the node list of a geometry set.
geom.node.near(GSET_PNT,VEC<,FLT>) Find the closest node to a point.
geom.node.pos(GN_PNT<,INT>) Get/set the node position.
geom.node.remove(GSET_PNT,GN_PNT) Delete a node.
geom.node.start.edge(GN_PNT) Get the first edge connected to a node.
geom.node.start.index(GN_PNT) Index of the first edge connected to a node.
geom.node.typeid Get the node type number.
geom.poly.add.edge(GPOL_PNT,GE_PNT) Add an edge to a polygon.
geom.poly.add.node(GSET_PNT,GPOL_PNT<,GN_PNT><,VEC><,INT>) Add an edge via a node addition.
geom.poly.area(GPOL_PNT) Get the polygon area.
geom.poly.check(GPOL_PNT) Get the validity status.
geom.poly.close(GSET_PNT,GPOL_PNT) Close a polygon.
geom.poly.create(GSET_PNT) Create a polygon.
geom.poly.delete(GSET_PNT,GPOL_PNT) Delete a polygon.
geom.poly.edge(GPOL_PNT,INT) Get a polygon edge.
geom.poly.extra(GPOL_PNT,INT) Get/set polygon extra variable.
geom.poly.find(GSET_PNT,INT) Find a polygon.
geom.poly.group(GPOL_PNT<,STR>) Get/set polygon groups.
geom.poly.group.remove(GPOL_PNT,STR) Remove polygon groups.
geom.poly.id(GPOL_PNT) Get the polygon ID.
geom.poly.isgroup(GPOL_PNT,STR<,STR>) Query the existence of a group.
geom.poly.list(GSET_PNT) Get the polygon list of a geometry set.
geom.poly.near(GSET_PNT,VEC<,FLT>) Find the closest polygon to a point.
geom.poly.next.index(GPOL_PNT,INT) Get the index of the next edge of a polygon.
geom.poly.next.poly(GPOL_PNT,INT) Get the next polygon connected to an edge.
geom.poly.node(GPOL_PNT,INT) Get a node.
geom.poly.normal(GPOL_PNT<,INT>) Get the polygon normal.
geom.poly.pos(GPOL_PNT<,INT>) Get the polygon position.
geom.poly.remove(GSET_PNT,GPOL_PNT) Delete a polygon.
geom.poly.size(GPOL_PNT) Get the number of edges.
geom.poly.typeid Get the polygon type number.
geom.set.closest(GSET_PNT,VEC<,FLT>) Get closest node coordinate vector from the position supplied .
geom.set.create(STR) Creates a new geometry set with the provided name.
geom.set.delete(GSET_PNT) Delete a geometry set.
geom.set.edge.maxid(GSET_PNT) Get the maximum edge ID.
geom.set.edge.num(GSET_PNT) Get the number of edges.
geom.set.find(INT/STR) Find a geometry set.
geom.set.id(GSET_PNT) Get the geometry set ID.
geom.set.list Get the global geometry set list.
geom.set.maxid Get the maximum geometry set ID.
geom.set.name(GSET_PNT) Get the geometry set name.
geom.set.node.maxid(GSET_PNT) Get the maximum node ID.
geom.set.node.num(GSET_PNT) Get/set the number of nodes.
geom.set.num Get the number of geometry sets.
geom.set.poly.maxid(GSET_PNT) Get the maximum polygon ID.
geom.set.poly.num(GSET_PNT) Get the number of polygons.
geom.set.remove(GSET_PNT) Delete a geometry set.
geom.set.typeid Get the geometry set type number.
global.cycle Get the cycle/step number.
global.deterministic Get/set deterministic mode.
global.dim Get the program dimensionality.
global.fos Get the global factor of safety.
global.gravity(<INT>) Get/set the gravity.
global.step Get the cycle/step number.
global.threads Get/set the number of threads used during calculations.
global.timestep Get the global timestep.
global.title Get/set the job title of the model.
gp.accel(GP_PNT<,INT>) Get the acceleration vector for the gridpoint.
gp.biot.modulus(GP_PNT) Get/set the fluid Biot modulus.
gp.convergence(GP_PNT) Returns the gridpoint convergence value, defined as the ratio of...
gp.copy(GP_PNT,GP_PNT) Copies the gridpoint state information from the source to the...
gp.disp(GP_PNT<,INT>) Get/set the displacement vector for the gridpoint.
gp.disp.small(GP_PNT<,INT>) Get the small displacement vector for the gridpoint.
gp.dynamic.mul(GP_PNT) Get/set the dynamic stepping multiplier.
gp.extra(GP_PNT<,INT>) Get/set the extra variable at the index associated with the...
gp.find(INT) Get a pointer to the gridpoint with internally assigned ID...
gp.fix(GP_PNT<,INT>) Get/set a vector indicating gridpoint fixity.
gp.flow(GP_PNT) Get/set the unbalanced flow discharge at a gridpoint.
gp.fluid.load(GP_PNT) Get/set the additional fluid load.
gp.fluid.modulus(GP_PNT) Get/set the gridpoint fluid bulk modulus.
gp.fluid.modulus.confined(GP_PNT) Get/set the fluid flow confined modulus times nodal volume.
gp.fluid.tension(GP_PNT) Get/set the gridpoint fluid tension limit.
gp.fluid.unbal(GP_PNT) Get/set the the fluid out-of-balance flow; used in the fast...
gp.fluid.vol.inv(GP_PNT) Get the inverse of the fluid nodal volume.
gp.force.app(GP_PNT<,INT>) Get the total applied force at a gridpoint.
gp.force.load(GP_PNT<,INT>) Get/set the FISH applied force at a gridpoint.
gp.force.unbal(GP_PNT<,INT>) Get/set the unbalanced force at a gridpoint.
gp.group(GP_PNT<,STR>) Get/set the group name assigned to zone gridpoint gp in...
gp.group.remove(GP_PNT,STR) Remove the group s from zone gridpoint gp in all...
gp.head Get the first zone gridpoint in the list of all...
gp.id(GP_PNT) Get the zone gridpoint ID number, which is a unique...
gp.isgroup(GP_PNT,STR<,STR>) Check if the group name s is associated with the...
gp.link.index(GP_PNT) Get the index location of this gridpoint in the first...
gp.link.zone(GP_PNT) Get the first zone connected to this gridpoint.
gp.list Get the list of all gridpoints in the model.
gp.mass.add(GP_PNT<,INT>) Get/set the added mass vector for the gridpoint.
gp.mass.gravity(GP_PNT) Get the gravitational mass.
gp.mass.inertial(GP_PNT) Get the gridpoint inertial mass.
gp.maxid Get the maximum ID number assigned to any gridpoint in...
gp.near(VEC+) Get the gridpoint nearest v ; will return null if there...
gp.near.all(VEC+) Get the gridpoint nearest v ; will return null if there...
gp.near.live(VEC+,BOOL,BOOL,BOOL,STR) Get the gridpoint nearest point v .
gp.next(GP_PNT) Get the next gridpoint after gp in the list of...
gp.num Get the total number of gridpoints in the model.
gp.pos(GP_PNT<,INT>) Get/set the position of the gridpoint.
gp.pp(GP_PNT<,INT>) Get/set the gridpoint pore pressure.
gp.pp.fix(GP_PNT) Get/set the flag indicating that the pore pressure in the...
gp.ratio(GP_PNT) Get the local gridpoint mechanical convergence ratio.
gp.ratio.target(GP_PNT) Get/set the target local gridpoint mechanical convergence ratio.
gp.sat(GP_PNT) Get/set the fluid saturation.
gp.state.restore(GP_PNT) Restores all gridpoint state information from the currently open FISH ...
gp.state.save(GP_PNT) Saves all gridpoint state information to the currently open FISH ...
gp.stiff(GP_PNT) Get the accumulated gridpoint effective stiffness.
gp.temp(GP_PNT) Get/set the current gridpoint temperature.
gp.temp.change(GP_PNT) Get/set the temperature change of the grid point since the...
gp.temp.fix(GP_PNT) Get/set the flag indicating that temperature in this gridpoint is...
gp.temp.source(GP_PNT) Get/set the applied FISH temperature source at a gridpoint.
gp.typeid Get an identifier that uniquely determines the type of object.
gp.vel(GP_PNT<,INT>) Get/set the velocity vector for the gridpoint.
group.find(STR) [this does something] Search for a group with the name...
group.find.slot(STR) [this does something] Search for a slot with the name...
index(NUM/STR) Create a positive integer.
int(BOOL/NUM/STR) Create an integer.
interface.elem.area(INTERFACE_ELEM_PNT) Get the area of the interface element.
interface.elem.extra(INTERFACE_ELEM_PNT<,INT>) Get/set the value stored in the i th extra variable array...
interface.elem.head(INTERFACE_PNT) Following sentence doesn’t make sense.
interface.elem.host.face(INTERFACE_ELEM_PNT) Get the face ID number (1-6) to which the interface...
interface.elem.host.zone(INTERFACE_ELEM_PNT) Get the address of the zone to which the interface...
interface.elem.id(INTERFACE_ELEM_PNT) Get the ID number of the given interface element.
interface.elem.join(INTERFACE_ELEM_PNT,INT) Get the pointer to the adjacent interface element joined across...
interface.elem.list(INTERFACE_PNT) Get the list of all interface elements in the model.
interface.elem.next(INTERFACE_ELEM_PNT) Get the next interface element after ie in the list...
interface.elem.normal(INTERFACE_ELEM_PNT<,INT>) Get the normal vector for the interface element.
interface.elem.vertex(INTERFACE_ELEM_PNT,INT) Get the pointer of the vertex associated with the interface...
interface.find(INT) Get the interface with internally assigned ID number i .
interface.head Get the first interface in the list of all interfaces...
interface.id(INTERFACE_PNT) Get the interface ID number, a unique number assigned by...
interface.list Get the list of all interfaces in the model.
interface.name(INTERFACE_PNT) Get the interface with the assigned name s .
interface.next(INTERFACE_PNT) Get the next interface after it in the list of...
interface.node.area(INTERFACE_NODE_PNT) Get the characteristic area of the node (only valid after...
interface.node.disp(INTERFACE_NODE_PNT<,INT>) Get the displacement vector for the interface node.
interface.node.disp.shear(INTERFACE_NODE_PNT<,INT>) Get/set the relative shear displacement vector for the interface node.
interface.node.extra(INTERFACE_NODE_PNT<,INT>) Get/set the value stored in the i th extra variable array...
interface.node.find(INTERFACE_PNT,INT) Get the interface node with the given ID number.
interface.node.head(INTERFACE_PNT) Get the first interface node in the list of all...
interface.node.host.face(INTERFACE_NODE_PNT) Get the face ID (1-6) of the zone face to...
interface.node.host.weight(INTERFACE_NODE_PNT,INT) Get the weighting factor for vertex i (1-4) of the...
interface.node.host.zone(INTERFACE_NODE_PNT) Get the zone pointer to which the node is attached.
interface.node.id(INTERFACE_NODE_PNT) Get the ID number of the given interface node.
interface.node.list(INTERFACE_PNT) Get the list of all interface nodes in the model.
interface.node.next(INTERFACE_NODE_PNT) Get the next interface node after in in the list...
interface.node.normal(INTERFACE_NODE_PNT<,INT>) Get the normal vector for the interface node, which is...
interface.node.penetration(INTERFACE_NODE_PNT) Get interface node penetration with the contacting zone face (only...
interface.node.pos(INTERFACE_NODE_PNT<,INT>) Get/set the position vector for the interface node.
interface.node.pp(INTERFACE_NODE_PNT) Get the pore pressure of the node (only valid after...
interface.node.prop(INTERFACE_NODE_PNT,STR) Get/set the property identified by s of the interface node.
interface.node.slip(INTERFACE_NODE_PNT) Get/set the slip status (0-2) of the interface node: 0...
interface.node.stress.normal(INTERFACE_NODE_PNT) Get the normal stress at the node.
interface.node.stress.normal.add(INTERFACE_NODE_PNT) Get/set the additional normal stress.
interface.node.stress.shear(INTERFACE_NODE_PNT<,INT>) Get/set the shear stress vector for the interface node.
interface.node.target.face(INTERFACE_NODE_PNT) Get the face ID (1-6) of the zone face in...
interface.node.target.weight(INTERFACE_NODE_PNT,INT) Get the weighting factor for vertex i (1-4) of the...
interface.node.target.zone(INTERFACE_NODE_PNT) Get the zone pointer in contact with the node.
interface.node.tol(INTERFACE_NODE_PNT) Get/set the interface node contact tolerance, a dimensionless measure of how...
interface.node.vel(INTERFACE_NODE_PNT<,INT>) Get/set the velocity vector for the interface node.
io.dialog.in(STR<,STR>) Dialog to input a string.
io.dialog.message(STR,STR,INT) Make a message dialog.
io.dialog.notify(INT,INT,STR) General notification event.
io.in(STR) Get input from the console.
io.input(STR) Get input from the current input source.
io.out(ANY) Output a string.
itasca.attach.count Get the number of attaches.
itasca.attach.create Create a new attach.
itasca.attach.find Get the attach object with the given ID number.
itasca.attach.list Get a attach iterator object.
itasca.attach.maxid Get the maximum attach ID.
itasca.ball.cfd.count Get the number of CFD balls.
itasca.ball.cfd.find Get the CFD ball object with the given ID number.
itasca.ball.cfd.inbox Get a tuple of CCFD balls with extents intersecting a...
itasca.ball.cfd.list Get a CFD ball iterator object.
itasca.ball.cfd.maxid Get the maximum CFD ball ID.
itasca.ball.cfd.near Find the closest CFD ball to a point.
itasca.ball.count Get the number of balls.
itasca.ball.create Create a ball.
itasca.ball.energy Get the ball total energy contribution.
itasca.ball.find Get the ball object with the given ID number.
itasca.ball.inbox Get a tuple of balls with extents intersecting a box.
itasca.ball.list Get a ball iterator object.
itasca.ball.maxid Get the maximum ball ID.
itasca.ball.near Find the closest ball to a point.
itasca.ball.thermal.count Get the number of thermal balls.
itasca.ball.thermal.find Get the ball thermal object with the given ID number.
itasca.ball.thermal.inbox Get a tuple of thermal balls with extents intersecting a...
itasca.ball.thermal.list Get a ball thermal iterator object.
itasca.ball.thermal.maxid Get the maximum thermal ball ID.
itasca.ball.thermal.near Find the closest thermal ball to a point.
itasca.ballarray.create Create balls from two arrays.
itasca.ballarray.damp Get a numpy array of the ball local damping.
itasca.ballarray.density Get a numpy array of the ball density.
itasca.ballarray.disp Get a numpy array of the ball displacement.
itasca.ballarray.extra Get the ball extra data in the given slot as...
itasca.ballarray.fill_damp Fill an existing array with the ball local damping.
itasca.ballarray.fill_density Fill an existing array with the ball density.
itasca.ballarray.fill_disp Fill an existing array with the ball displacement.
itasca.ballarray.fill_force_app Fill an existing array with the ball applied force.
itasca.ballarray.fill_force_contact Fill an existing array with the ball contact force.
itasca.ballarray.fill_force_unbal Fill an existing array with the ball unbalanced force.
itasca.ballarray.fill_mass Fill an existing array with the inertial ball mass.
itasca.ballarray.fill_mass_real Fill an existing array with the real (gravitational) ball mass.
itasca.ballarray.fill_moment_app Fill an existing array with the ball applied moment.
itasca.ballarray.fill_moment_contact Fill an existing array with the ball contact moment.
itasca.ballarray.fill_moment_unbal Fill an existing array with the ball unbalanced moment.
itasca.ballarray.fill_pos Fill an existing array with the ball centroid location.
itasca.ballarray.fill_radius Fill an existing array with the ball radii.
itasca.ballarray.fill_rotation Fill an existing array with the ball orientation.
itasca.ballarray.fill_spin Fill an existing array with the ball angular velocity.
itasca.ballarray.fill_vel Fill an existing array with the ball velocity.
itasca.ballarray.force_app Get a numpy array of the ball applied force.
itasca.ballarray.force_contact Get a numpy array of the ball contact force.
itasca.ballarray.force_unbal Get a numpy array of the ball unbalanced force.
itasca.ballarray.ids Get the ball ids as an array.
itasca.ballarray.in_group Return ball group membership as a Boolean array.
itasca.ballarray.mass Get a numpy array of the inertial ball mass.
itasca.ballarray.mass_real Get a numpy array of the real (gravitational) ball mass.
itasca.ballarray.moment_app Get a numpy array of the ball applied moment.
itasca.ballarray.moment_contact Get a numpy array of the ball contact moment.
itasca.ballarray.moment_unbal Get a numpy array of the ball unbalanced moment.
itasca.ballarray.pos Get a numpy array of the ball centroid location.
itasca.ballarray.radius Get a numpy array of the ball radii.
itasca.ballarray.rotation Get a numpy array of the ball orientation.
itasca.ballarray.set_damp Set the ball local damping from an array.
itasca.ballarray.set_density Set the ball density from an array.
itasca.ballarray.set_disp Set the ball displacement from an array.
itasca.ballarray.set_extra Set the ball extra data in the given slot with...
itasca.ballarray.set_force_app Set the ball applied force from an array.
itasca.ballarray.set_force_contact Set the ball contact force from an array.
itasca.ballarray.set_group Set ball group from an array.
itasca.ballarray.set_moment_app Set the ball applied moment from an array.
itasca.ballarray.set_moment_contact Set the ball contact moment from an array.
itasca.ballarray.set_pos Set the ball centroid location from an array.
itasca.ballarray.set_radius Set the ball radii from an array.
itasca.ballarray.set_rotation Set the ball orientation from an array.
itasca.ballarray.set_spin Set the ball angular velocity from an array.
itasca.ballarray.set_vel Set the ball velocity from an array.
itasca.ballarray.spin Get a numpy array of the ball angular velocity.
itasca.ballarray.vel Get a numpy array of the ball velocity.
itasca.ballballarray.branch Get a numpy array of the contact branch vectors in...
itasca.ballballarray.extra Get the contact extra data in the given slot as...
itasca.ballballarray.fill_branch Fill an existing array with the contact branch vectors in...
itasca.ballballarray.fill_force_global Fill an existing array with the contact force in the...
itasca.ballballarray.fill_force_local Fill an existing array with the contact force in the...
itasca.ballballarray.fill_force_normal Fill an existing array with the contact normal force.
itasca.ballballarray.fill_force_shear Fill an existing array with the contact shear force magnitude.
itasca.ballballarray.fill_gap Fill an existing array with the contact gap.
itasca.ballballarray.fill_moment1_global Fill an existing array with the contact moment acting on...
itasca.ballballarray.fill_moment1_local Fill an existing array with the contact moment acting on...
itasca.ballballarray.fill_moment2_global Fill an existing array with the contact moment acting on...
itasca.ballballarray.fill_moment2_local Fill an existing array with the contact moment acting on...
itasca.ballballarray.fill_normal Fill an existing array with the contact normal.
itasca.ballballarray.fill_offset Fill an existing array with the contact offset.
itasca.ballballarray.fill_pos Fill an existing array with the contact position.
itasca.ballballarray.force_global Get a numpy array of the contact force in the...
itasca.ballballarray.force_local Get a numpy array of the contact force in the...
itasca.ballballarray.force_normal Get a numpy array of the contact normal force.
itasca.ballballarray.force_shear Get a numpy array of the contact shear force magnitude.
itasca.ballballarray.gap Get a numpy array of the contact gap.
itasca.ballballarray.ids Get the contact ids as an array.
itasca.ballballarray.in_group Return contact group membership as a Boolean array.
itasca.ballballarray.indices Get a numpy array of the indices of the balls...
itasca.ballballarray.moment1_global Get a numpy array of the contact moment acting on...
itasca.ballballarray.moment1_local Get a numpy array of the contact moment acting on...
itasca.ballballarray.moment2_global Get a numpy array of the contact moment acting on...
itasca.ballballarray.moment2_local Get a numpy array of the contact moment acting on...
itasca.ballballarray.normal Get a numpy array of the contact normal.
itasca.ballballarray.offset Get a numpy array of the contact offset.
itasca.ballballarray.pos Get a numpy array of the contact position.
itasca.ballballarray.set_extra Set the contact extra data in the given slot with...
itasca.ballballarray.set_group Set contact group from an array.
itasca.ballfacetarray.branch Get a numpy array of the contact branch vectors in...
itasca.ballfacetarray.extra Get the contact extra data in the given slot as...
itasca.ballfacetarray.fill_branch Fill an existing array with the contact branch vectors in...
itasca.ballfacetarray.fill_force_global Fill an existing array with the contact force in the...
itasca.ballfacetarray.fill_force_local Fill an existing array with the contact force in the...
itasca.ballfacetarray.fill_force_normal Fill an existing array with the contact normal force.
itasca.ballfacetarray.fill_force_shear Fill an existing array with the contact shear force magnitude.
itasca.ballfacetarray.fill_gap Fill an existing array with the contact gap.
itasca.ballfacetarray.fill_moment1_global Fill an existing array with the contact moment acting on...
itasca.ballfacetarray.fill_moment1_local Fill an existing array with the contact moment acting on...
itasca.ballfacetarray.fill_moment2_global Fill an existing array with the contact moment acting on...
itasca.ballfacetarray.fill_moment2_local Fill an existing array with the contact moment acting on...
itasca.ballfacetarray.fill_normal Fill an existing array with the contact normal.
itasca.ballfacetarray.fill_offset Fill an existing array with the contact offset.
itasca.ballfacetarray.fill_pos Fill an existing array with the contact position.
itasca.ballfacetarray.force_global Get a numpy array of the contact force in the...
itasca.ballfacetarray.force_local Get a numpy array of the contact force in the...
itasca.ballfacetarray.force_normal Get a numpy array of the contact normal force.
itasca.ballfacetarray.force_shear Get a numpy array of the contact shear force magnitude.
itasca.ballfacetarray.gap Get a numpy array of the contact gap.
itasca.ballfacetarray.ids Get the contact ids as an array.
itasca.ballfacetarray.in_group Return contact group membership as a Boolean array.
itasca.ballfacetarray.moment1_global Get a numpy array of the contact moment acting on...
itasca.ballfacetarray.moment1_local Get a numpy array of the contact moment acting on...
itasca.ballfacetarray.moment2_global Get a numpy array of the contact moment acting on...
itasca.ballfacetarray.moment2_local Get a numpy array of the contact moment acting on...
itasca.ballfacetarray.normal Get a numpy array of the contact normal.
itasca.ballfacetarray.offset Get a numpy array of the contact offset.
itasca.ballfacetarray.pos Get a numpy array of the contact position.
itasca.ballfacetarray.set_extra Set the contact extra data in the given slot with...
itasca.ballfacetarray.set_group Set contact group from an array.
itasca.ballpebblearray.branch Get a numpy array of the contact branch vectors in...
itasca.ballpebblearray.extra Get the contact extra data in the given slot as...
itasca.ballpebblearray.fill_branch Fill an existing array with the contact branch vectors in...
itasca.ballpebblearray.fill_force_global Fill an existing array with the contact force in the...
itasca.ballpebblearray.fill_force_local Fill an existing array with the contact force in the...
itasca.ballpebblearray.fill_force_normal Fill an existing array with the contact normal force.
itasca.ballpebblearray.fill_force_shear Fill an existing array with the contact shear force magnitude.
itasca.ballpebblearray.fill_gap Fill an existing array with the contact gap.
itasca.ballpebblearray.fill_moment1_global Fill an existing array with the contact moment acting on...
itasca.ballpebblearray.fill_moment1_local Fill an existing array with the contact moment acting on...
itasca.ballpebblearray.fill_moment2_global Fill an existing array with the contact moment acting on...
itasca.ballpebblearray.fill_moment2_local Fill an existing array with the contact moment acting on...
itasca.ballpebblearray.fill_normal Fill an existing array with the contact normal.
itasca.ballpebblearray.fill_offset Fill an existing array with the contact offset.
itasca.ballpebblearray.fill_pos Fill an existing array with the contact position.
itasca.ballpebblearray.force_global Get a numpy array of the contact force in the...
itasca.ballpebblearray.force_local Get a numpy array of the contact force in the...
itasca.ballpebblearray.force_normal Get a numpy array of the contact normal force.
itasca.ballpebblearray.force_shear Get a numpy array of the contact shear force magnitude.
itasca.ballpebblearray.gap Get a numpy array of the contact gap.
itasca.ballpebblearray.ids Get the contact ids as an array.
itasca.ballpebblearray.in_group Return contact group membership as a Boolean array.
itasca.ballpebblearray.moment1_global Get a numpy array of the contact moment acting on...
itasca.ballpebblearray.moment1_local Get a numpy array of the contact moment acting on...
itasca.ballpebblearray.moment2_global Get a numpy array of the contact moment acting on...
itasca.ballpebblearray.moment2_local Get a numpy array of the contact moment acting on...
itasca.ballpebblearray.normal Get a numpy array of the contact normal.
itasca.ballpebblearray.offset Get a numpy array of the contact offset.
itasca.ballpebblearray.pos Get a numpy array of the contact position.
itasca.ballpebblearray.set_extra Set the contact extra data in the given slot with...
itasca.ballpebblearray.set_group Set contact group from an array.
itasca.ballrblockarray.branch Get a numpy array of the contact branch vectors in...
itasca.ballrblockarray.extra Get the contact extra data in the given slot as...
itasca.ballrblockarray.fill_branch Fill an existing array with the contact branch vectors in...
itasca.ballrblockarray.fill_force_global Fill an existing array with the contact force in the...
itasca.ballrblockarray.fill_force_local Fill an existing array with the contact force in the...
itasca.ballrblockarray.fill_force_normal Fill an existing array with the contact normal force.
itasca.ballrblockarray.fill_force_shear Fill an existing array with the contact shear force magnitude.
itasca.ballrblockarray.fill_gap Fill an existing array with the contact gap.
itasca.ballrblockarray.fill_moment1_global Fill an existing array with the contact moment acting on...
itasca.ballrblockarray.fill_moment1_local Fill an existing array with the contact moment acting on...
itasca.ballrblockarray.fill_moment2_global Fill an existing array with the contact moment acting on...
itasca.ballrblockarray.fill_moment2_local Fill an existing array with the contact moment acting on...
itasca.ballrblockarray.fill_normal Fill an existing array with the contact normal.
itasca.ballrblockarray.fill_offset Fill an existing array with the contact offset.
itasca.ballrblockarray.fill_pos Fill an existing array with the contact position.
itasca.ballrblockarray.force_global Get a numpy array of the contact force in the...
itasca.ballrblockarray.force_local Get a numpy array of the contact force in the...
itasca.ballrblockarray.force_normal Get a numpy array of the contact normal force.
itasca.ballrblockarray.force_shear Get a numpy array of the contact shear force magnitude.
itasca.ballrblockarray.gap Get a numpy array of the contact gap.
itasca.ballrblockarray.ids Get the contact ids as an array.
itasca.ballrblockarray.in_group Return contact group membership as a Boolean array.
itasca.ballrblockarray.moment1_global Get a numpy array of the contact moment acting on...
itasca.ballrblockarray.moment1_local Get a numpy array of the contact moment acting on...
itasca.ballrblockarray.moment2_global Get a numpy array of the contact moment acting on...
itasca.ballrblockarray.moment2_local Get a numpy array of the contact moment acting on...
itasca.ballrblockarray.normal Get a numpy array of the contact normal.
itasca.ballrblockarray.offset Get a numpy array of the contact offset.
itasca.ballrblockarray.pos Get a numpy array of the contact position.
itasca.ballrblockarray.set_extra Set the contact extra data in the given slot with...
itasca.ballrblockarray.set_group Set contact group from an array.
itasca.cfdarray.create_mesh Create a cfd mesh.
itasca.cfdarray.density Get a numpy array of the cfd element fluid density.
itasca.cfdarray.drag Get a numpy array of the cfd element fluid drag...
itasca.cfdarray.extra Get the CFD element extra data in the given slot...
itasca.cfdarray.fill_pos Fill an existing array with the CFD element centroid location.
itasca.cfdarray.fill_pressure Fill an existing array with the cfd element fluid pressure.
itasca.cfdarray.ids Get the CFD element ids as an array.
itasca.cfdarray.in_group Return CFD element group membership as a Boolean array.
itasca.cfdarray.porosity Get a numpy array of the cfd element fluid porosity.
itasca.cfdarray.pos Get a numpy array of the CFD element centroid location.
itasca.cfdarray.pressure Get a numpy array of the cfd element fluid pressure.
itasca.cfdarray.pressure_gradient Get a numpy array of the cfd element fluid pressure...
itasca.cfdarray.set_density Set the cfd element density from an array.
itasca.cfdarray.set_drag Set the cfd element fluid drag force.
itasca.cfdarray.set_extra Set the CFD element extra data in the given slot...
itasca.cfdarray.set_group Set CFD element group from an array.
itasca.cfdarray.set_porosity Set the cfd element porosity from an array.
itasca.cfdarray.set_pressure Set the cfd element fluid pressure from an array.
itasca.cfdarray.set_pressure_gradient Set the cfd element fluid pressure gradient.
itasca.cfdarray.set_velocity Set the cfd element fluid velocity.
itasca.cfdarray.set_viscosity Set the cfd element viscosity from an array.
itasca.cfdarray.velocity Get a numpy array of the cfd element fluid velocity.
itasca.cfdarray.viscosity Get a numpy array of the cfd element fluid viscosity.
itasca.cfdarray.volume Get a numpy array of the cfd element volume.
itasca.clump.cfd.count Get the number of CFD clumps.
itasca.clump.cfd.find Get the CFD clump object with the given ID number.
itasca.clump.cfd.inbox Get a tuple of CFD clumps with extents intersecting a...
itasca.clump.cfd.list Get a CFD clump iterator object.
itasca.clump.cfd.maxid Get the maximum CFD clump ID.
itasca.clump.cfd.near Find the closest CFD clump to a point.
itasca.clump.cfd.pebble.count Get the number of CFD pebbles.
itasca.clump.cfd.pebble.find Get the CFD pebble object with the given ID number.
itasca.clump.cfd.pebble.inbox Get a tuple of CFD pebbles with extents intersecting a...
itasca.clump.cfd.pebble.list Get a CFD pebble iterator object.
itasca.clump.cfd.pebble.maxid Get the maximum CFD pebble ID.
itasca.clump.cfd.pebble.near Find the closest CFD pebble to a point.
itasca.clump.count Get the number of clumps.
itasca.clump.energies Get the clump total energy contribution as a dictionary with...
itasca.clump.energy Get the clump total energy contribution.
itasca.clump.find Get the Clump object with the given ID number.
itasca.clump.inbox Get a tuple of clumps with extents intersecting a box.
itasca.clump.list Get a clump iterator object.
itasca.clump.maxid Get the maximum clump ID.
itasca.clump.near Find the closest clump to a point.
itasca.clump.pebble.count Get the number of pebbles.
itasca.clump.pebble.find Get the Pebble object with the given ID number.
itasca.clump.pebble.inbox Get a tuple of pebbles with extents intersecting a box.
itasca.clump.pebble.list Get a pebble iterator object.
itasca.clump.pebble.maxid Get the maximum pebble ID.
itasca.clump.pebble.near Find the closest pebble to a point.
itasca.clump.template.count Get the number of clump templates.
itasca.clump.template.find Find a clump template by name.
itasca.clump.template.findpebble Find the clump template pebble with the given ID, in...
itasca.clump.template.list Get a clump template iterator object.
itasca.clump.template.make Make a clump template from a clump.
itasca.clump.template.maxid Get the maximum clump templates ID.
itasca.clump.thermal.count Get the number of thermal clumps.
itasca.clump.thermal.find Get the thermal clump object with the given ID number.
itasca.clump.thermal.inbox Get a tuple of thermal clumps with extents intersecting a...
itasca.clump.thermal.list Get a thermal clump iterator object.
itasca.clump.thermal.maxid Get the thermal maximum clump ID.
itasca.clump.thermal.near Find the closest thermal clump to a point.
itasca.clump.thermal.pebble.count Get the number of thermal pebbles.
itasca.clump.thermal.pebble.find Get the thermal pebble object with the given ID number.
itasca.clump.thermal.pebble.inbox Get a tuple of thermal pebbles with extents intersecting a...
itasca.clump.thermal.pebble.list Get a thermal pebble iterator object.
itasca.clump.thermal.pebble.maxid Get the maximum thermal pebble ID.
itasca.clump.thermal.pebble.near Find the closest thermal pebble to a point.
itasca.clumparray.damp Get a numpy array of the clump local damping.
itasca.clumparray.density Get a numpy array of the clump density.
itasca.clumparray.disp Get a numpy array of the clump displacement.
itasca.clumparray.extra Get the clump extra data in the given slot as...
itasca.clumparray.fill_damp Fill an existing array with the clump local damping.
itasca.clumparray.fill_density Fill an existing array with the clump density.
itasca.clumparray.fill_disp Fill an existing array with the clump displacement.
itasca.clumparray.fill_force_app Fill an existing array with the clump applied force.
itasca.clumparray.fill_force_contact Fill an existing array with the clump contact force.
itasca.clumparray.fill_force_unbal Fill an existing array with the clump unbalanced force.
itasca.clumparray.fill_mass Fill an existing array with the inertial clump mass.
itasca.clumparray.fill_mass_real Fill an existing array with the real (gravitational) clump mass.
itasca.clumparray.fill_moi_prin_real Fill an existing array with the clump principal moments of...
itasca.clumparray.fill_moment_app Fill an existing array with the clump applied moment.
itasca.clumparray.fill_moment_contact Fill an existing array with the clump contact moment.
itasca.clumparray.fill_moment_unbal Fill an existing array with the clump unbalanced moment.
itasca.clumparray.fill_pos Fill an existing array with the clump centroid location.
itasca.clumparray.fill_rotation Fill an existing array with the clump orientation.
itasca.clumparray.fill_spin Fill an existing array with the clump angular velocity.
itasca.clumparray.fill_vel Fill an existing array with the clump velocity.
itasca.clumparray.fill_vol Fill an existing array with the clump volume.
itasca.clumparray.force_app Get a numpy array of the clump applied force.
itasca.clumparray.force_contact Get a numpy array of the clump contact force.
itasca.clumparray.force_unbal Get a numpy array of the clump unbalanced force.
itasca.clumparray.ids Get the clump ids as an array.
itasca.clumparray.in_group Return clump group membership as a Boolean array.
itasca.clumparray.mass Get a numpy array of the inertial clump mass.
itasca.clumparray.mass_real Get a numpy array of the real (gravitational) clump mass.
itasca.clumparray.moi_prin_real Get a numpy array of the clump principal moments of...
itasca.clumparray.moment_app Get a numpy array of the clump applied moment.
itasca.clumparray.moment_contact Get a numpy array of the clump contact moment.
itasca.clumparray.moment_unbal Get a numpy array of the clump unbalanced moment.
itasca.clumparray.pos Get a numpy array of the clump centroid location.
itasca.clumparray.rotation Get a numpy array of the clump orientation.
itasca.clumparray.set_damp Set the clump local damping from an array.
itasca.clumparray.set_density Set the clump density from an array.
itasca.clumparray.set_disp Set the clump displacement from an array.
itasca.clumparray.set_extra Set the clump extra data in the given slot with...
itasca.clumparray.set_force_app Set the clump applied force from an array.
itasca.clumparray.set_force_contact Set the clump contact force from an array.
itasca.clumparray.set_group Set clump group from an array.
itasca.clumparray.set_moi_prin_real Set the clump principal moments of inertia from an array.
itasca.clumparray.set_moment_app Set the clump applied moment from an array.
itasca.clumparray.set_moment_contact Set the clump contact moment from an array.
itasca.clumparray.set_pos Set the clump centroid location from an array.
itasca.clumparray.set_rotation Set the clump orientation from an array.
itasca.clumparray.set_spin Set the clump angular velocity from an array.
itasca.clumparray.set_vel Set the clump velocity from an array.
itasca.clumparray.set_vol Set the clump volume from an array.
itasca.clumparray.spin Get a numpy array of the clump angular velocity.
itasca.clumparray.vel Get a numpy array of the clump velocity.
itasca.clumparray.vol Get a numpy array of the clump volume.
itasca.command Issue a command.
itasca.contact.count Get the number of contacts.
itasca.contact.energy Get energy values accumulated over contacts.
itasca.contact.find Get the contact of the given type, the second argument...
itasca.contact.list Get a contact iterator object.
itasca.cycle Get the cycle number.
itasca.deterministic Get the deterministic mode.
itasca.dfn.center_density Get the fracture center density.
itasca.dfn.count Get the number of dfns.
itasca.dfn.create Create an empty dfn with optional name dfn_name.
itasca.dfn.density Get the fracture mass density.
itasca.dfn.find Get the dfn object with the given ID number or...
itasca.dfn.fracture.count Get the number of fractures.
itasca.dfn.fracture.find Get the fracture object with the given ID number.
itasca.dfn.fracture.inbox Get a tuple of fractures with extents intersecting a box.
itasca.dfn.fracture.list Get a Fracture iterator object.
itasca.dfn.fracture.maxid Get the maximum fracture ID.
itasca.dfn.fracture.near Find the closest fracture to a point.
itasca.dfn.inter.count Get the number of intersections.
itasca.dfn.inter.find Get the intersection object with the given ID number.
itasca.dfn.inter.list Get an intersection iterator object.
itasca.dfn.inter.maxid Get the maximum intersection ID.
itasca.dfn.list Get a dfn iterator object.
itasca.dfn.maxid Get the maximum dfn ID.
itasca.dfn.p10 Get the P10, or the fracture density per unit length,...
itasca.dfn.percolation Get the fracture percolation.
itasca.dfn.setinter.count Get the number of intersection sets.
itasca.dfn.setinter.find Get the intersection set object with the given ID number.
itasca.dfn.setinter.list Get an intersection set iterator object.
itasca.dfn.setinter.maxid Get the maximum intersection set ID.
itasca.dfn.template.count Get the number of templates.
itasca.dfn.template.find Get the template object with the given ID number.
itasca.dfn.template.list Get a template iterator object.
itasca.dfn.template.maxid Get the maximum template ID.
itasca.dfn.vertex.count Get the number of verticess.
itasca.dfn.vertex.find Get the vertex object with the given ID number.
itasca.dfn.vertex.maxid Get the maximum vertex ID.
itasca.dim Get the code dimensionality.
itasca.dockWidget Return a pointer to an empty QDockWidget with the specified...
itasca.domain_condition Get the domain condition given a domain direction.
itasca.domain_max Get domain upper bound (vector).
itasca.domain_max_x Get the x-component of domain upper bound.
itasca.domain_max_y Get the y-component of domain upper bound.
itasca.domain_max_z Get the z-component of domain upper bound.
itasca.domain_min Get domain lower bound (vector).
itasca.domain_min_x Get the x-component of domain lower bound.
itasca.domain_min_y Get the y-component of domain lower bound.
itasca.domain_min_z Get the z-component of domain lower bound.
itasca.domain_srate Get domain strain rate (vector).
itasca.domain_srate_x Get the x-component of domain strain rate.
itasca.domain_srate_y Get the y-component of domain strain rate.
itasca.domain_srate_z Get the z-component of domain strain rate.
itasca.domain_strain_rate Get the domain strain-rate tensor.
itasca.element.cfd.age Get the fluid coupling time.
itasca.element.cfd.count Get the number of CFD elements.
itasca.element.cfd.face_count Get the number of faces per CFD element.
itasca.element.cfd.find Get the CFD element object with the given ID number.
itasca.element.cfd.inbox Get a tuple of CFD elements with extents intersecting a...
itasca.element.cfd.list Get a CFD element iterator object.
itasca.element.cfd.maxid Get the maximum CFD element ID.
itasca.element.cfd.near Find the closest CFD element to a point.
itasca.element.cfd.node_count Get the number of nodes per CFD element.
itasca.facetarray.conveyor Get a numpy array of the facet conveyor velocity.
itasca.facetarray.extra Get the facet extra data in the given slot as...
itasca.facetarray.fill_conveyor Fill an existing array with the facet conveyor velocity.
itasca.facetarray.fill_normal Fill an existing array with the facet normal.
itasca.facetarray.fill_pos Fill an existing array with the facet location.
itasca.facetarray.ids Get the facet ids as an array.
itasca.facetarray.in_group Return facet group membership as a Boolean array.
itasca.facetarray.normal Get a numpy array of the facet normal.
itasca.facetarray.pos Get a numpy array of the facet location.
itasca.facetarray.set_conveyor Set the facet conveyor velocity from an array.
itasca.facetarray.set_extra Set the facet extra data in the given slot with...
itasca.facetarray.set_group Set facet group from an array.
itasca.fish.call_function Call FISH function func return result.
itasca.fish.get Return value of the FISH variable var.
itasca.fish.has Return True if the FISH variable var is defined, False...
itasca.fish.is_function Return True if the FISH variable var is defined and...
itasca.fish.set Set the FISH variable var to value.
itasca.fos Get the factor of safety.
itasca.gravity Get the gravity (vector).
itasca.gravity_x Get the x-component of the gravity.
itasca.gravity_y Get the y-component of the gravity.
itasca.gravity_z Get the z-component of the gravity.
itasca.gridpoint.count Get the number of gridpoints.
itasca.gridpoint.find Get the gridpoint object with the given ID number.
itasca.gridpoint.list Get a gridpoint iterator object.
itasca.gridpoint.maxid Get the maximum gridpoint ID.
itasca.gridpoint.near Find the closest gridpoint to a point.
itasca.gridpointarray.accel Get a NumPy array of the acceleration of each gridpoint.
itasca.gridpointarray.disp Get a numpy array of the gridpoint displacement.
itasca.gridpointarray.extra Get the gridpoint extra data in the given slot as...
itasca.gridpointarray.fill_disp Fill an existing array with the gridpoint displacement.
itasca.gridpointarray.fill_force_app Fill an existing array with the gridpoint applied force.
itasca.gridpointarray.fill_force_unbal Fill an existing array with the gridpoint unbalanced force.
itasca.gridpointarray.fill_pos Fill an existing array with the gridpoint centroid location.
itasca.gridpointarray.fill_vel Fill an existing array with the gridpoint velocity.
itasca.gridpointarray.fixity Get a NumPy array of the gridpoint fixity condition.
itasca.gridpointarray.flow Get a numpy array of the unbalanced flow discharge at...
itasca.gridpointarray.force_app Get a numpy array of the gridpoint applied force.
itasca.gridpointarray.force_unbal Get a numpy array of the gridpoint unbalanced force.
itasca.gridpointarray.ids Get the gridpoint ids as an array.
itasca.gridpointarray.live_mechanical Return an array of True/False values for each gridpoint, a...
itasca.gridpointarray.pos Get a numpy array of the gridpoint centroid location.
itasca.gridpointarray.set_disp Set the gridpoint displacement from an array.
itasca.gridpointarray.set_extra Set the gridpoint extra data in the given slot with...
itasca.gridpointarray.set_fixity Set the gridpoint fixity condition.
itasca.gridpointarray.set_flow Set the unbalanced flow discharge at each gridpoint with a...
itasca.gridpointarray.set_force_app Set the gridpoint applied force from an array.
itasca.gridpointarray.set_pos Set the gridpoint centroid location from an array.
itasca.gridpointarray.set_vel Set the gridpoint velocity from an array.
itasca.gridpointarray.stiffness Get a NumPy array of the accumulated gridpoint effective stiffness.
itasca.gridpointarray.vel Get a numpy array of the gridpoint velocity.
itasca.gridpointarray.zones Return the indices of the zones which each gridpoint is...
itasca.mainWindow Get the string pointer address of the QMainWindow.
itasca.measure.count Get the number of measures.
itasca.measure.find Get the measure object with the given ID number.
itasca.measure.list Get a measure iterator object.
itasca.measure.maxid Get the maximum measure ID.
itasca.mech_age Return the accumulated mechanical time.
itasca.pebblearray.extra Get the pebble extra data in the given slot as...
itasca.pebblearray.fill_pos Fill an existing array with the pebble location.
itasca.pebblearray.fill_radius Fill an existing array with the pebble radii.
itasca.pebblearray.fill_vel Fill an existing array with the pebble velocity.
itasca.pebblearray.ids Get the pebble ids as an array.
itasca.pebblearray.in_group Return pebble group membership as a Boolean array.
itasca.pebblearray.pos Get a numpy array of the pebble location.
itasca.pebblearray.radius Get a numpy array of the pebble radii.
itasca.pebblearray.set_extra Set the pebble extra data in the given slot with...
itasca.pebblearray.set_group Set pebble group from an array.
itasca.pebblearray.set_pos Set the pebble location from an array.
itasca.pebblearray.set_radius Set the pebble radii from an array.
itasca.pebblearray.vel Get a numpy array of the pebble velocity.
itasca.pebblefacetarray.branch Get a numpy array of the contact branch vectors in...
itasca.pebblefacetarray.extra Get the contact extra data in the given slot as...
itasca.pebblefacetarray.fill_branch Fill an existing array with the contact branch vectors in...
itasca.pebblefacetarray.fill_force_global Fill an existing array with the contact force in the...
itasca.pebblefacetarray.fill_force_local Fill an existing array with the contact force in the...
itasca.pebblefacetarray.fill_force_normal Fill an existing array with the contact normal force.
itasca.pebblefacetarray.fill_force_shear Fill an existing array with the contact shear force magnitude.
itasca.pebblefacetarray.fill_gap Fill an existing array with the contact gap.
itasca.pebblefacetarray.fill_moment1_global Fill an existing array with the contact moment acting on...
itasca.pebblefacetarray.fill_moment1_local Fill an existing array with the contact moment acting on...
itasca.pebblefacetarray.fill_moment2_global Fill an existing array with the contact moment acting on...
itasca.pebblefacetarray.fill_moment2_local Fill an existing array with the contact moment acting on...
itasca.pebblefacetarray.fill_normal Fill an existing array with the contact normal.
itasca.pebblefacetarray.fill_offset Fill an existing array with the contact offset.
itasca.pebblefacetarray.fill_pos Fill an existing array with the contact position.
itasca.pebblefacetarray.force_global Get a numpy array of the contact force in the...
itasca.pebblefacetarray.force_local Get a numpy array of the contact force in the...
itasca.pebblefacetarray.force_normal Get a numpy array of the contact normal force.
itasca.pebblefacetarray.force_shear Get a numpy array of the contact shear force magnitude.
itasca.pebblefacetarray.gap Get a numpy array of the contact gap.
itasca.pebblefacetarray.ids Get the contact ids as an array.
itasca.pebblefacetarray.in_group Return contact group membership as a Boolean array.
itasca.pebblefacetarray.moment1_global Get a numpy array of the contact moment acting on...
itasca.pebblefacetarray.moment1_local Get a numpy array of the contact moment acting on...
itasca.pebblefacetarray.moment2_global Get a numpy array of the contact moment acting on...
itasca.pebblefacetarray.moment2_local Get a numpy array of the contact moment acting on...
itasca.pebblefacetarray.normal Get a numpy array of the contact normal.
itasca.pebblefacetarray.offset Get a numpy array of the contact offset.
itasca.pebblefacetarray.pos Get a numpy array of the contact position.
itasca.pebblefacetarray.set_extra Set the contact extra data in the given slot with...
itasca.pebblefacetarray.set_group Set contact group from an array.
itasca.pebblepebblearray.branch Get a numpy array of the contact branch vectors in...
itasca.pebblepebblearray.extra Get the contact extra data in the given slot as...
itasca.pebblepebblearray.fill_branch Fill an existing array with the contact branch vectors in...
itasca.pebblepebblearray.fill_force_global Fill an existing array with the contact force in the...
itasca.pebblepebblearray.fill_force_local Fill an existing array with the contact force in the...
itasca.pebblepebblearray.fill_force_normal Fill an existing array with the contact normal force.
itasca.pebblepebblearray.fill_force_shear Fill an existing array with the contact shear force magnitude.
itasca.pebblepebblearray.fill_gap Fill an existing array with the contact gap.
itasca.pebblepebblearray.fill_moment1_global Fill an existing array with the contact moment acting on...
itasca.pebblepebblearray.fill_moment1_local Fill an existing array with the contact moment acting on...
itasca.pebblepebblearray.fill_moment2_global Fill an existing array with the contact moment acting on...
itasca.pebblepebblearray.fill_moment2_local Fill an existing array with the contact moment acting on...
itasca.pebblepebblearray.fill_normal Fill an existing array with the contact normal.
itasca.pebblepebblearray.fill_offset Fill an existing array with the contact offset.
itasca.pebblepebblearray.fill_pos Fill an existing array with the contact position.
itasca.pebblepebblearray.force_global Get a numpy array of the contact force in the...
itasca.pebblepebblearray.force_local Get a numpy array of the contact force in the...
itasca.pebblepebblearray.force_normal Get a numpy array of the contact normal force.
itasca.pebblepebblearray.force_shear Get a numpy array of the contact shear force magnitude.
itasca.pebblepebblearray.gap Get a numpy array of the contact gap.
itasca.pebblepebblearray.ids Get the contact ids as an array.
itasca.pebblepebblearray.in_group Return contact group membership as a Boolean array.
itasca.pebblepebblearray.moment1_global Get a numpy array of the contact moment acting on...
itasca.pebblepebblearray.moment1_local Get a numpy array of the contact moment acting on...
itasca.pebblepebblearray.moment2_global Get a numpy array of the contact moment acting on...
itasca.pebblepebblearray.moment2_local Get a numpy array of the contact moment acting on...
itasca.pebblepebblearray.normal Get a numpy array of the contact normal.
itasca.pebblepebblearray.offset Get a numpy array of the contact offset.
itasca.pebblepebblearray.pos Get a numpy array of the contact position.
itasca.pebblepebblearray.set_extra Set the contact extra data in the given slot with...
itasca.pebblepebblearray.set_group Set contact group from an array.
itasca.pebblerblockarray.branch Get a numpy array of the contact branch vectors in...
itasca.pebblerblockarray.extra Get the contact extra data in the given slot as...
itasca.pebblerblockarray.fill_branch Fill an existing array with the contact branch vectors in...
itasca.pebblerblockarray.fill_force_global Fill an existing array with the contact force in the...
itasca.pebblerblockarray.fill_force_local Fill an existing array with the contact force in the...
itasca.pebblerblockarray.fill_force_normal Fill an existing array with the contact normal force.
itasca.pebblerblockarray.fill_force_shear Fill an existing array with the contact shear force magnitude.
itasca.pebblerblockarray.fill_gap Fill an existing array with the contact gap.
itasca.pebblerblockarray.fill_moment1_global Fill an existing array with the contact moment acting on...
itasca.pebblerblockarray.fill_moment1_local Fill an existing array with the contact moment acting on...
itasca.pebblerblockarray.fill_moment2_global Fill an existing array with the contact moment acting on...
itasca.pebblerblockarray.fill_moment2_local Fill an existing array with the contact moment acting on...
itasca.pebblerblockarray.fill_normal Fill an existing array with the contact normal.
itasca.pebblerblockarray.fill_offset Fill an existing array with the contact offset.
itasca.pebblerblockarray.fill_pos Fill an existing array with the contact position.
itasca.pebblerblockarray.force_global Get a numpy array of the contact force in the...
itasca.pebblerblockarray.force_local Get a numpy array of the contact force in the...
itasca.pebblerblockarray.force_normal Get a numpy array of the contact normal force.
itasca.pebblerblockarray.force_shear Get a numpy array of the contact shear force magnitude.
itasca.pebblerblockarray.gap Get a numpy array of the contact gap.
itasca.pebblerblockarray.ids Get the contact ids as an array.
itasca.pebblerblockarray.in_group Return contact group membership as a Boolean array.
itasca.pebblerblockarray.moment1_global Get a numpy array of the contact moment acting on...
itasca.pebblerblockarray.moment1_local Get a numpy array of the contact moment acting on...
itasca.pebblerblockarray.moment2_global Get a numpy array of the contact moment acting on...
itasca.pebblerblockarray.moment2_local Get a numpy array of the contact moment acting on...
itasca.pebblerblockarray.normal Get a numpy array of the contact normal.
itasca.pebblerblockarray.offset Get a numpy array of the contact offset.
itasca.pebblerblockarray.pos Get a numpy array of the contact position.
itasca.pebblerblockarray.set_extra Set the contact extra data in the given slot with...
itasca.pebblerblockarray.set_group Set contact group from an array.
itasca.rblock.count Get the number of rblocks.
itasca.rblock.energies Get the rblock total energy contribution as a dictionary with...
itasca.rblock.energy Get the rblock total energy contribution.
itasca.rblock.find Get the RBlock object with the given ID number.
itasca.rblock.inbox Get a tuple of rblocks with extents intersecting a box.
itasca.rblock.list Get a rblock iterator object.
itasca.rblock.maxid Get the maximum rblock ID.
itasca.rblock.near Find the closest rblock to a point.
itasca.rblock.template.count Get the number of rblock templates.
itasca.rblock.template.find Find a rblock template by name.
itasca.rblock.template.findpebble Find the rblock template pebble with the given ID, in...
itasca.rblock.template.list Get a rblock template iterator object.
itasca.rblock.template.maxid Get the maximum rblock templates ID.
itasca.rblockarray.damp Get a numpy array of the rblock local damping.
itasca.rblockarray.density Get a numpy array of the rblock density.
itasca.rblockarray.disp Get a numpy array of the rblock displacement.
itasca.rblockarray.extra Get the rblock extra data in the given slot as...
itasca.rblockarray.fill_damp Fill an existing array with the rblock local damping.
itasca.rblockarray.fill_density Fill an existing array with the rblock density.
itasca.rblockarray.fill_disp Fill an existing array with the rblock displacement.
itasca.rblockarray.fill_force_app Fill an existing array with the rblock applied force.
itasca.rblockarray.fill_force_contact Fill an existing array with the rblock contact force.
itasca.rblockarray.fill_force_unbal Fill an existing array with the rblock unbalanced force.
itasca.rblockarray.fill_mass Fill an existing array with the inertial rblock mass.
itasca.rblockarray.fill_mass_real Fill an existing array with the real (gravitational) rblock mass.
itasca.rblockarray.fill_moi_prin_real Fill an existing array with the rblock principal moments of...
itasca.rblockarray.fill_moment_app Fill an existing array with the rblock applied moment.
itasca.rblockarray.fill_moment_contact Fill an existing array with the rblock contact moment.
itasca.rblockarray.fill_moment_unbal Fill an existing array with the rblock unbalanced moment.
itasca.rblockarray.fill_pos Fill an existing array with the rblock centroid location.
itasca.rblockarray.fill_rotation Fill an existing array with the rblock orientation.
itasca.rblockarray.fill_spin Fill an existing array with the rblock angular velocity.
itasca.rblockarray.fill_vel Fill an existing array with the rblock velocity.
itasca.rblockarray.fill_vol Fill an existing array with the rblock volume.
itasca.rblockarray.force_app Get a numpy array of the rblock applied force.
itasca.rblockarray.force_contact Get a numpy array of the rblock contact force.
itasca.rblockarray.force_unbal Get a numpy array of the rblock unbalanced force.
itasca.rblockarray.ids Get the rblock ids as an array.
itasca.rblockarray.in_group Return rblock group membership as a Boolean array.
itasca.rblockarray.mass Get a numpy array of the inertial rblock mass.
itasca.rblockarray.mass_real Get a numpy array of the real (gravitational) rblock mass.
itasca.rblockarray.moi_prin_real Get a numpy array of the rblock principal moments of...
itasca.rblockarray.moment_app Get a numpy array of the rblock applied moment.
itasca.rblockarray.moment_contact Get a numpy array of the rblock contact moment.
itasca.rblockarray.moment_unbal Get a numpy array of the rblock unbalanced moment.
itasca.rblockarray.pos Get a numpy array of the rblock centroid location.
itasca.rblockarray.rotation Get a numpy array of the rblock orientation.
itasca.rblockarray.set_damp Set the rblock local damping from an array.
itasca.rblockarray.set_density Set the rblock density from an array.
itasca.rblockarray.set_disp Set the rblock displacement from an array.
itasca.rblockarray.set_extra Set the rblock extra data in the given slot with...
itasca.rblockarray.set_force_app Set the rblock applied force from an array.
itasca.rblockarray.set_force_contact Set the rblock contact force from an array.
itasca.rblockarray.set_group Set rblock group from an array.
itasca.rblockarray.set_moi_prin_real Set the rblock principal moments of inertia from an array.
itasca.rblockarray.set_moment_app Set the rblock applied moment from an array.
itasca.rblockarray.set_moment_contact Set the rblock contact moment from an array.
itasca.rblockarray.set_pos Set the rblock centroid location from an array.
itasca.rblockarray.set_rotation Set the rblock orientation from an array.
itasca.rblockarray.set_spin Set the rblock angular velocity from an array.
itasca.rblockarray.set_vel Set the rblock velocity from an array.
itasca.rblockarray.set_vol Set the rblock volume from an array.
itasca.rblockarray.spin Get a numpy array of the rblock angular velocity.
itasca.rblockarray.vel Get a numpy array of the rblock velocity.
itasca.rblockarray.vol Get a numpy array of the rblock volume.
itasca.rblockfacetarray.branch Get a numpy array of the contact branch vectors in...
itasca.rblockfacetarray.extra Get the contact extra data in the given slot as...
itasca.rblockfacetarray.fill_branch Fill an existing array with the contact branch vectors in...
itasca.rblockfacetarray.fill_force_global Fill an existing array with the contact force in the...
itasca.rblockfacetarray.fill_force_local Fill an existing array with the contact force in the...
itasca.rblockfacetarray.fill_force_normal Fill an existing array with the contact normal force.
itasca.rblockfacetarray.fill_force_shear Fill an existing array with the contact shear force magnitude.
itasca.rblockfacetarray.fill_gap Fill an existing array with the contact gap.
itasca.rblockfacetarray.fill_moment1_global Fill an existing array with the contact moment acting on...
itasca.rblockfacetarray.fill_moment1_local Fill an existing array with the contact moment acting on...
itasca.rblockfacetarray.fill_moment2_global Fill an existing array with the contact moment acting on...
itasca.rblockfacetarray.fill_moment2_local Fill an existing array with the contact moment acting on...
itasca.rblockfacetarray.fill_normal Fill an existing array with the contact normal.
itasca.rblockfacetarray.fill_offset Fill an existing array with the contact offset.
itasca.rblockfacetarray.fill_pos Fill an existing array with the contact position.
itasca.rblockfacetarray.force_global Get a numpy array of the contact force in the...
itasca.rblockfacetarray.force_local Get a numpy array of the contact force in the...
itasca.rblockfacetarray.force_normal Get a numpy array of the contact normal force.
itasca.rblockfacetarray.force_shear Get a numpy array of the contact shear force magnitude.
itasca.rblockfacetarray.gap Get a numpy array of the contact gap.
itasca.rblockfacetarray.ids Get the contact ids as an array.
itasca.rblockfacetarray.in_group Return contact group membership as a Boolean array.
itasca.rblockfacetarray.moment1_global Get a numpy array of the contact moment acting on...
itasca.rblockfacetarray.moment1_local Get a numpy array of the contact moment acting on...
itasca.rblockfacetarray.moment2_global Get a numpy array of the contact moment acting on...
itasca.rblockfacetarray.moment2_local Get a numpy array of the contact moment acting on...
itasca.rblockfacetarray.normal Get a numpy array of the contact normal.
itasca.rblockfacetarray.offset Get a numpy array of the contact offset.
itasca.rblockfacetarray.pos Get a numpy array of the contact position.
itasca.rblockfacetarray.set_extra Set the contact extra data in the given slot with...
itasca.rblockfacetarray.set_group Set contact group from an array.
itasca.rblockrblockarray.branch Get a numpy array of the contact branch vectors in...
itasca.rblockrblockarray.extra Get the contact extra data in the given slot as...
itasca.rblockrblockarray.fill_branch Fill an existing array with the contact branch vectors in...
itasca.rblockrblockarray.fill_force_global Fill an existing array with the contact force in the...
itasca.rblockrblockarray.fill_force_local Fill an existing array with the contact force in the...
itasca.rblockrblockarray.fill_force_normal Fill an existing array with the contact normal force.
itasca.rblockrblockarray.fill_force_shear Fill an existing array with the contact shear force magnitude.
itasca.rblockrblockarray.fill_gap Fill an existing array with the contact gap.
itasca.rblockrblockarray.fill_moment1_global Fill an existing array with the contact moment acting on...
itasca.rblockrblockarray.fill_moment1_local Fill an existing array with the contact moment acting on...
itasca.rblockrblockarray.fill_moment2_global Fill an existing array with the contact moment acting on...
itasca.rblockrblockarray.fill_moment2_local Fill an existing array with the contact moment acting on...
itasca.rblockrblockarray.fill_normal Fill an existing array with the contact normal.
itasca.rblockrblockarray.fill_offset Fill an existing array with the contact offset.
itasca.rblockrblockarray.fill_pos Fill an existing array with the contact position.
itasca.rblockrblockarray.force_global Get a numpy array of the contact force in the...
itasca.rblockrblockarray.force_local Get a numpy array of the contact force in the...
itasca.rblockrblockarray.force_normal Get a numpy array of the contact normal force.
itasca.rblockrblockarray.force_shear Get a numpy array of the contact shear force magnitude.
itasca.rblockrblockarray.gap Get a numpy array of the contact gap.
itasca.rblockrblockarray.ids Get the contact ids as an array.
itasca.rblockrblockarray.in_group Return contact group membership as a Boolean array.
itasca.rblockrblockarray.indices Get a numpy array of the indices of the rblocks...
itasca.rblockrblockarray.moment1_global Get a numpy array of the contact moment acting on...
itasca.rblockrblockarray.moment1_local Get a numpy array of the contact moment acting on...
itasca.rblockrblockarray.moment2_global Get a numpy array of the contact moment acting on...
itasca.rblockrblockarray.moment2_local Get a numpy array of the contact moment acting on...
itasca.rblockrblockarray.normal Get a numpy array of the contact normal.
itasca.rblockrblockarray.offset Get a numpy array of the contact offset.
itasca.rblockrblockarray.pos Get a numpy array of the contact position.
itasca.rblockrblockarray.set_extra Set the contact extra data in the given slot with...
itasca.rblockrblockarray.set_group Set contact group from an array.
itasca.remove_callback Remove a python function from the callback system.
itasca.set_callback Register a python function to be called during the cycling...
itasca.set_deterministic Set the deterministic mode.
itasca.set_domain_condition Set the domain condition for a given domain direction.
itasca.set_domain_max Set domain upper bound (vector).
itasca.set_domain_max_x Set the x-component of domain upper bound.
itasca.set_domain_max_y Set the y-component of domain upper bound.
itasca.set_domain_max_z Set the y-component of domain upper bound.
itasca.set_domain_min Set domain lower bound (vector).
itasca.set_domain_min_x Set the x-component of domain lower bound.
itasca.set_domain_min_y Set the y-component of domain lower bound.
itasca.set_domain_min_z Set the y-component of domain lower bound.
itasca.set_domain_srate Set domain strain rate (vector).
itasca.set_domain_srate_x Set the x-component of domain strain rate.
itasca.set_domain_srate_y Set the y-component of domain strain rate.
itasca.set_domain_srate_z Set the y-component of domain strain rate.
itasca.set_domain_strain_rate Set the domain strain-rate tensor.
itasca.set_gravity Set the gravity (vector).
itasca.set_gravity_x Set the x-component of the gravity.
itasca.set_gravity_y Set the y-component of the gravity.
itasca.set_gravity_z Set the y-component of the gravity.
itasca.set_threads Set the number of threads.
itasca.state_callbacks Return a dictionary of the currently defined Python new, save...
itasca.structure.count Get the number of structural elements.
itasca.structure.find Get the structural element object with the given ID number.
itasca.structure.link.count Get the number of structural element link.
itasca.structure.link.find Get the structural element link object with the given ID...
itasca.structure.link.list Get the structural element link iterator object.
itasca.structure.link.maxid Get the maximum structural element link ID.
itasca.structure.list Get the structural element iterator object.
itasca.structure.maxid Get the maximum structural element ID.
itasca.structure.mech_convergence Get the maximum convergence value (local ratio divided by target...
itasca.structure.mech_ratio_avg Get the average convergence ratio of all structural nodes in...
itasca.structure.mech_ratio_local Get the maximum local convergence ratio of all structural nodes...
itasca.structure.mech_ratio_max Get the ratio of maximum unbalanced force to average applied...
itasca.structure.near find the closest structural element to a point.
itasca.structure.node.count Get the number of structural element node.
itasca.structure.node.find Get the structural element node object with the given ID...
itasca.structure.node.list Get the structural element node iterator object.
itasca.structure.node.maxid Get the maximum structural element node ID.
itasca.structure.node.near Find the closest structural element node to a point.
itasca.template.count Get the number of templates.
itasca.template.find Get the template object with the given ID number.
itasca.template.list Get a template iterator object.
itasca.template.maxid Get the maximum template ID.
itasca.threads Get the number of threads.
itasca.timestep Get the global timestep.
itasca.vertexarray.fill_pos Fill an existing array with the vertex location.
itasca.vertexarray.fill_vel Fill an existing array with the vertex velocity.
itasca.vertexarray.ids Get the vertex ids as an array.
itasca.vertexarray.pos Get a numpy array of the vertex location.
itasca.vertexarray.set_pos Set the vertex location from an array.
itasca.vertexarray.set_vel Set the vertex velocity from an array.
itasca.vertexarray.vel Get a numpy array of the vertex velocity.
itasca.wall.count Get the number of walls.
itasca.wall.energy Get the wall total energy contribution.
itasca.wall.facet.count Get the number of facets.
itasca.wall.facet.find Get the facet object with the given ID number.
itasca.wall.facet.inbox Get facets with extents intersecting a box.
itasca.wall.facet.list Get a wall_facet iterator object.
itasca.wall.facet.maxid Get the maximum facet ID.
itasca.wall.facet.near Find the closest facet to a point.
itasca.wall.find Get the Wall object with the given ID number or...
itasca.wall.inbox Get walls with extents intersecting a box.
itasca.wall.list Get a wall iterator object.
itasca.wall.maxid Get the maximum wall ID.
itasca.wall.near Find the closest wall to a point.
itasca.wall.thermal.count Get the number of thermal walls.
itasca.wall.thermal.facet.count Get the number of thermal facets.
itasca.wall.thermal.facet.find Get the thermal facet object with the given ID number.
itasca.wall.thermal.facet.inbox Get a tuple of thermal facets with extents intersecting a...
itasca.wall.thermal.facet.list Get a thermal facet iterator object.
itasca.wall.thermal.facet.maxid Get the maximum thermal facet ID.
itasca.wall.thermal.facet.near Find the closest thermal facet to a point.
itasca.wall.thermal.find Get the thermal wall object with the given ID number.
itasca.wall.thermal.inbox Get a tuple of thermal walls with extents intersecting a...
itasca.wall.thermal.list Get a thermal wall iterator object.
itasca.wall.thermal.maxid Get the maximum thermal wall ID.
itasca.wall.thermal.near Find the closest wall to a point.
itasca.wall.vertex.count Get the number of wall vertices.
itasca.wall.vertex.find Get the WallVertex object with the given ID number.
itasca.wall.vertex.inbox Get vertices with extents intersecting a box.
itasca.wall.vertex.list Get a WallVertex iterator object.
itasca.wall.vertex.maxid Get the maximum vertex ID.
itasca.wall.vertex.near Find the closest vertex to a point.
itasca.wallarray.cutoff Get a numpy array of the wall cutoff angle.
itasca.wallarray.disp Get a numpy array of the wall displacement.
itasca.wallarray.extra Get the wall extra data in the given slot as...
itasca.wallarray.fill_cutoff Fill an existing array with the wall cutoff angle.
itasca.wallarray.fill_disp Fill an existing array with the wall displacement.
itasca.wallarray.fill_force_contact Fill an existing array with the wall contact force.
itasca.wallarray.fill_moment_contact Fill an existing array with the wall contact moment.
itasca.wallarray.fill_pos Fill an existing array with the wall location.
itasca.wallarray.fill_rotation Fill an existing array with the wall orientation.
itasca.wallarray.fill_rotation_center Fill an existing array with the wall center of rotation.
itasca.wallarray.fill_spin Fill an existing array with the wall angular velocity.
itasca.wallarray.fill_vel Fill an existing array with the wall velocity.
itasca.wallarray.force_contact Get a numpy array of the wall contact force.
itasca.wallarray.ids Get the wall ids as an array.
itasca.wallarray.in_group Return wall group membership as a Boolean array.
itasca.wallarray.moment_contact Get a numpy array of the wall contact moment.
itasca.wallarray.pos Get a numpy array of the wall location.
itasca.wallarray.rotation Get a numpy array of the wall orientation.
itasca.wallarray.rotation_center Get a numpy array of the wall center of rotation.
itasca.wallarray.set_cutoff Set the wall cutoff angle from an array.
itasca.wallarray.set_disp Set the wall displacement from an array.
itasca.wallarray.set_extra Set the wall extra data in the given slot with...
itasca.wallarray.set_force_contact Set the wall contact force from an array.
itasca.wallarray.set_group Set wall group from an array.
itasca.wallarray.set_moment_contact Set the wall contact moment from an array.
itasca.wallarray.set_pos Set the wall location from an array.
itasca.wallarray.set_rotation Set the wall orientation from an array.
itasca.wallarray.set_rotation_center Set the wall center of rotation from an array.
itasca.wallarray.set_spin Set the wall angular velocity from an array.
itasca.wallarray.set_vel Set the wall velocity from an array.
itasca.wallarray.spin Get a numpy array of the wall angular velocity.
itasca.wallarray.vel Get a numpy array of the wall velocity.
itasca.zone.containing Get the zone that contains point.
itasca.zone.count Get the number of zones.
itasca.zone.create_ratio Get a value calculated by a geometric progression, given a...
itasca.zone.creep_time_total Get the total accumulated zone module creep time.
itasca.zone.creep_timestep Get the timestep used by the zone creep module when...
itasca.zone.dynamic_time_total Get the total accumulated zone module dynamic time.
itasca.zone.dynamic_timestep Get the total accumulated zone module creep time.
itasca.zone.find Get the zone object with the given ID number.
itasca.zone.fluid_ratio Get the current fluid convergence ratio for zones.
itasca.zone.fluid_stress_normal Get the current maximum value of convergence in any gridpoint...
itasca.zone.fluid_time_total Get the total accumulated zone module fluid time.
itasca.zone.fluid_timestep Get the current fluid timestep.
itasca.zone.fluid_unbal_avg Get the average unbalanced fluid volume limit for the fastflow...
itasca.zone.fluid_unbal_max Get the maximum unbalanced fluid limit for the fastflow solution...
itasca.zone.force_update Flags the cycling logic so that a geometry update is...
itasca.zone.list Get a zone iterator object.
itasca.zone.maxid Get the maximum zone ID.
itasca.zone.mech_convergence Get the current maximum value of convergence in any gridpoint...
itasca.zone.mech_ratio Get the current zone mechanical convergence ratio.
itasca.zone.mech_ratio_avg Get the current zone mechanical average convergence ratio.
itasca.zone.mech_ratio_local Get the current zone mechanical local convergence ratio.
itasca.zone.mech_ratio_max Get the current zone mechanical local convergence ratio.
itasca.zone.near Find the closest zone to a point.
itasca.zone.set_creep_time_total Set the total accumulated zone module creep time.
itasca.zone.set_creep_timestep Set the timestep used by the zone creep module when...
itasca.zone.set_dynamic_time_total Set the total accumulated zone module dynamic time.
itasca.zone.set_dynamic_timestep Set the total accumulated zone module creep time.
itasca.zone.set_fluid_time_total Set the total accumulated zone module fluid time.
itasca.zone.set_fluid_timestep Set the current fluid timestep.
itasca.zone.set_thermal_time_total Set the total accumulated zone module thermal time.
itasca.zone.set_thermal_timestep Set the current thermal timestep.
itasca.zone.thermal_ratio Get the current thermal convergence ratio for zones.
itasca.zone.thermal_time_total Get the total accumulated zone module thermal time.
itasca.zone.thermal_timestep Get the current thermal timestep.
itasca.zone.unbal Get the current maximum unbalanced force on any gridpoint in...
itasca.zonearray.extra Get the zone extra data in the given slot as...
itasca.zonearray.faces Return an array containing the gridpoint indices of each face...
itasca.zonearray.fill_pos Fill an existing array with the zone centroid location.
itasca.zonearray.flow Return an array of the zone specific discharge vectors.
itasca.zonearray.fluid_prop Return an array of the fluid property .
itasca.zonearray.gridpoints Return an array containing the gridpoint indices of each zone.
itasca.zonearray.ids Get the zone ids as an array.
itasca.zonearray.in_group Return zone group membership as a Boolean array.
itasca.zonearray.live_mechanical Return an array of True/False values, True values correspond to...
itasca.zonearray.neighbors Return an array containing the indices of the zone adjacent...
itasca.zonearray.overlay_stresses Get a multidimensional numpy array of the zone overlay stresses.
itasca.zonearray.pos Get a numpy array of the zone centroid location.
itasca.zonearray.prop_scalar Return an array of the property for each zone.
itasca.zonearray.set_extra Set the zone extra data in the given slot with...
itasca.zonearray.set_fluid_prop Set the fluid property with values from an array.
itasca.zonearray.set_group Set zone group from an array.
itasca.zonearray.set_prop_scalar Set the property of each zone.
itasca.zonearray.set_stress Set the zone stresses.
itasca.zonearray.set_stress_flat Set the zone stresses.
itasca.zonearray.strain Get an array of the zone strains.
itasca.zonearray.strain_flat Get an array of the zone strains.
itasca.zonearray.stress Get an array of the zone stresses.
itasca.zonearray.stress_flat Get an array of the zone stresses.
itasca.zonearray.stress_max Return an array of the maximum (most positive) principal value...
itasca.zonearray.stress_min Return an array of the minimum (most negative) principal value...
list.find(LIST,INT) Find an element in a list by ID.
list.find.name(LIST,INT/STR) Find an element in a list by name.
list.size(LIST) Get the list size.
mail.account(STR) Set the outgoing email account.
mail.attachment.add(STR) Add an attachment.
mail.attachment.delete(STR) Delete an attachment.
mail.body(BOOL,STR) Set the email body.
mail.clear Clear the email.
mail.domain(STR) Set the domain name of the sender’s email account.
mail.from(STR) Set the address from which the email is sent.
mail.host(STR) Set the SMTP server name.
mail.password(STR) Specify the email password.
mail.port(INT) Set the SMTP port number.
mail.recipient.add(STR,STR) Add a recipient.
mail.recipient.delete(STR,STR) Delete a recipient.
mail.send Send the current email.
mail.subject(STR) Set the subject line text.
map(NUM/STR,ANY<,NUM/STR/ANY>) Create a map.
map.add(MAP,NUM/STR,ANY) Add a value to a map.
map.has(MAP,NUM/STR) Query whether a map contains a key.
map.keys(MAP) Get the keys of a map.
map.remove(MAP,NUM/STR) Remove a value from a map.
map.size(MAP) Get the map size.
map.value(MAP,NUM/STR) Get a value.
math.aangle.to.euler(VEC) Get Euler angles from the axis-angle representation.
math.abs(NUM) Get the absolute value of a number or a vector.
math.acos(NUM) Get the arc-cosine.
math.and(INT,INT) Get the result of the bitwise logical AND operation.
math.area.intersect.poly.poly(MAP,MAP) Get the area of overlap of polygons.
math.area.poly(MAP) Get the area of a polygon.
math.asin(NUM) Get the arc-sine.
math.atan(NUM) Get the arc-tangent.
math.atan2(NUM,NUM) Get the arc-tangent.
math.ceiling(NUM) Get the next integer by rounding up.
math.closest.segment.point(VEC,VEC,VEC) Get the closest point on the line segment to the...
math.closest.triangle.point(VEC,VEC,VEC,VEC) Get the closest point on the triangle to the point.
math.cos(NUM) Get the cosine.
math.cosh(NUM) Get the hyperbolic cosine.
math.cross(VEC,VEC) Get the cross product of vectors.
math.ddir.from.normal(VEC) Get the dip direction.
math.degrad Get the degree-to-radian conversion.
math.dip.from.normal(VEC) Get the dip.
math.dist.segment.point(VEC,VEC,VEC) Get the distance between the line segment and the point.
math.dist.segment.segment(VEC,VEC,VEC,VEC) Get the distance between two line segments.
math.dist.triangle.segment(VEC,VEC,VEC,VEC,VEC) Get the shortest distance between a triangle and a line...
math.dot(VEC,VEC) Get the dot product of vectors.
math.euler.to.aangle(VEC) Get the axis-angle representation from Euler angles.
math.exp(NUM) Get the exponential.
math.floor(NUM) Get the previous integer by rounding down.
math.ln(NUM) Get the natural logarithm.
math.log(NUM) Get the base 10 logarithm.
math.lshift(INT,INT) Get the result of a left bit shift.
math.mag(VEC) Get the vector magnitude.
math.mag2(VEC) Get the squared vector magnitude.
math.max(NUM,NUM<,NUM>) Get the maximum.
math.min(NUM,NUM<,NUM>) Get the minimum.
math.normal.from.dip(FLT) Get the normal to a plane in 2D.
math.normal.from.dip.ddir(FLT,FLT) Get the normal to a plane in 3D.
math.not(INT,INT) Get the result of the bitwise logical NOT operation.
math.or(INT,INT) Get the result of the bitwise logical OR operation.
math.outer.product(MAT_PNT/VEC,MAT_PNT/VEC) Get the outer product of matrices or vectors.
math.pi Get the number pi.
math.random.gauss Get a Gaussian random number.
math.random.uniform Get a uniform random number.
math.round(NUM) Get the nearest integer.
math.rshift(INT,INT) Get the result of a right bit shift.
math.sgn(NUM) Get the sign.
math.sin(NUM) Get the sine.
math.sinh(NUM) Get the hyperbolic sine.
math.sqrt(NUM) Get the square root.
math.tan(NUM) Get the tangent.
math.tanh(NUM) Get the hyperbolic tangent.
math.triangle.inside(VEC,VEC,VEC,VEC) Determine if a point falls inside a 2D triangle.
math.triangle.interp(VEC,FLT,VEC,FLT,VEC,FLT,VEC) Return interpolated value at vIn based on triangle interpolation.
math.unit(VEC) Get a unit vector.
matrix(ARR_PNT/VEC/TEN_PNT/INT<,INT>) Create a matrix.
matrix.cols(MAT_PNT) Get the number of columns.
matrix.det(MAT_PNT/TEN_PNT) Get the matrix determinant.
matrix.from.aangle(VEC) Get a rotation matrix from axis angles.
matrix.from.euler(VEC) Get a rotation matrix from Euler angles.
matrix.identity(INT) Get an identity matrix.
matrix.inverse(ARR_PNT/MAT_PNT/TEN_PNT) Get the matrix inverse.
matrix.lubksb(ARR_PNT/MAT_PNT/TEN_PNT,ARR_PNT) Get the LU decomposition via backwards substitution.
matrix.ludcmp(ARR_PNT/MAT_PNT/TEN_PNT,ARR_PNT) Get the LU decomposition.
matrix.rows(MAT_PNT) Get the number of rows.
matrix.to.aangle(MAT_PNT) Convert a rotation matrix to axis angle.
matrix.to.euler(MAT_PNT) Convert a rotation matrix to Euler angles.
matrix.transpose(MAT_PNT) Transpose a matrix.
measure.coordination(MEAS_PNT) Get the measurement coordination number.
measure.delete(MEAS_PNT) Delete a measurement object.
measure.find(INT) Find a measurement object.
measure.id(MEAS_PNT) Get the measurement ID.
measure.list Get the list of measurement objects.
measure.maxid Get the maximum measurement ID.
measure.num Get the number of measurement objects.
measure.porosity(MEAS_PNT) Get the porosity.
measure.pos(MEAS_PNT<,INT>) Get/set the position.
measure.radius(MEAS_PNT) Get/set the radius of the measurement object.
measure.size(MEAS_PNT) Get the cumulative size distribution.
measure.strain.rate(MEAS_PNT<,INT<,INT>>) Get the strain rate tensor.
measure.stress(MEAS_PNT<,INT,INT>) Get the stress tensor.
measure.typeid Get the measurement type ID.
mech.active Get the status of mechanical calculations in the current cycle.
mech.cycle Get the current step/cycle number.
mech.energy(STR) Get a mechanical process energy.
mech.safety.factor Get the factor of safety.
mech.solve(STR) Get the current value of a solve limit.
mech.step Get the current step/cycle number.
mech.time.total Get the accumulated age.
mech.timestep Get the mechanical timestep.
mech.timestep.given Get the given timestep.
mech.timestep.max Get the maximum allowed timestep.
memory(MEM_PNT) Get/set a value in a memory chunk.
memory.create(INT) Create a chunk of memory.
memory.delete(MEM_PNT) Delete a memory chunk.
null Create a null pointer.
range.find(STR) Find a named range.
range.isin(RAN_PNT,IND/PNT/VEC) Determine range inclusion status.
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.energy(STR) Get the rigid block total energy contribution.
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.find(INT) Find a rigid block.
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.groupmap(STR<,INT>) Get rigid blocks that belong to a group.
rblock.id(RB_PNT) Get the rigid block ID.
rblock.inbox(VEC,VEC<,BOOL>) Get rigid blocks with extents intersecting a box.
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.list Get the global rigid block list.
rblock.mass(RB_PNT) Get the inertial rigid block mass.
rblock.mass.real(RB_PNT) Get the real (gravitational) rigid block mass.
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.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.near(VEC<,FLT>) Find the closest rigid block to a point.
rblock.num Get the number of rigid blocks.
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.template.delete(RBT_PNT) Delete a rigid block template.
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.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.num Get the number of rigid block templates.
rblock.template.typeid Get the rigid block template type number.
rblock.template.vol(RBT_PNT) Get/set the rigid block template volume.
rblock.thermal.contactmap(RBTH_PNT<,INT,PNT>) Get active thermal contacts around a thermal rigid block.
rblock.thermal.contactmap.all(RBTH_PNT<,INT,PNT>) Get all thermal contacts around a thermal rigid block.
rblock.thermal.contactnum(RBTH_PNT<,INT>) Get number of active thermal contacts around a thermal rblock.
rblock.thermal.contactnum.all(RBTH_PNT<,INT>) Get total number of thermal contacts around a thermal rigid...
rblock.thermal.expansion(RBTH_PNT) Get/set the thermal expansion coefficient.
rblock.thermal.extra(RBTH_PNT<,INT>) Get/set the thermal rigid block extra variable.
rblock.thermal.find(INT) Find a thermal rigid block.
rblock.thermal.fix(RBTH_PNT) Get/set the temperature fixity condition.
rblock.thermal.group(RBTH_PNT<,INT>) Get/set thermal rigid block groups.
rblock.thermal.group.remove(RBTH_PNT,STR) Remove thermal rigid block groups.
rblock.thermal.id(RBTH_PNT) Get the thermal rigid block ID.
rblock.thermal.inbox(VEC,VEC<,BOOL>) Get thermal rigid blocks with extents intersecting a box.
rblock.thermal.isgroup(RBTH_PNT,STR<,STR>) Query the existence of a group.
rblock.thermal.isprop(RBTH_PNT,STR) Query the existence of a property.
rblock.thermal.list Get the global thermal rigid block list.
rblock.thermal.near(VEC<,FLT>) Find the closest thermal rigid block to a point.
rblock.thermal.num Get the number of thermal rigid blocks.
rblock.thermal.power.app(RBTH_PNT) Get/set the thermal applied power.
rblock.thermal.power.unbal(RBTH_PNT) Get the unbalanced thermal power.
rblock.thermal.prop(RBTH_PNT,STR) Get/set a thermal rigid block property.
rblock.thermal.rigid(blockbt) Get the pointer to the host mechanical rigid block.
rblock.thermal.specific.heat(RBTH_PNT) Get/set the specific heat coefficient.
rblock.thermal.temp(RBTH_PNT) Get/set the temperature.
rblock.thermal.temp.increment(RBTH_PNT) Get/set the current temperature increment.
rblock.thermal.typeid Get the thermal rigid block type number.
rblock.typeid Get the rigid block type number.
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.
socket.close(SOCK_PNT/INT) Close communication on a socket.
socket.create Create a new socket.
socket.delete(SOCK_PNT) Delete a socket.
socket.open(INT/STR,SOCK_PNT/INT<,INT><,INT>) Open communication on a socket.
socket.read(ARR_PNT,INT,SOCK_PNT/INT<,INT>) Read FISH variables through a socket.
socket.read.array(ARR_PNT,SOCK_PNT/INT) Read FISH variables into an array through a socket.
socket.write(ARR_PNT,INT,SOCK_PNT/INT) Write FISH variables through a socket.
socket.write.array(ARR_PNT,SOCK_PNT/INT) Write FISH variables from an array through a socket.
string(ANY<,INT><,STR><,INT><,STR>) Create a string.
string.build(STR<,ANY><,ANY>) Build a string using token replacement.
string.char(STR,INT) Get a character from a string.
string.len(STR) Get the string length.
string.lower(STR) Get a string in lowercase.
string.sub(STR,INT<,INT>) Get a sub-string.
string.token(STR,INT) Get the item at a given position.
string.token.type(STR,INT) Get the character type at a given position.
string.upper(STR) Get a string in uppercase.
struct.beam.area(STRUCT_BEAM_PNT) Get/set the cross-section area of the element.
struct.beam.force(STRUCT_BEAM_PNT,INT<,INT>) Get the force at one end of the beam in...
struct.beam.force.nodal(STRUCT_BEAM_PNT,INT<,INT>) Get the generalized nodal force acting at end iend in...
struct.beam.length(STRUCT_BEAM_PNT) Get the length of the beam element.
struct.beam.load(STRUCT_BEAM_PNT<,INT>) Get/set the uniform applied distributed load acting on the beam...
struct.beam.moi(STRUCT_BEAM_PNT<,INT>) Get/set the moment of inertia of the beam.
struct.beam.moment(STRUCT_BEAM_PNT,INT<,INT>) Get the moment at one end of the beam in...
struct.beam.moment.plastic(STRUCT_BEAM_PNT) Get/set the plastic moment capacity in the beam.
struct.beam.poisson(STRUCT_BEAM_PNT) Get/set the Poisson’s ratio of the beam element.
struct.beam.volume(STRUCT_BEAM_PNT) Get the beam element volume, or the cross-sectional area times...
struct.beam.ydir(STRUCT_BEAM_PNT<,INT>) Get the y -axis of the beam element local system.
struct.beam.young(STRUCT_BEAM_PNT) Get/set the Young’s modulus of the beam element.
struct.cable.area(STRUCT_CABLE_PNT) Get/set the cross-section area of the cable element.
struct.cable.force.axial(STRUCT_CABLE_PNT) Get the average axial force of the element (positive: tension;...
struct.cable.force.nodal(STRUCT_CABLE_PNT,INT<,INT>) Get the generalized nodal force acting at end iend .
struct.cable.grout.cohesion(STRUCT_CABLE_PNT) Get/set the grout cohesion.
struct.cable.grout.confining(STRUCT_CABLE_PNT,INT) Get the confining stress acting on the grout at end...
struct.cable.grout.dir(STRUCT_CABLE_PNT,INT<,INT>) Get the direction vector in which cableSEL is being loaded...
struct.cable.grout.disp(STRUCT_CABLE_PNT,INT) Get displacement in grout (shear coupling spring) at end iend ...
struct.cable.grout.friction(STRUCT_CABLE_PNT) Get/set the grout internal friction angle.
struct.cable.grout.perimeter(STRUCT_CABLE_PNT) Get/set the grout exposed perimeter.
struct.cable.grout.slip(STRUCT_CABLE_PNT,INT) Get the slip state of grout (shear coupling spring) at...
struct.cable.grout.stiffness(STRUCT_CABLE_PNT) Get/set the grout stiffness.
struct.cable.grout.stress(STRUCT_CABLE_PNT,INT) Get stress in grout (shear coupling spring) at end iend ...
struct.cable.length(STRUCT_CABLE_PNT) Get the length of the cable element.
struct.cable.slide(STRUCT_CABLE_PNT) Get the boolean flag of the large-strain sliding.
struct.cable.slide.tol(STRUCT_CABLE_PNT) Get/set the large-strain sliding tolerance of the cable element.
struct.cable.state.compression(STRUCT_CABLE_PNT) Get the compression yield state of the cable element.
struct.cable.state.tension(STRUCT_CABLE_PNT) Get the tension yield state of cable element.
struct.cable.stress.axial(STRUCT_CABLE_PNT) Get the average axial stress of the cable element (positive:...
struct.cable.volume(STRUCT_CABLE_PNT) Get the cable element volume, or the cross-sectional area times...
struct.cable.yield.compression(STRUCT_CABLE_PNT) Get/set the compression yield strength of the cable element.
struct.cable.yield.tension(STRUCT_CABLE_PNT) Get/set the tension yield strength of the cable element.
struct.cable.young(STRUCT_CABLE_PNT) Get/set the Young’s modulus of the cable element.
struct.check(STRUCT_PNT,STRUCT_PNT) Check that structures are of the same type.
struct.connectivity(STRUCT_PNT,INT) Get the index of the node with component-ID id in...
struct.delete(STRUCT_PNT) Delete the structural element.
struct.density(STRUCT_PNT) Get/set the structural element density.
struct.extra(STRUCT_PNT<,INT>) Get/set the FISH parameter value stored at index i of...
struct.find(INT) Get the structural element with internally assigned component-ID number i .
struct.geogrid.shear.cohesion(STRUCT_GEOGRID_PNT) Get/set the (shear) coupling spring cohesion strength of the geogrid...
struct.geogrid.shear.dir(STRUCT_GEOGRID_PNT,INT<,INT>) Get the direction (unit vector in global system) in which...
struct.geogrid.shear.disp(STRUCT_GEOGRID_PNT,INT) Get the displacement magnitude in the coupling spring at node...
struct.geogrid.shear.friction(STRUCT_GEOGRID_PNT) Get/set the (shear) coupling spring friction angle of the geogrid...
struct.geogrid.shear.state(STRUCT_GEOGRID_PNT,INT) Get the yield state of the coupling spring at node...
struct.geogrid.shear.stiffness(STRUCT_GEOGRID_PNT) Get/set the (shear) coupling spring stiffness of the geogrid element.
struct.geogrid.shear.stress(STRUCT_GEOGRID_PNT,INT) Get the stress magnitude in coupling spring at node inode ...
struct.geogrid.slide(STRUCT_GEOGRID_PNT) Get/set the large-strain sliding flag.
struct.geogrid.slide.tol(STRUCT_GEOGRID_PNT) Get/set the (shear) coupling spring slide tolerance of the geogrid...
struct.geogrid.stress.confining(STRUCT_GEOGRID_PNT,INT) Get the confining stress at node inode ( inode ∈ {1,...
struct.group(STRUCT_PNT<,STR>) Get/set the group name assigned to structural element p in...
struct.group.remove(STRUCT_PNT,STR) Remove the group s from structural element p in all...
struct.head Get the first element in the list of all structural...
struct.id(STRUCT_PNT) Get the structural element ID number.
struct.id.component(STRUCT_PNT) Get the structural element component-ID number.
struct.isgroup(STRUCT_PNT,STR<,STR>) Check if the group s is associated with the structural...
struct.liner.embedded(STRUCT_LINER_PNT) Get the embedded flag.
struct.liner.normal.dir(STRUCT_LINER_PNT,INT<,INT>) Get the direction (unit vector in global system) in which...
struct.liner.normal.disp(STRUCT_LINER_PNT,INT) Get the displacement magnitude in the normal coupling spring at...
struct.liner.normal.stiffness(STRUCT_LINER_PNT<,INT>) Get/set the normal coupling spring stiffness of the liner element.
struct.liner.normal.strength(STRUCT_LINER_PNT<,INT>) Get/set the normal coupling spring tensile strength of the liner...
struct.liner.normal.stress(STRUCT_LINER_PNT,INT) Get the stress magnitude in the normal coupling spring at...
struct.liner.shear.cohesion(STRUCT_LINER_PNT<,INT>) Get/set the shear coupling spring cohesion of the liner element.
struct.liner.shear.dir(STRUCT_LINER_PNT,INT<,INT>) Get the direction (unit vector in global system) in which...
struct.liner.shear.disp(STRUCT_LINER_PNT,INT) Get the displacement magnitude in the shear coupling spring at...
struct.liner.shear.friction(STRUCT_LINER_PNT<,INT>) Get/set the shear coupling spring friction angle of the liner...
struct.liner.shear.residual(STRUCT_LINER_PNT<,INT>) Get/set the shear coupling spring residual cohesion of the liner...
struct.liner.shear.state(STRUCT_LINER_PNT,INT) Get the yield state of the coupling spring at node...
struct.liner.shear.stiffness(STRUCT_LINER_PNT<,INT>) Get/set the shear coupling spring stiffness of the liner element.
struct.liner.shear.stress(STRUCT_LINER_PNT,INT) Get the stress magnitude in the shear coupling spring at...
struct.liner.slide(STRUCT_LINER_PNT) Get/set the large-strain sliding flag.
struct.liner.slide.tol(STRUCT_LINER_PNT) Get/set the shear coupling spring slide tolerance of the liner...
struct.link.attach(STRUCT_LINK_PNT,INT) Get the attached condition used by the link in degree-of-freedom...
struct.link.delete(STRUCT_LINK_PNT) Delete the structural link.
struct.link.extra(STRUCT_LINK_PNT<,INT>) Get/set the FISH parameter value stored at index i of...
struct.link.find(INT) Get the link with internally assigned component-ID number i .
struct.link.group(STRUCT_LINK_PNT<,STR>) Get/set the group name assigned to link p in slot...
struct.link.group.remove(STRUCT_LINK_PNT,STR) Remove the group s from structural link p in all...
struct.link.head Get the first zone in the list of all structural...
struct.link.id(STRUCT_LINK_PNT) Get the structural link ID number.
struct.link.id.component(STRUCT_LINK_PNT) Get the structural link component-ID number.
struct.link.list Get the list of all structural links in the model.
struct.link.maxid Get the maximum component-ID number assigned to any structural link...
struct.link.model(STRUCT_LINK_PNT,INT) Get the name of the 1-D force-displacement model used in...
struct.link.model.area(STRUCT_LINK_PNT<,INT>) Get/set the area associated with the force-displacement model.
struct.link.model.compression(STRUCT_LINK_PNT<,INT>) Get/set the compressive yield force associated with the force-displacement model.
struct.link.model.disp(STRUCT_LINK_PNT<,INT>) Get the relative displacement between the node and the target...
struct.link.model.force(STRUCT_LINK_PNT<,INT>) Get the current force in each 1-D force-displacement model.
struct.link.model.gap(STRUCT_LINK_PNT) Get/set the flag indicating whether gap calculations are active in...
struct.link.model.gap.neg(STRUCT_LINK_PNT<,INT>) Get the negative (compressive) gap component of each 1-D force-displacement...
struct.link.model.gap.pos(STRUCT_LINK_PNT<,INT>) Get the positive (tensile) gap component of each 1-D force-displacement...
struct.link.model.stiffness(STRUCT_LINK_PNT<,INT>) Get/set the stiffness used by each 1-D force-displacement model.
struct.link.model.tension(STRUCT_LINK_PNT<,INT>) Get/set the tensile yield force associated with the force-displacement model.
struct.link.model.yield(STRUCT_LINK_PNT,INT) Get the yield state indicator in the 1-D force displacement...
struct.link.next(STRUCT_LINK_PNT) Get the next link after p in the list of...
struct.link.node(STRUCT_LINK_PNT) Get a pointer to the node hosting the structural link.
struct.link.num Get the total number of structural links in the model.
struct.link.side(STRUCT_LINK_PNT) Get the side number of the link.
struct.link.slide(STRUCT_LINK_PNT) Get/set the large-strain sliding DR: previous wants to be a...
struct.link.slide.tol(STRUCT_LINK_PNT) Get/set the large-strain sliding DR: previous wants to be a...
struct.link.target(STRUCT_LINK_PNT) Get the ID (or component-ID) of the target.
struct.link.type(STRUCT_LINK_PNT) Get the name of the link target type.
struct.link.typeid Get an identifier that uniquely determines the type of object.
struct.link.used.by(STRUCT_LINK_PNT) Get the name of the type of structural element with...
struct.list Get the list of all structural elements in the model,...
struct.local.system(STRUCT_PNT<,INT><,INT>) Get the local coordinate system for the structural element.
struct.mark(STRUCT_PNT) Get/set the mark flag on the structural element.
struct.maxid Get the maximum component-ID number assigned to any structural element...
struct.mech.convergence Get the maximum convergence value (local ratio divided by target...
struct.mech.ratio.avg Get the average convergence ratio of all structural nodes in...
struct.mech.ratio.local Get the maximum local convergence ratio of all structural nodes...
struct.mech.ratio.max Get the ratio of maximum unbalanced force to average applied...
struct.mech.unbal.max Get the structural node maximum unbalanced force.
struct.name(STRUCT_PNT) Get the name of a structure.
struct.near Get the structural element (of any type) whose centroid is...
struct.next(STRUCT_PNT) Get the next element after p in the list of...
struct.node(STRUCT_PNT,INT) Get a pointer to the node at index i in...
struct.node.acc.global(STRUCT_NODE_PNT<,INT>) Get the acceleration of structure node expressed in a global...
struct.node.acc.local(STRUCT_NODE_PNT<,INT>) Get the acceleration of structure node expressed in a local...
struct.node.apply(STRUCT_NODE_PNT<,INT>) Get/set the generalized applied force expressed in a system defined by...
struct.node.apply.local(STRUCT_NODE_PNT) Get whether the coordinate system in which generalized applied forces...
struct.node.convergence(STRUCT_NODE_PNT) Returns the gridpoint convergence value, defined as the ratio of...
struct.node.damp.local(STRUCT_NODE_PNT) Get/set the local damping factor of the structure node.
struct.node.disp.global(STRUCT_NODE_PNT<,INT>) Get the displacement of structure node expressed in a global...
struct.node.disp.local(STRUCT_NODE_PNT<,INT>) Get the displacement of structure node expressed in a local...
struct.node.extra(STRUCT_NODE_PNT<,INT>) Get/set the value stored in the i th extra variable array...
struct.node.find(INT) Get the structural node with internally assigned component-ID number i .
struct.node.fix(STRUCT_NODE_PNT,INT) Get velocity-fixity flag expressed in the node-local system (degree-of-freedom component i1 ...
struct.node.fix.local(STRUCT_NODE_PNT) Get/set the boolean flag for the local coordinate system fixity.
struct.node.force.unbal.global(STRUCT_NODE_PNT<,INT>) Get the unbalanced force of structure node expressed in a...
struct.node.force.unbal.local(STRUCT_NODE_PNT<,INT>) Get the unbalanced force of structure node expressed in a...
struct.node.group(STRUCT_NODE_PNT<,STR>) Get/set the group name assigned to structure node sn in...
struct.node.group.remove(STRUCT_NODE_PNT,STR) Remove the group s from structure node sn in all...
struct.node.head Get the first structure node in the list of all...
struct.node.id(STRUCT_NODE_PNT) Get the structural node ID number.
struct.node.id.component(STRUCT_NODE_PNT) Get the structural node component-ID number.
struct.node.link(STRUCT_NODE_PNT<,INT>) Get the link associated with structure node sn .
struct.node.list Get the list of all structure nodes in the model.
struct.node.mark(STRUCT_NODE_PNT) Get/set the mark flag.
struct.node.mass.added(STRUCT_NODE_PNT<,INT>) Get/set the extra mass in addition to the inertial mass...
struct.node.mass.local(STRUCT_NODE_PNT<,INT>) Get the mass at the degree-of-freedom i ∈ {1, 2,...
struct.node.maxid Get the maximum component-ID number assigned to any structural node...
struct.node.near(VEC+) Get the structure node nearest v .
struct.node.next(STRUCT_NODE_PNT) Get the next structure node after sn in the list...
struct.node.num Get the total number of structure nodes in the model.
struct.node.pos(STRUCT_NODE_PNT<,INT>) Get the current position vector for the structure node.
struct.node.pos.reference(STRUCT_NODE_PNT<,INT>) Get the reference position vector for the structure node.
struct.node.ratio(STRUCT_NODE_PNT) Get the local gridpoint mechanical convergence ratio.
struct.node.ratio.target(STRUCT_NODE_PNT) Get/set the target mechanical force ratio in the node.
struct.node.resultant(STRUCT_NODE_PNT<,INT>) Get stress resultants last calculated for the elements connected to...
struct.node.stiff.local(STRUCT_NODE_PNT<,INT>) Get the stiffness of structure node expressed in a local...
struct.node.surface.valid(STRUCT_NODE_PNT) Get a boolean flag for surface system validity; true if the...
struct.node.surface.xdir(STRUCT_NODE_PNT,VEC) Set the orientation of the surface system of node sn such...
struct.node.system.local(STRUCT_NODE_PNT<,INT><,INT>) Get the local coordinate system of the structure node.
struct.node.system.surface(STRUCT_NODE_PNT<,INT><,INT>) Get/set the surface coordinate system of the structure node.
struct.node.temp.increment(STRUCT_NODE_PNT) Get/set the the temperature increment that will be applied to...
struct.node.typeid Get an identifier that uniquely determines the type of object.
struct.node.vel.global(STRUCT_NODE_PNT<,INT>) Get the velocity of a structure node expressed in a...
struct.node.vel.local(STRUCT_NODE_PNT<,INT>) Get the velocity of a structure node expressed in a...
struct.num Get the total number of structural elements in the model.
struct.pile.area(STRUCT_PILE_PNT) Get/set the cross-section area of the pile element.
struct.pile.axial.yield(STRUCT_PILE_PNT) Get/set the axial tensile yield strength (force units) of the...
struct.pile.force(STRUCT_PILE_PNT,INT<,INT>) Get the nodal force acting on the pile element at...
struct.pile.force.nodal(STRUCT_PILE_PNT,INT<,INT>) Get the generalized nodal force acting at end iend in...
struct.pile.gap(STRUCT_PILE_PNT,INT,INT) Get the gap component in normal spring at end iend ...
struct.pile.length(STRUCT_PILE_PNT) Get/set the length of the pile element.
struct.pile.load(STRUCT_PILE_PNT<,INT>) Get/set the uniform applied distributed load acting on the pile...
struct.pile.moi(STRUCT_PILE_PNT<,INT>) Get/set the moment of inertia of the pile.
struct.pile.moment(STRUCT_PILE_PNT,INT<,INT>) Get the nodal moment acting on the pile element at...
struct.pile.moment.plastic(STRUCT_PILE_PNT) Get/set the plastic moment capacity of the pile element.
struct.pile.normal.cohesion(STRUCT_PILE_PNT) Get/set the normal coupling spring cohesive strength of the pile...
struct.pile.normal.dir(STRUCT_PILE_PNT,INT<,INT>) Get the global direction in which the pile element is...
struct.pile.normal.disp(STRUCT_PILE_PNT,INT) Get the displacement in the coupling normal spring at end...
struct.pile.normal.friction(STRUCT_PILE_PNT) Get/set the normal coupling spring friction angle of the pile...
struct.pile.normal.gap(STRUCT_PILE_PNT) Get the normal coupling spring gap-use flag.
struct.pile.normal.state(STRUCT_PILE_PNT,INT) Get the yield state of the coupling normal spring at...
struct.pile.normal.stiffness(STRUCT_PILE_PNT) Get/set the normal coupling spring stiffness of the pile element.
struct.pile.normal.stress(STRUCT_PILE_PNT,INT) Get the stress in the coupling normal spring at end...
struct.pile.perimeter(STRUCT_PILE_PNT) Get/set the exposed perimeter of the pile element.
struct.pile.poisson(STRUCT_PILE_PNT) Get/set the Poisson’s ratio of the pile element.
struct.pile.rockbolt(STRUCT_PILE_PNT) Get a boolean flag of the rockbolt.
struct.pile.shear.cohesion(STRUCT_PILE_PNT) Get/set the shear coupling spring cohesive strength of the pile...
struct.pile.shear.dir(STRUCT_PILE_PNT,INT<,INT>) Get the global direction in which the pile element is...
struct.pile.shear.disp(STRUCT_PILE_PNT,INT) Get the displacement in coupling shear spring at end iend ...
struct.pile.shear.flag(STRUCT_PILE_PNT) Get the shear direction incremental confining stress flag.
struct.pile.shear.friction(STRUCT_PILE_PNT) Get/set the shear coupling spring friction angle of the pile...
struct.pile.shear.state(STRUCT_PILE_PNT,INT) Get the yield state of the coupling shear spring at...
struct.pile.shear.stiffness(STRUCT_PILE_PNT) Get/set the shear coupling spring stiffness of the pile element.
struct.pile.shear.stress(STRUCT_PILE_PNT,INT) Get the stress in coupling shear spring at end iend ...
struct.pile.slide(STRUCT_PILE_PNT) Get a boolean flag of slide.
struct.pile.slide.tol(STRUCT_PILE_PNT) Get/set the large-strain sliding tolerance of the pile element.
struct.pile.strain.failure(STRUCT_PILE_PNT) Get/set the tensile failure strain (non-dimensional) of the pile element.
struct.pile.stress.confining(STRUCT_PILE_PNT,INT) Get the confining stress at end iend ∈ {1, 2}...
struct.pile.table.cohesion(STRUCT_PILE_PNT) Get/set the shear direction cohesion strength table number for the...
struct.pile.table.factor(STRUCT_PILE_PNT) Get/set the shear direction friction table number for the pile...
struct.pile.table.friction(STRUCT_PILE_PNT) Get/set the shear direction incremental confining stress factor table number...
struct.pile.volume(STRUCT_PILE_PNT) Get/set the volume of the pile element.
struct.pile.ydir(STRUCT_PILE_PNT<,INT>) Get the y -axis of the pile element local system.
struct.pile.young(STRUCT_PILE_PNT) Get/set the Young’s modulus of the pile element.
struct.pos(STRUCT_PNT<,INT>) Get the position vector of the element, defined as the...
struct.shell.area(STRUCT_SHELL_PNT) Get surface area of the shell-type element.
struct.shell.beta(STRUCT_SHELL_PNT) Get shell-type material system beta angle.
struct.shell.depth.factor(STRUCT_SHELL_PNT) Get the depth factor at which stresses have been recovered.
struct.shell.element.type(STRUCT_SHELL_PNT) Get the name of the finite-element type used by this...
struct.shell.force.nodal(STRUCT_SHELL_PNT,INT<,INT>) Get the generalized nodal force acting on the shell at...
struct.shell.poisson(STRUCT_SHELL_PNT) Get/set the Poisson’s ratio of the element.
struct.shell.pressure(STRUCT_SHELL_PNT) Get/set the uniform pressure acting on the shell.
struct.shell.prop.anis(STRUCT_SHELL_PNT,INT,INT) Get the anisotropic material properties.
struct.shell.prop.ortho(STRUCT_SHELL_PNT,INT,INT) Get the orthotropic material properties.
struct.shell.prop.type(STRUCT_SHELL_PNT) Get the material property type.
struct.shell.resultant(STRUCT_SHELL_PNT,INT<,INT>) Get stress resultants last calculated for the element at the...
struct.shell.resultant.valid(STRUCT_SHELL_PNT) Get stress resultant validity flag.
struct.shell.stress(STRUCT_SHELL_PNT,INT<,INT<,INT>>) Get the shell stresses at the current depth factor at...
struct.shell.stress.prin(STRUCT_SHELL_PNT,INT<,INT>) Get the resolved principal stress at the current depth factor...
struct.shell.stress.valid(STRUCT_SHELL_PNT) Get the stress validity flag for the element.
struct.shell.thickness(STRUCT_SHELL_PNT) Get/set the element thickness.
struct.shell.volume(STRUCT_SHELL_PNT) Get the element volume, or surface area times thickness.
struct.shell.young(STRUCT_SHELL_PNT) Get/set the Young’s modulus of the element.
struct.therm.expansion(STRUCT_PNT) Get/set the thermal expansion coefficient for the structural element.
struct.type(STRUCT_PNT) Get the name of the structural element type.
struct.typeid Get an identifier that uniquely determines the type of object.
struct.was.updated Returns TRUE if the last validation check actually performed a...
system.beep(<INT><,INT>) Emit a beep.
system.clone(STR<,INT>) A new instance of the code is launched, and the...
system.command(STR/ARR_PNT/MAP) Execute the string contents of the arguments as commands.
system.directory(<STR><,STR>) Set and retrieve the current system directory.
system.environment(STR) Get/set an environment variable.
system.error Throw a FISH exception.
system.os(STR<,INT>) The contents of string s is sent to an operating...
system.sleep(INT) Pause execution.
table(INT/STR/TAB_PNT,FLT) Get/set a table entry.
table.clear(INT/STR/TAB_PNT) Clear a table.
table.create(INT/STR) Create an empty table.
table.delete(INT/STR/TAB_PNT) Delete a table.
table.find(INT/STR) Find a table.
table.get(INT/STR) Get a table.
table.id(INT/STR/TAB_PNT) Get the table ID.
table.label(INT/STR/TAB_PNT) Get/set the table label.
table.name(INT/STR/TAB_PNT) Get the table name.
table.size(INT/STR/TAB_PNT) Get the table size.
table.value(INT/STR/TAB_PNT,INT) Get/set a table entry.
table.x(INT/STR/TAB_PNT,INT) Get/set the x -value of a table entry.
table.y(INT/STR/TAB_PNT,INT) Get/set the y -value of a table entry.
tensor(MAT/ARR_PNT/VEC/NUM<,NUM><,NUM><,NUM><,NUM><,NUM>) Create a tensor.
tensor.i2(TEN) Get the second stress invariant.
tensor.j2(TEN) Get the second deviatoric stress invariant.
tensor.prin(TEN<,ARR_PNT>) Get the principal values.
tensor.prin.from(VEC,ARR_PNT) Get the tensor from principal axes.
tensor.total(TEN) Get the tensor measure.
tensor.trace(TEN) Get the trace of a tensor.
thermal.active Get the status of thermal calculations in the current cycle.
thermal.age Get the accumulated age.
thermal.cycle Get the current step/cycle number.
thermal.safety.factor Get the factor of safety.
thermal.solve(STR) Get a current solve limit.
thermal.step Get the current step/cycle number.
thermal.timestep Get the thermal timestep.
thermal.timestep.given Get the given timestep.
thermal.timestep.max Get the maximum allowed timestep.
time.clock(<INT>) Get the number of hundredths of a second since code...
time.cpu Get the CPU time.
time.real Get the current date time.
true Create a true Boolean.
type(ANY) Get the type.
type.index(PNT) Get the type index.
type.name(ANY) Get the type name.
type.pointer(PNT) Get the type name of a pointer.
type.pointer.id(PNT) Get the ID of a pointer.
type.pointer.name(PNT) Get the name of a pointer.
vector(ARR_PNT/MAT_PNT/NUM<,NUM><,NUM>) Create a vector.
version.code.major Get the code major version.
version.code.minor Get the code minor version.
version.fish.major Get the FISH major version.
version.fish.minor Get the FISH minor version.
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.energy(STR) Get the wall total energy contribution.
wall.euler(W_PNT<,INT>)(3D ONLY) Get/set the wall orientation.
wall.extra(W_PNT<,INT>) Get/set wall extra variable.
wall.facet.active(WF_PNT) Get/set the facet activity.
wall.facet.contactmap(WF_PNT<,INT><,PNT>) Get active contacts around a facet.
wall.facet.contactmap.all(WF_PNT<,INT><,PNT>) Get all contacts around a facet.
wall.facet.contactnum(WF_PNT<,INT>) Get number of contacts around a facet.
wall.facet.contactnum.all(WF_PNT<,INT>) Get number of contacts around a facet.
wall.facet.conveyor(WF_PNT<,INT>) Get/set the facet conveyor velocity.
wall.facet.delete(WF_PNT) Delete a facet.
wall.facet.extra(WF_PNT<,INT>) Get/set facet extra variable.
wall.facet.find(INT) Find a facet.
wall.facet.group(WF_PNT<,STR>) Get/set facet groups.
wall.facet.group.remove(WF_PNT,STR) Remove facet groups.
wall.facet.groupmap(STR<,INT>) Get facets that belong to a group.
wall.facet.id(WF_PNT) Get the facet ID.
wall.facet.inbox(VEC,VEC<,BOOL>) Get facets with extents intersecting a box.
wall.facet.isbonded(WF_PNT<,INT,PNT>) Get the wall facet bonded state.
wall.facet.isgroup(WF_PNT,STR<,STR>) Query the existence of a group.
wall.facet.isprop(WF_PNT,STR) Query the existence of a property.
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.normal(WF_PNT<,INT>) Get the facet normal.
wall.facet.num Get the number of facets.
wall.facet.pair(WF_PNT,INT) Get a neighboring facet.
wall.facet.pointnear(WF_PNT,VEC) Get the closest point on the facet to another point.
wall.facet.pos(WF_PNT<,INT>) Get the facet position.
wall.facet.prop(WF_PNT,STR) Get/set a facet property.
wall.facet.typeid Get the facet type number.
wall.facet.vertex(WF_PNT,INT) Get the facet vertex.
wall.facet.wall(WF_PNT) Get the facet’s wall.
wall.facetlist(W_PNT) Get the facets of a wall.
wall.find(INT) Find 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.groupmap(STR<,INT>) Get walls that belong to a group.
wall.id(W_PNT) Get the wall ID.
wall.inbox(VEC,VEC<,BOOL>) Get walls with extents intersecting a box.
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.list Get the global wall list.
wall.maxid Get the maximum wall ID.
wall.moment.contact(W_PNT<,INT>) Get the wall contact moment.
wall.name(W_PNT) Get the wall name.
wall.near(VEC<,FLT>) Find the closest wall to a point.
wall.num Get the number of walls.
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.thermal.contactmap(WTH_PNT<,INT><,PNT>) Get active thermal contacts around a thermal wall.
wall.thermal.contactmap.all(WTH_PNT<,INT><,PNT>) Get all thermal contacts around a thermal wall.
wall.thermal.extra(WTH_PNT<,INT>) Get/set the thermal wall extra variable.
wall.thermal.facet.contactmap(WFTH_PNT<,INT,PNT>) Get active thermal contacts around a facet.
wall.thermal.facet.contactmap.all(WFTH_PNT<,INT,PNT>) Get all thermal contacts around a facet.
wall.thermal.facet.facet(WFTH_PNT) Get the host mechanical facet.
wall.thermal.facet.find(INT) Find a thermal facet.
wall.thermal.facet.group(WFTH_PNT<,INT>) Get/set thermal facet groups.
wall.thermal.facet.group.remove(WFTH_PNT,STR) Remove thermal facet groups.
wall.thermal.facet.id(WFTH_PNT) Get the thermal facet ID.
wall.thermal.facet.inbox(VEC,VEC<,BOOL>) Get thermal facets with extents intersecting a box.
wall.thermal.facet.isgroup(WFTH_PNT,STR<,INT>) Query the existence of a group.
wall.thermal.facet.isprop(WFTH_PNT,STR) Query the existence of a property.
wall.thermal.facet.list Get the global thermal facet list.
wall.thermal.facet.near(VEC<,FLT>) Find the closest thermal facet to a point.
wall.thermal.facet.num Get the number of thermal facets.
wall.thermal.facet.pos(WFTH_PNT<,INT>) Get the thermal facet position.
wall.thermal.facet.prop(WFTH_PNT,STR) Get/set a thermal facet property.
wall.thermal.facet.typeid Get the thermal facet type number.
wall.thermal.facet.wall(WFTH_PNT) Get the thermal facet’s thermal wall.
wall.thermal.facetlist(WTH_PNT) Get the facets of a thermal wall.
wall.thermal.find(INT) Find a thermal wall.
wall.thermal.group(WTH_PNT<,STR>) Get/set thermal wall groups.
wall.thermal.group.remove(CLT_PNT,STR) Remove thermal wall groups.
wall.thermal.id(WTH_PNT) Get the thermal wall ID.
wall.thermal.inbox(VEC,VEC<,BOOL>) Get thermal walls with extents intersecting a box.
wall.thermal.isgroup(CLT_PNT,STR<,STR>) Query the existence of a group.
wall.thermal.list Get the global thermal wall list.
wall.thermal.near(VEC<,FLT>) Find the closest thermal wall to a point.
wall.thermal.num Get the number of thermal walls.
wall.thermal.pos(WTH_PNT<,INT>) Get the thermal wall position.
wall.thermal.prop(WTH_PNT,STR) Set a property for all facets.
wall.thermal.typeid Get the thermal wall type number.
wall.thermal.wall(WTH_PNT) Get the host mechanical wall.
wall.typeid Get the wall type number.
wall.vel(W_PNT<,INT>) Get/set the wall velocity.
wall.vertex.delete(WV_PNT) Delete the vertex.
wall.vertex.facetarray(WV_PNT) Get the array of facets sharing a vertex.
wall.vertex.find(INT) Find a vertex.
wall.vertex.id(WV_PNT) Get the vertex ID.
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.pos(WV_PNT<,INT>) Get/set the vertex position.
wall.vertex.typeid Get the vertex type number.
wall.vertex.vel(WV_PNT<,INT>) Get/set the vertex velocity.
wall.vertexlist(W_PNT) Get the vertices of a wall.
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.face.area(ZONE_PNT,INT) Get the area of the face.
zone.face.extra(ZONE_PNT,INT,INT) Get/set the value of the index in the extra variable...
zone.face.find(ZONE_PNT,INT/GP_PNT,INT/GP_PNT,INT/GP_PNT) Get the face index of zone z that contains the...
zone.face.find.normal(ZONE_PNT,VEC) Get the face index of zone z whose outward-facing normal...
zone.face.gp(ZONE_PNT,INT,INT) Get a pointer to a gridpoint on face given by...
zone.face.group(ZONE_PNT,INT<,STR>) Get/set the group name associated with the face identified by...
zone.face.group.remove(ZONE_PNT,INT,STR) Removes the group name s from the face identified by...
zone.face.isgroup(ZONE_PNT,INT,STR<,STR>) Check if the group name s is associated with the...
zone.face.normal(ZONE_PNT,INT<,INT>) Get the normal to the face, facing outward from zone...
zone.face.pos(ZONE_PNT,INT<,INT>) Get the position of the face, defined as the centroid...
zone.face.size(ZONE_PNT,INT) Get the number of unique face vertices.
zone.field.component Get/set the scalar value retrieved from a name that returns...
zone.field.extra Get/set the index used to retrieve extra variables.
zone.field.get(VEC+<,FLT>) Get data from the model at the location specified by...
zone.field.get.gp(GP_PNT,ZONE_PNT) Get data directly from the gridpoint gp and zone z .
zone.field.gravity Get/set gravitational force setting.
zone.field.hide.fluidnull Get/set the null fluid constitutive model setting.
zone.field.hide.mechnull Get/set the null mechanical constitutive model setting.
zone.field.hide.thermnull Get/set the null thermal constitutive model setting.
zone.field.index Get/set the the index number of the data type name...
zone.field.init Initializes the zone field data system for the current method...
zone.field.log Get/set the logarithmic setting.
zone.field.method.index Get/set the index number of the extrapolation method used for...
zone.field.method.name Get/set the method used for extrapolation of zone-based variables.
zone.field.name Get/set the name of the value being retrieved from zones.
zone.field.power Get/set the power exponent used for the inverse-distance-weighting method of...
zone.field.prop Get/set the name of the property to retrieve when the...
zone.field.quantity Get/set the scalar quantity to retrieve when the value being...
zone.field.radius.ratio Get/set the the radius ratio parameter used for the inverse-distance-weighting ...
zone.field.reset Removes the effect of zone.
zone.field.source Get/set where values are derived from when appropriate.
zone.field.tol Get/set the tolerance used for the polynomial method of extrapolation.
zone.field.type Get/set the type to assume, for those values where the...
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.tet.gp(ZONE_PNT,INT,INT,ARR_PNT) Gets the gridpoint pointers associated with a tetrahedron number itet ...
zone.tet.num(ZONE_PNT) Get the number of tetra in each overlay of the...
zone.tet.smallest.vol(ZONE_PNT) Get the volume of the smallest tetrahedron in an overlay.
zone.tet.strain.inc(ZONE_PNT,INT,INT<,INT<,INT>>) Get the zone tetra strain increment based on the current...
zone.tet.strain.rate(ZONE_PNT,INT,INT<,INT<,INT>>) Get the zone tetra strain rate based on the current...
zone.tet.stress(ZONE_PNT,INT,INT<,INT<,INT>>) Get/set the zone tetra stress.
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.