Command and FISH Reference Summaries
Indexed here: Command Summary | FISH Reference Summary
The type specifiers used in the FISH function signatures are given in the “FISH Type Index” section.
Command Summary
advection-conduction | Effective conductivity. |
anisotropic | Principal thermal conductivity value. |
arrlinear | - attraction range with default value 0. |
ball attribute | Set the value of ball attributes. |
ball create | Create a single ball with the specified attributes. |
ball delete | Delete balls. |
ball distribute | Distribute balls with overlaps. |
ball export | Exports balls. |
ball extra | Set ball extra variables. |
ball fix | Fix the specified ball velocities. |
ball free | Free the specified ball velocities. |
ball generate | Generate non-overlapping balls. |
ball group | Specify ball group names. |
ball history | Adds a history of a ball value. |
ball initialize | Modify ball attributes. |
ball list | List ball information. |
ball property | Assign ball surface properties. |
ball results | Modify the usage of the ball results logic. |
ball tolerance | Set contact detection tolerances. |
ball trace | Add a ball particle trace. |
ball cfd attribute | Set the value of ball CFD attributes. |
ball cfd extra | Set ball CFD extra variables. |
ball cfd group | Specify CFD ball group names. |
ball cfd history | Add a ball CFD history. |
ball cfd initialize | Modify ball CFD attributes. |
ball cfd list | List CFD ball information. |
ball thermal attribute | Set the value of ball thermal attributes. |
ball thermal extra | Set ball thermal extra variables. |
ball thermal fix | Fix thermal ball’s temperature. |
ball thermal free | Free thermal ball’s temperature. |
ball thermal group | Specify thermal ball group names. |
ball thermal history | Add a ball thermal history. |
ball thermal initialize | Modify ball thermal attributes. |
ball thermal list | List thermal ball information. |
ball thermal property | Assign ball thermal surface properties. |
ball-zone create | Identifies overlapping balls and zones (i. |
building-blocks block create | Create a block or blocks. |
building-blocks block delete | Delete blocks. |
building-blocks block export | Export blocks. |
building-blocks block group | Assign or remove a group name to blocks. |
building-blocks block hide | Set the blocks to be hide or not. |
building-blocks block id | Perform an operation on a block (by ID). |
building-blocks block import | Import blocks from a file. |
building-blocks block list | Print information about blocks. |
building-blocks block make-hex-only | Split all triangular faces of wedge and tetrahedral blocks. |
building-blocks block multiplier | Set the zone multiplier coefficient for final zone generation. |
building-blocks block snapon | Snap a block to a geometric set. |
building-blocks block transform | Perform a general geometric transformation on points of blocks. |
building-blocks edge add-controls | Add control points to edges. |
building-blocks edge delete | Delete edges. |
building-blocks edge drape | Move the points of edges onto an external geometric set. |
building-blocks edge factor | Apply a sizing factor to zones on edges. |
building-blocks edge group | Assign or remove a group name to edges. |
building-blocks edge id | Modify the properties of an edge. |
building-blocks edge list | Print information about edges. |
building-blocks edge ratio | Apply a sizing ratio to zones on edges. |
building-blocks edge ratio-isolate | Determine whether zone ratios or factors propagate. |
building-blocks edge size | Specify the number of zones on an edge. |
building-blocks edge snapon | Snap an edge to a geometric set. |
building-blocks edge transform | Transform and edge (via its points). |
building-blocks edge type | Specify edge curve-type. |
building-blocks face add-controls | Add control points to faces. |
building-blocks face cycle | Rotate (cycle) the topology of triangular faces. |
building-blocks face delete | Delete faces. |
building-blocks face drape | Move the points of faces onto an external geometric set. |
building-blocks face group | Assign a group name to faces. |
building-blocks face id | Modify the properties of a face. |
building-blocks face list | Print information about faces. |
building-blocks face snapon | Snap a face to a geometric set. |
building-blocks face transform | Transform a face (via its points). |
building-blocks point delete | Delete points. |
building-blocks point drape | Move points onto an external geometric set. |
building-blocks point group | Assign a group name to points. |
building-blocks point list | Print information about points. |
building-blocks point merge | Merge two points. |
building-blocks point move-to | Move points. |
building-blocks point snapon | Snap points to a geometric set. |
building-blocks point transform | Transform points. |
brick assemble | Assemble an existing brick in the model. |
brick delete | Delete bricks in range. |
brick export | Export a brick as a binary file. |
brick import | Import a brick from a binary file. |
brick make | Make a brick from the current model state. |
building-blocks set arrest-triangle | Specify how to split a wedge block. |
building-blocks set auto-tolerance | Set the auto-tolerance flag for geometric manipulations. |
building-blocks set automatic-zone | Specify a automatic zoning method. |
building-blocks set break-angle | Set the break angle. |
building-blocks set create | Create a building block set. |
building-blocks set delete | Delete a building block set. |
building-blocks set export | Export current building blocks to a file. |
building-blocks set geometry | Associate a geometry set with the current set. |
building-blocks set import | Import a building blocks set. |
building-blocks set list | Print information about a building blocks set. |
building-blocks set select | Specify the current building blocks set. |
building-blocks set tolerance | Set the tolerance for geometric manipulations. |
building-blocks set validate-all | Check the validity of blocks. |
burger | - Normal viscosity Kelvin section with default value 0. |
burgers | elastic bulk modulus, K Kelvin shear modulus, G K Maxwell shear modulus, G M Kelvin... |
burgers-mohr | bulk modulus, K cohesion, c dilation angle in degrees, ψ internal friction angle... |
cap-yield | ultimate cohesion, . |
cap-yield-simplified | dimensionless bulk modulus reference value, ultimate cohesion, ultimate dilation angle,... |
cfd buoyancy | Activate/deactivate buoyancy terms. |
cfd connect | Establish the socket connection to the CFD proxy server. |
cfd coupling | Activate/deactivate PFC coupling. |
cfd cycling | Set the PFC cycling status. |
cfd interval | Specify the update interval. |
cfd list | List the CFD settings. |
cfd output | Change the coupling outputs. |
cfd porosity | Set the porosity calculation mode. |
cfd read | Read a fluid mesh or fluid property from files. |
cfd relaxation | Set the relaxation parameter. |
cfd restart | Reset the coupling time and coupling interval to the starting state. |
cfd slave | Give control of PFC to the CFD proxy server. |
cfd term | Modify terms used in drag force calculations. |
cfd update | Update the porosity, particle-applied force, and drag force. |
cfd vof | Enable/disable the volume of fluid (VOF) mode. |
clump attribute | Set the value of clump attributes. |
clump create | Create a single clump with the specified attributes. |
clump delete | Delete clumps and/or pebbles. |
clump distribute | Distribute clumps with overlaps. |
clump export | Exports clumps. |
clump extra | Set clump or pebble extra variables. |
clump fix | Fix the specified clump velocities. |
clump free | Free the specified clump velocities. |
clump generate | Generate non-overlapping clumps. |
clump group | Specify clump or pebble group names. |
clump history | Adds a history of a clump value. |
clump initialize | Modify clump attributes. |
clump list | List clump information. |
clump order | Set the rotational EOM order. |
clump property | Assign clump or pebble surface properties. |
clump replicate | Create a clump from a template. |
clump results | Modify the usage of the clump results logic. |
clump rotate | Rotate clumps. |
clump scale | Scale clumps. |
clump template | Operate on a single clump template. |
clump tolerance | Set contact detection tolerances. |
clump trace | Add a clump or pebble particle trace. |
clump cfd attribute | Set the value of clump CFD attributes. |
clump cfd extra | Set clump CFD extra variables. |
clump cfd group | Specify CFD clump group names. |
clump cfd history | Add a clump CFD history. |
clump cfd initialize | Modify clump CFD attributes. |
clump cfd list | List CFD clump information. |
clump thermal attribute | Set the value of thermal clump attributes. |
clump thermal extra | Set thermal clump or pebble extra variables. |
clump thermal fix | Fix thermal clump temperature. |
clump thermal free | Free thermal clump temperature. |
clump thermal group | Specify thermal clump or pebble group names. |
clump thermal history | Add a clump thermal history. |
clump thermal initialize | Modify clump thermal attributes. |
clump thermal list | List thermal clump information. |
clump thermal property | Assign thermal clump pebble surface properties. |
contact activate | Change the contact activate flag. |
contact apply-group | Apply contact group names to contacting pieces or bodies. |
contact cmat add | Adds a new entry to the CMAT. |
contact cmat apply | Apply the CMAT to existing contacts. |
contact cmat default | Set the default slot(s) of the CMAT. |
contact cmat list | Lists the CMAT. |
contact cmat modify | Modify an existing entry in the CMAT. |
contact cmat proximity | The contact detection distance is set to fd . |
contact cmat remove | Remove entries from the CMAT. |
contact delete | Delete contacts in specified range. |
contact detection | Set automatic detection of contacts (default: true ). |
contact extra | Set contact extra variables. |
contact group | Specify contact group names. |
contact history | Add a contact history. |
contact inhibit | Inhibit contacts in specified range. |
contact list | List contact information. |
contact method | Calls a contact method. |
contact model | Assign contact models. |
contact persist | Set the contact persistence flag. |
contact property | Assign contact properties. |
data label create | Create a user-defined label at a point in space. |
data label delete | Delete all labels within the specified range . |
data label list | List label information. |
data label modify | Modify an existing label. |
data label results | Include label data in results files. |
data scalar create | Create a scalar data entry. |
data scalar delete | Delete scalars in the range. |
data scalar export | Export scalars to the file with name s . |
data scalar group | Specify scalar group names. |
data scalar import | Import scalars from file s . |
data scalar list | List scalar information on data in the range specified. |
data scalar results | Include scalar data in results files. |
data tensor create | Create a tensor data entry. |
data tensor delete | Delete tensors in the range. |
data tensor export | Export tensors to the file with name s . |
data tensor group | Specify tensor group names. |
data tensor import | Import tensors from file s . |
data tensor list | List tensor information on data in the range specified. |
data tensor results | Include tensor data in results files. |
data vector create | Create a vector. |
data vector delete | Delete vector data objets in the range. |
data vector export | Export vectors to the file with name s . |
data vector group | Specify vector group names. |
data vector import | Import vectors from file s . |
data vector list | List vector information. |
data vector results | Include vector data in results files. |
fracture aperture | Assign apertures to fractures. |
fracture attribute | Modify fracture attributes. |
fracture cluster | Compute fracture clusters. |
fracture combine | Simplify fractures. |
fracture compute | Compute fracture statistics. |
fracture connectivity | Calculate fracture connectivity with a specified structure. |
fracture contact-model | Assign contact models via fractures. |
fracture copy | Copy fractures. |
fracture create | Create a deterministic fracture. |
fracture delete | Delete fractures. |
fracture dfn-extra | Set DFN extra variables. |
fracture dfn-group | Specify DFN group names. |
fracture export | Export fractures to file. |
fracture extra | Set fracture extra variables. |
fracture generate | Generate fractures from a statistical description. |
fracture group | Specify fracture group names. |
fracture import | Import fractures. |
fracture initialize | Modify fracture attributes. |
fracture intersections automatic-update | Set the intersection automatic-updating state. |
fracture intersections compute | Compute intersections. |
fracture intersections delete | Delete intersections. |
fracture intersections scanline | Create intersections corresponding to scanline mapping. |
fracture list | List the fracture attributes. |
fracture property | Assign fracture surface properties. |
fracture prune | Prune isolated fractures. |
fracture set-property | Assign properties in objects that intersect fractures. |
fracture template create | Create a fracture generation template. |
fracture template delete | Delete fracture generation templates. |
fracture template modify-default | Modify the default fracture generation template. |
fracture verify-file | Verify a DFN file. |
double-yield | maximum elastic bulk modulus, cohesion, dilation angle, . |
drucker-prager | bulk modulus, material parameter, material parameter, . |
element cfd attribute | Set the value of element CFD attributes. |
element cfd extra | Set element CFD extra variables. |
element cfd group | Specify CFD element group names. |
element cfd history | Add an element CFD history. |
element cfd initialize | Modify element CFD attributes. |
element cfd list | List CFD element information. |
extrude block create | Create block(s). |
extrude block delete | Delete block(s). |
extrude block group | Assign/remove a group name to blocks. |
extrude block id | Modify a single block by ID. |
extrude block list | Print information about blocks. |
extrude block multiplier | The command only applies to regular (3- or 4-sided) blocks... |
extrude block position | Modify a block by position. |
extrude edge clear | Clear all zone size and ratio settings on edges. |
extrude edge combine | Combines edges into a single edge. |
extrude edge create | Creates an edge or a set of edges. |
extrude edge delete | Delete edges. |
extrude edge group | Assign/remove a group name to edges. |
extrude edge id | Modify a single edge by ID. |
extrude edge list | Print information about edges. |
extrude edge ratio | Set the ratio. |
extrude edge ratio-isolate | The option only applies to the edges which form regular... |
extrude edge size | Set the number of zones on the edge. |
extrude mesh gradation | Specify maximum gradation f > 0 for the unstructured mesher. |
extrude mesh list | List information about global meshing parameters. |
extrude mesh mode | Specify the operating mode for the unstructured mesher. |
extrude mesh optimization | Specify optimization level 0 ≤ i ≤ 10 for the... |
extrude mesh quad-weight | Specify weight on quadrilaterals 0 ≤ f ≤ 1 for... |
extrude mesh reset | Reset all mesh parameters to defaults. |
extrude mesh shape-quality | Specify value for the shape-quality 0 ≤ f ≤ 1... |
extrude mesh target-size | Specify desired zone size (target size) inside the domain, f ... |
extrude mesh type | Specify the type of mesh. |
extrude point create | Create a point. |
extrude point delete | Delete points. |
extrude point group | Assign/remove a group name to points. |
extrude point id | Modify a single point by ID. |
extrude point list | Print information about points. |
extrude point transform | Transform points. |
extrude segment add | Adds segment(s). |
extrude segment clear | Clear all segment data. |
extrude segment delete | Delete segment(s). |
extrude segment index | Modify a segment by ID. |
extrude segment list | List the segments and their values. |
extrude segment origin | Set the start position of the first segment. |
extrude set automatic-validate | Set off/on automatic validation. |
extrude set automatic-zone | Set automatic zoning of the extrusion set. |
extrude set clear | Clear all set data (points, edges, blocks in the 2D... |
extrude set delete | Delete an extrude set. |
extrude set list | List extrude set information. |
extrude set metadata | Manipulate extrude set metadata. |
extrude set select | Set the current extrude set. |
extrude set system | Set the coordinate system. |
extrude set update-polygons | Update the internal list of closed polygons to assure that... |
finn | elastic bulk modulus, cohesion, constant, constant, constant, constant, dilation angle,... |
fish automatic-create | Set the FISH symbol automatic creation status. |
fish boolean-convert | Convert other types to Boolean values. |
fish callback | Add/remove functions to be executed in response to callback events. |
fish create | Create a FISH symbol with name s and value a . |
fish debug | Launch the FISH function s in debug mode. |
fish define | Define a new FISH function. |
fish history | Create a history of the FISH variable sym . |
fish integer-convert | For FORTRAN-based codes that use index types, indicates whether automatic... |
fish list | List FISH -related quantities. |
fish results | Set storage of FISH information in results files. |
fish set | Assign a FISH symbol. |
fish trace | Create a particle trace of the FISH variable sym . |
flatjoint | - area of element . |
fragment activate | Activate fragment auto-computation. |
fragment clear | Clear fragments. |
fragment compute | Compute fragments. |
fragment deactivate | Deactivate fragment auto-computation. |
fragment group-slot | Assign fragment IDs to groups. |
fragment list | List fragment information. |
fragment map | Get a map of fragment tabulation. |
fragment register | Register contact types for fragment analysis. |
geometry assign-groups | This command assigns group names to objects based on their... |
geometry copy | Copy geometric data. |
geometry delete | Delete geometric sets. |
geometry edge create | Create an edge. |
geometry edge delete | Delete geometric edges. |
geometry edge export | Export geometry edges data. |
geometry edge extra | Set edge extra variables. |
geometry edge group | Assign the group s to the edges of the geometric... |
geometry export | Export geometry data. |
geometry generate | Generate objects with specified shapes. |
geometry import | Import geometric data. |
geometry list | List geometry information. |
geometry move-to | Move nodes. |
geometry node create | Create a node at the position v . |
geometry node delete | Delete geometric nodes. |
geometry node export | Export geometry nodes data. |
geometry node extra | Set node extra variables. |
geometry node group | Assign the group s to the nodes of the geometric... |
geometry paint-extra | “Paint” a scalar value from a zone field. |
geometry polygon create | Create a polygon. |
geometry polygon delete | Delete geometric polygons. |
geometry polygon export | Export geometry polygons data. |
geometry polygon extra | Set polygon extra variables. |
geometry polygon group | Assign the group s to the polygons of the geometric... |
geometry refine | Refine the triangular or quadrilateral polygons in the geometric set... |
geometry rotate | Rotate nodes. |
geometry select | Specify the current geometric set (or create a new set... |
geometry separate | Separate polygons into sets. |
geometry set | Specify the current geometric set (or create a new set... |
geometry tessellate | Tessellate nodes. |
geometry translate | Translate nodes. |
geometry triangulate | Triangulate planar polygons. |
group create | Create a group. |
group list | Display the global list of group names and slot names... |
group rename | Rename a group. |
group slot | Create a slot. |
hertz | - surface gap exponent used for the dashpot force... |
history delete | All history traces are deleted. |
history export | Write the contents of the list of histories to the... |
history interval | Specifies the history-sampling interval. |
history list | List history information. |
history name label | Assigns a label with the name sl to history sn . |
history purge | The contents of all history traces are erased, but the... |
history results | indicates whether history information is stored in subsequent results files. |
hoek-brown | bulk modulus, Hoek-Brown parameter, dilation angle, , required only when... |
hoek-brown-pac | bulk modulus, Hoek-Brown parameter, Hoek-Brown parameter, Hoek-Brown parameter, Hoek-Brown parameter,... |
hydration | Material parameter of conductivity, . |
hydration-drucker-prager | reference bulk modulus for α = 1, K cte material parameter, a material... |
hysteretic | - target restitution coefficient with default value 1. |
isotropic | Matrix thermal conductivity. |
linear | - dashpot force in units force. |
linearcbond | - contact bond tensile strength in units force with... |
linearpbond | - dashpot force in units force. |
maxwell | bulk modulus, K Poisson’s ratio, v shear modulus, G Young’s modulus, E dynamic viscosity,... |
measure create | Create a measurement region. |
measure delete | Delete a measurement object. |
measure dump | Dump the cumulative size distribution data. |
measure history | Add a measure history. |
measure list | List information related to measurement regions. |
measure modify | Modify measurement regions. |
model calm | Calm the model. |
model clean | Clean the model. |
model configure | Configure an additional calculation mode. |
model creep | Set parameters for a creep material analysis. |
model cycle | Execute timesteps. |
model deterministic | Set the deterministic mode. |
model display | Set information to display during cycling. |
model domain | Specify the domain boundaries and conditions. |
model dynamic | Set parameters for a dynamic material analysis. |
model energy | Set the energy tracking state by process. |
model factor-of-safety | Set factor of safety analysis parameters. |
model fluid | Set parameters for a fluid flow analysis. |
model gravity | Set the gravity. |
model history | Create a history of a model quantity. |
model largestrain | Sets the program to use the numerical formulation for large-strain... |
model list | List a model related quantity. |
model mechanical | Set parameters for a mechanical analysis. |
model new | Clear model-state information. |
model precision | Set the listing precision. |
model random | Set the seed for the random-number generator. |
model range | Create/delete a named range. |
model restore | Restore program-state information. |
model results | Perform file operations on results files. |
model save | Save all model-state information. |
model solve | Solve to a specified limit. |
model step | Execute timesteps. |
model thermal | This command sets parameters for a thermal material analysis (only... |
model title | Set the model title. |
model update-interval | Set the number of cycles taken between updating the existing... |
model orientation-tracking | Set the orientation tracking state. |
modified-cam-clay | maximum elastic bulk modulus, slope of elastic swelling line, slope... |
mohr-coulomb | elastic bulk modulus, cohesion, dilation angle, . |
mohr-coulomb-tension | elastic bulk modulus, cohesion, dilation angle, . |
orthotropic | dip angle [degrees] of the plane defined by axes 1’-2’ dip... |
plastic-hardening | cohesion, . |
plot active | This command activates or deactivates plot s . |
plot background | Specifies the background color of the plot. |
plot clear | removes all plot items from the plot. |
plot copy | The plot is copied to the plot named sDest . |
plot create | A new plot named s is made the current (i. |
plot current | The plot named s is made the current (i. |
plot delete | The plot named s is deleted. |
plot export | The contents of the plot named s is exported to... |
plot item | Create, destroy, or modify plot items associated with the plot. |
plot legend | set attributes of the plot legend. |
plot load | attempts to load one or more user-defined plot item DLLs. |
plot movie | controls whether this plot participates in automatic movie generation. |
plot outline | controls the line used to oultine the plot and the... |
plot print-size | the size of the bitmap used when exporting plot images... |
plot rename | renames the plot named s to sNew . |
plot reset | resets the plot settings to default values, forcing a recalculation... |
plot show | This is the same as the plot current command, but... |
plot title | the font and settings used to render the title at... |
plot title-job | the font and settings used to render the job title... |
plot update | if set to off , the plot is not automatically updated... |
plot view | controls the camera view of the plot. |
power | bulk modulus, K power-law constant, A 1 power-law constant, A 2 power-law exponent, n 1 power-law exponent,... |
power-mohr | elastic bulk modulus, K cohesion, c power-law constant, A 1 power-law constant, A 2 dilation angle,... |
power-ubiquitous | elastic bulk modulus, K cohesion, c power-law constant, A 1 power-law constant, A 2 dilation angle,... |
program call | Process the specified data file(s). |
program continue | Resume processing after a program pause. |
program convert | This command is available for PFC only. |
program customer-title-1 | Set the first line of customer information. |
program customer-title-2 | Set the second line of customer information. |
program directory | Set the working directory. |
program echo | Set the echo state. |
program echo-line | Specify output to echo to the console. |
program exit | Close the program. |
program floating-point-check | Enable/disable the floating point check. |
program list | Print program information. |
program load | Load a compatible DLL. |
program log | Turn on/off logging. |
program log-file | Specify the log file by name. |
program mail | Compose and send email messages. |
program notice | Set the notice state. |
program pagination | Set the pagination state. |
program pause | Pause command processing. |
program playback | Play back a record file. |
program quit | Close the program. |
program return | Return program control. |
program stop | Close the program. |
program system | Send commands to DOS. |
program threads | Set the number of threads for calculations and plotting. |
program undo | Undo commands. |
program warning | Set the warning state. |
project execute | Execute the current project. |
project list | List project information. |
project new | Clear program-state information. |
project restore | Restores the project file name s . |
project save | Save the current project to a file. |
project save-plugins | Save the currently loaded plugins with the project file. |
range | Create a range phrase. |
rblock attribute | Set the value of rigid block attributes. |
rblock construct | Construct a set of rigid blocks. |
rblock contact-resolution | Set the default contact resolution behavior involving rigid blocks. |
rblock create | Create a single rigid block with the specified attributes. |
rblock cut | Cut the rigid blocks in range. |
rblock delete | Delete rigid blocks. |
rblock dilate | Change the rigid block rounding by dilation. |
rblock distribute | Distribute rigid blocks with overlaps. |
rblock erode | Change the rigid block rounding by erosion. |
rblock export | Exports rigid blocks. |
rblock extra | Set rigid block extra variables. |
rblock fix | Fix the specified rigid block velocities. |
rblock free | Free the specified rigid block velocities. |
rblock generate | Generate non-overlapping rigid blocks. |
rblock group | Specify rigid block group names. |
rblock history | Adds a history of a rigid block value. |
rblock import | Import rigid blocks. |
rblock initialize | Modify rigid block attributes. |
rblock list | List rigid block information. |
rblock merge | Merge rigid blocks in range. |
rblock property | Assign rigid block surface properties. |
rblock replicate | Replicate a rigid block from the template with name s . |
rblock results | Modify the usage of the rblock results logic. |
rblock rotate | Rotate rigid blocks. |
rblock scale | Scale rigid blocks. |
rblock template | Operate on a single rigid block template. |
rblock tolerance | Set contact detection tolerances. |
rblock trace | Add a rigid block particle trace. |
rblock thermal attribute | Set the value of rigid block thermal attributes. |
rblock thermal extra | Set rigid block thermal extra variables. |
rblock thermal fix | Fix thermal rigid block’s temperature. |
rblock thermal free | Free thermal rigid block’s temperature. |
rblock thermal group | Specify thermal rigid block group names. |
rblock thermal history | Add a rigid block thermal history. |
rblock thermal initialize | Modify rigid block thermal attributes. |
rblock thermal list | List thermal rigid block information. |
rblock thermal property | Assign rigid block thermal surface properties. |
rrlinear | - dashpot force in units force. |
smoothjoint | - joint dip direction in units degrees with default... |
softbond | - dashpot force in units force. |
softening-ubiquitous | elastic bulk modulus, matrix cohesion, = matrix cohesion, matrix... |
strain-softening | elastic bulk modulus, cohesion, dilation angle, . |
structure damping | Set the structural element logic damping scheme. |
structure list information | Lists general information about structural element settings. |
structure results | Controls if and what values are saved from zones in... |
structure safety-factor | Set the safety factor. |
structure scale-rotational-mass | This value applies to dynamic analysis only. |
structure beam apply | Assign uniform applied distributed loads. |
structure beam create | Create a beam represented by one or more elements. |
structure beam delete | Delete all beam elements in the range. |
structure beam group | Assign all beam elements in the range to the group... |
structure beam hide | This commands hides or un-hides all beam elements in the... |
structure beam history | Samples beam responses that include force and moment carried by... |
structure beam import | Create beam elements from an outside source. |
structure beam initialize | Initializes quantities on the element. |
structure beam list | List information about beam elements. |
structure beam property | Assigns a property to elements in the range. |
structure beam refine | This command refines an existing element in the range by... |
structure beam select | This command selects or de-selects all elements in the range. |
structure cable apply | Applies conditions to cable elements in the range. |
structure cable create | Create a cable, represented by one or more elements. |
structure cable delete | Delete all cable elements in the range. |
structure cable group | Assign all cable elements in the range to the group... |
structure cable hide | This commands hides or un-hides all cable elements in the... |
structure cable history | Sample cable responses. |
structure cable import | Create cable elements from an outside source. |
structure cable initialize | Initializes quantities on the element. |
structure cable list | List information about cables. |
structure cable property | Assigns a property to elements in the range. |
structure cable refine | This command refines an existing element in the range by... |
structure cable select | This commands selects or de-selects all elements in the range. |
structure geogrid apply | Assign uniform applied pressure f to all geogrid elements in... |
structure geogrid create | Create a geogrid. |
structure geogrid delete | Delete all geogrid elements in the range. |
structure geogrid group | Assign all geogrid elements in the range to the group... |
structure geogrid hide | This commands hides or un-hides all geogrid elements in the... |
structure geogrid history | Sample geogrid responses. |
structure geogrid import | Create geogrid elements from an outside source. |
structure geogrid initialize | Initializes quantities on the element. |
structure geogrid list | List properties and response of each geogrid element in the... |
structure geogrid property | Assigns a property to elements in the range. |
structure geogrid recover | Stress-recovery for geogrid elements. |
structure geogrid refine | This command refines elements in the range by subdividing them... |
structure geogrid select | This commands selects or de-selects all elements in the range. |
structure liner apply | Assign uniform applied pressure f to all liner elements in... |
structure liner create | Create a liner. |
structure liner delete | Delete all liner elements in the range. |
structure liner gap-factor | Sets the gap factor used during large-strain sliding of liner... |
structure liner group | Assign all liner elements in the range to the group... |
structure liner hide | This commands hides or un-hides all liner elements in the... |
structure liner history | Sample liner responses. |
structure liner import | Create liner elements from an outside source. |
structure liner initialize | Initializes quantities on the element. |
structure liner list | List properties and responses of each liner element in the... |
structure liner property | Assigns a property to elements in the range. |
structure liner recover | Stress recovery for liner elements. |
structure liner refine | this command refines elements in the range by subdividing them... |
structure liner select | This commands selects or de-selects all elements in the range. |
structure link attach | Set attachment conditions for the specified link directions. |
structure link create | Creates new links on structure nodes in the range. |
structure link delete | Delete all links in the range. |
structure link group | Assign all links in the range to the group with... |
structure link hide | This commands hides or un-hides all links in the range. |
structure link history | Samples relative displacement or force from a single degree-of-freedom in... |
structure link list | List values and information about link objects in the range. |
structure link property | List a property of a deformable force-displacement model in the... |
structure link select | This commands selects or de-selects all links in the range. |
structure link slide | Set the large-strain sliding flag. |
structure link tolerance-contact | Set the tolerance used when establishing node-to-zone links. |
structure link tolerance-node | Set the tolerance used when establishing node-to-node links. |
structure link tolerance-slide | Set the tolerance used when updating node-to-zone links in response... |
structure node apply | Set generalized point loads for all nodes in the range. |
structure node create | Create a structural node at location v . |
structure node damping-local | Sets the local-damping factor to f for all nodes in... |
structure node delete | Delete all nodes in the range. |
structure node fix | Fix conditions for all nodes in the range, thereby preventing... |
structure node free | Free fixed conditions for all nodes in the range. |
structure node group | Assign all nodes in the range to the group with... |
structure node hide | This command hides or un-hides all nodes in the range. |
structure node history | Samples nodal responses. |
structure node initialize | Initialize quantities on all structure nodes in the range. |
structure node join | This command creates node-to-node links on all nodes in the... |
structure node list | Show information about structural element nodes in the range. |
structure node select | This commands selects or de-selects all structural nodes in the... |
structure node system-local | Set the orientation of the node-local system for all nodes... |
structure pile apply | Assign uniform applied distributed loads. |
structure pile create | Create a pile represented by one or more elements. |
structure pile delete | Delete all pile elements in the range. |
structure pile group | Assign all pile elements in the range to the group... |
structure pile hide | This commands hides or un-hides all pile elements in the... |
structure pile history | Sample pile responses. |
structure pile import | Create pile elements from an outside source. |
structure pile initialize | Initializes quantities on the element. |
structure pile list | List information about piles. |
structure pile property | Assign the specified property to all elements in the range. |
structure pile refine | this command refines an existing element in the range by... |
structure pile select | This command selects or de-selects all elements in the range. |
structure shell apply | Assign uniform applied pressure f to all shell elements in... |
structure shell create | Create a shell. |
structure shell delete | Delete all shell elements in the range. |
structure shell group | Assign all shell elements in the range to the group... |
structure shell hide | This command hides or un-hides all shell elements in the... |
structure shell history | Sample shell responses. |
structure shell import | Create shell elements from an outside source. |
structure shell initialize | Initializes quantities on the element. |
structure shell list | List properties and response of each shell element in the... |
structure shell property | Assigns a property to elements in the range. |
structure shell recover | Stress-recovery for shell elements. |
structure shell refine | This command refines elements in the range by subdividing them... |
structure shell select | This commands selects or de-selects all elements in the range. |
swell | elastic bulk modulus, cohesion, swelling property, swelling property, swelling property,... |
table | Determines if the contents of tables are included in any... |
table add | Add an entry to the end of table s . |
table clear | Remove all entries of from table s . |
table delete | Delete table s . |
table export | The contents of the specified table are output to file... |
table import | Read file sfile into table s . |
table insert | Insert an entry into table s , sorted by its x-value. |
table label | Set a label for table s . |
table list | List table information. |
table position | Substitute the specified (x,y) pair for the stored x- and... |
table sort | Cause all entries in table s to be sorted in... |
trace delete | Delete all traces. |
trace export | Export the contents of the list of traces to the... |
trace interval | Specify the step interval on which trace values will be... |
trace list | List trace information. |
trace name label | Specify the label for trace s . |
trace purge | Clear the contents of all traces while retaining the list... |
trace results | indicates whether trace information is stored in subsequent results files. |
ubiquitous-anisotropic | dip angle [degrees] of weakness plane dip direction [degrees] of weakness... |
ubiquitous-joint | elastic bulk modulus, cohesion, dilation angle, . |
wall active-sides | Specify which side(s) of facets are active. |
wall addfacet | Add a facet a wall. |
wall attribute | Set the value of wall attributes. |
wall create | Create a wall from vertices. |
wall delete | Delete walls and/or facets. |
wall export | Exports walls. |
wall extra | Set wall or facet extra variables. |
wall generate | Generate walls with specified shapes. |
wall group | Specify wall or facet group names. |
wall history | Adds a history of a wall value. |
wall import | Import a wall. |
wall initialize | Modify wall attributes. |
wall list | List wall information. |
wall property | Assign facet surface properties. |
wall resolution | Modify the contact-resolution strategy as outlined in the “ wall_faceted ” section. |
wall results | Modify the usage of the wall results logic. |
wall rotate | Rotate walls. |
wall servo | The wall servo provides the ability to control the translational... |
wall tolerance | Set contact detection tolerances. |
wall velocity-conveyor | Assign a rotational conveyor velocity to facets. |
wall-structure create | Wrap FLAC3D structural elements with PFC walls. |
wall-structure full-computation | Turn on/off full computation mode. |
wall-structure stiffness-factor | Set the multiplicative factor for stiffnesses to be added to... |
wall-structure update-tolerance | Set the tolerance for triggering structural element updates. |
wall thermal attribute | Set the value of thermal wall attributes. |
wall thermal extra | Set thermal wall or facet extra variables. |
wall thermal group | Specify thermal wall or facet group names. |
wall thermal initialize | Modify wall thermal attributes. |
wall thermal list | List thermal wall information. |
wall thermal property | Assign thermal wall facet surface properties. |
wall-zone create | Wrap FLAC3D zones with PFC walls. |
wall-zone full-computation | Turn on/off full computation mode. |
wall-zone stiffness-factor | Set the multiplicative factor for stiffnesses to be added to... |
wall-zone update-tolerance | Set the tolerance for triggering zone updates. |
wipp | activation energy, Q bulk modulus, K WIPP model constant, A WIPP model constant,... |
wipp-drucker | activation energy, Q bulk modulus, K material parameter, k ϕ WIPP model constant, A WIPP... |
wipp-salt | activation energy, Q bulk modulus, K final, intact salt, bulk modulus, K f WIPP... |
zone apply | Create or modify zone conditions. |
zone apply-remove | Remove a zone condition. |
zone attach | Create attached gridpoints. |
zone cmodel | Assign, load, or get information on a zone constitutive model. |
zone copy | Copy zones. |
zone create | The zone. |
zone creep | This command sets parameters for a time-dependent creep material analysis... |
zone delete | Delete zones. |
zone densify | This command finds all zones in the range and subdivides... |
zone dynamic | This command sets parameters for a dynamic model (only available... |
zone export | Exports a grid to a file. |
zone fluid | This command sets parameters for a groundwater fluid flow analysis. |
zone generate | This set of commands generates zones based on an algorithm,... |
zone geometry-test | Evaluate the integrity of model zones. |
zone geometry-tolerance | This command defines the tolerance before an illegal geometry error... |
zone geometry-update | Updates associated with geometric or property changes are performed at... |
zone group | Add group name s to the zones in the range. |
zone hide | This commands hides or un-hides all zones in the range. |
zone history | Adds a history of a zone value. |
zone import | Import a grid from a file. |
zone initialize | Initialize a variable on all zones in the range. |
zone initialize-stresses | Initialize zone stresses based on the density of the zones... |
zone list | List zone data. |
zone mechanical | Sets parameters for a static mechanical analysis, that are specific... |
zone nodal-mixed-discretization | Activate or deactivate the nodal mixed discretization (nmd) feature. |
zone property | Make a constitutive model(s) property assignment. |
zone property-distribution | Modify a zone constitutive model property. |
zone ratio | The ratio limit for mechanical, thermal and fluid-flow calculations using... |
zone reflect | All zones within the given range are reflected across the... |
zone relax | Creates and modifies a special apply condition on the zones... |
zone results | Controls if and what values are saved from zones in... |
zone select | This commands selects or de-selects all zones in the range. |
zone separate | separates internal faces specified by the range . |
zone split | Splits zones in the range into multiple hexahedral zones. |
zone thermal | Set parameters for a thermal analysis (only available if model... |
zone trace | Trace zone position and velocity. |
zone validate | This command is new and experimental. |
zone water | This command initializes pore pressures, changing the effective stresses. |
zone face apply | This command is used to apply boundary conditions at surface... |
zone face apply-remove | Remove zone face apply conditions, which are described in the... |
zone face group | Adds a group name s to zone faces included in... |
zone face hide | Hide or un-hide zone faces in the range. |
zone face list | List information about zone faces. |
zone face select | Select or deselect zone faces in the range. |
zone face skin | Skin the model to automatically generate face groups. |
zone face westergaard | Applies the Westergaard approximation for the dynamic response of water... |
zone face westergaard-remove | Removes any applied westergaard condition on the faces in the... |
zone gridpoint create | Create a single gridpoint. |
zone gridpoint fix | Fix a property at all gridpoints in the range. |
zone gridpoint force-reaction | For each gridpoint in the range, in each of the... |
zone gridpoint free | Free properties at gridpoints in the range. |
zone gridpoint group | Assign group name s to zone gridpoints in the range. |
zone gridpoint initialize | Assign or initialize values to all gridpoints in the range. |
zone gridpoint list | Display gridpoint information in the console. |
zone gridpoint merge | Attempts to merge all gridpoints in the range. |
zone gridpoint system | Set the local coordinate system for gridpoints within the range. |
zone interface create | Create nodes or elements on interface s . |
zone interface effective | The effective stress will be used in the interface calculation... |
zone interface element | Manage zone interface elements. |
zone interface list | Show summary data on interfaces. |
zone interface node | Configure interface nodes. |
zone interface permeability | Interfaces are permeable by default. |
zone interface tolerance-contact | Sets the maximum depth of penetration (of faces that contact... |
FISH Reference Summary
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. |
ball.cfd.find(INT) | Find a CFD ball. |
ball.cfd.inbox(VEC,VEC<,BOOL>) | Get CFD balls with extents intersecting a box. |
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.typeid | Get the CFD ball type number. |
ball.energy(STR) | Get the ball total energy contribution. |
ball.find(INT) | Find a ball. |
ball.groupmap(STR<,INT>) | Get balls that belong to a group. |
ball.inbox(VEC,VEC<,BOOL>) | Get balls with extents intersecting a box. |
ball.list | Get the global ball list. |
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.near(VEC<,FLT>) | Find the closest ball to a point. |
ball.num | Get the number of balls. |
ball.thermal.find(INT) | Find a thermal ball. |
ball.thermal.inbox(VEC,VEC<,BOOL>) | Get thermal balls with extents intersecting a box. |
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.typeid | Get the thermal ball type number. |
ball.typeid | Get the ball type number. |
ball.zone.ball.list | Get the global list of ball-zone coupled balls. |
ball.zone.ball.typeid | Get the ball-zone coupled ball type number. |
ball.zone.gp.list | Get the global list of ball-zone coupled gridpoints. |
ball.zone.gp.typeid | Get the ball-zone coupled gridpoint type number. |
boolean(BOOL/NUM/PNT) | Create a Boolean. |
brick.find(INT) | Find a brick. |
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. |
clump.cfd.find(INT) | Find a CFD clump. |
clump.cfd.inbox(VEC,VEC<,BOOL>) | Get CFD clumps with extents intersecting a box. |
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.find(INT) | Find a CFD pebble. |
clump.cfd.pebble.inbox(VEC,VEC<,BOOL>) | Get CFD pebbles with extents intersecting a box. |
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.typeid | Get the CFD pebble type number. |
clump.cfd.typeid | Get the CFD clump type number. |
clump.energy(STR) | Get the clump total energy contribution. |
clump.find(INT) | Find a clump. |
clump.groupmap(STR<,INT>) | Get clumps that belong to a group. |
clump.inbox(VEC,VEC<,BOOL>) | Get clumps with extents intersecting a box. |
clump.list | Get the global clump list. |
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.near(VEC<,FLT>) | Find the closest clump to a point. |
clump.num | Get the number of clumps. |
clump.pebble.find(INT) | Find a pebble. |
clump.pebble.groupmap(STR<,INT>) | Get pebbles that belong to a group. |
clump.pebble.inbox(VEC,VEC<,BOOL>) | Get clump pebbles with extents intersecting a box. |
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.typeid | Get the pebble type number. |
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.maxid | Get the maximum clump template ID. |
clump.template.num | Get the number of clump templates. |
clump.template.typeid | Get the clump template type number. |
clump.thermal.find(INT) | Find a thermal clump. |
clump.thermal.inbox(VEC,VEC<,BOOL>) | Get thermal clumps with extents intersecting a box. |
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.find(INT) | Find a thermal pebble. |
clump.thermal.pebble.inbox(VEC,VEC<,BOOL>) | Get thermal pebbles with extents intersecting a box. |
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.typeid | Get the thermal pebble type number. |
clump.thermal.typeid | Get the thermal clump type number. |
clump.typeid | Get the clump type number. |
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.energy.sum(STR<,STR>) | Get the current value of an energy partition accumulated over... |
contact.find(STR/INT,INT<,INT>) | Find a contact. |
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.list(<STR>) | Access the active contacts list. |
contact.list.all(<STR>) | Access the entire contact list, including inactive contacts. |
contact.num(<STR>) | Return the number of active contacts. |
contact.num.all(<STR>) | Return the number of contacts, including inactive ones. |
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. |
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.face.num | Get the number of faces per CFD element. |
element.cfd.find(INT) | Find a CFD element. |
element.cfd.inbox(VEC,VEC<,BOOL>) | Get CFD elements with extents intersecting a box. |
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.num | Get the number of nodes per CFD element. |
element.cfd.num | Get the number of CFD elements. |
element.cfd.typeid | Get the CFD element type number. |
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. |
fragment.catalog | Get the fragment catalog. |
fragment.catalog.num(<flt>) | Get the fragment catalog number. |
fragment.find(INT) | Find a fragment. |
fragment.history(BODY_PNT) | Get the body fragment history. |
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. |
geom.edge.find(GSET_PNT,INT) | Find an edge. |
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.typeid | Get the edge type number. |
geom.node.find(GSET_PNT,INT) | Find a node. |
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.typeid | Get the node type number. |
geom.poly.find(GSET_PNT,INT) | Find a polygon. |
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.typeid | Get the polygon type number. |
geom.set.create(STR) | Creates a new geometry set with the provided name. |
geom.set.find(INT/STR) | Find a geometry set. |
geom.set.list | Get the global geometry set list. |
geom.set.maxid | Get the maximum geometry set ID. |
geom.set.num | Get the number of geometry sets. |
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. |
index(NUM/STR) | Create a positive integer. |
int(BOOL/NUM/STR) | Create an integer. |
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. |
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.find(INT) | Find a measurement object. |
measure.list | Get the list of measurement objects. |
measure.maxid | Get the maximum measurement ID. |
measure.num | Get the number of measurement objects. |
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.energy(STR) | Get the rigid block total energy contribution. |
rblock.find(INT) | Find a rigid block. |
rblock.groupmap(STR<,INT>) | Get rigid blocks that belong to a group. |
rblock.inbox(VEC,VEC<,BOOL>) | Get rigid blocks with extents intersecting a box. |
rblock.list | Get the global rigid block list. |
rblock.maxid | Get the maximum rigid block ID. |
rblock.mech.ratio.avg | Get the rigid block average unbalanced force ratio. |
rblock.mech.ratio.local | Get the rigid block maximum local unbalanced force ratio. |
rblock.mech.ratio.max | Get the rigid block maximum unbalanced force ratio. |
rblock.mech.unbal.max | Get the rigid block maximum unbalanced force. |
rblock.near(VEC<,FLT>) | Find the closest rigid block to a point. |
rblock.num | Get the number of rigid blocks. |
rblock.template.find(INT) | Find a rigid block template. |
rblock.template.list | Get the global rigid block template list. |
rblock.template.maxid | Get the maximum rigid block template ID. |
rblock.template.num | Get the number of rigid block templates. |
rblock.template.typeid | Get the rigid block template type number. |
rblock.thermal.find(INT) | Find a thermal rigid block. |
rblock.thermal.inbox(VEC,VEC<,BOOL>) | Get thermal rigid blocks with extents intersecting a box. |
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.typeid | Get the thermal rigid block type number. |
rblock.typeid | Get the rigid block type number. |
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.check(STRUCT_PNT,STRUCT_PNT) | Check that structures are of the same type. |
struct.name(STRUCT_PNT) | Get the name of a structure. |
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.energy(STR) | Get the wall total energy contribution. |
wall.facet.find(INT) | Find a facet. |
wall.facet.groupmap(STR<,INT>) | Get facets that belong to a group. |
wall.facet.inbox(VEC,VEC<,BOOL>) | Get facets with extents intersecting a box. |
wall.facet.list | Get the global facet list. |
wall.facet.maxid | Get the maximum facet ID. |
wall.facet.near(VEC<,W_PNT,FLT>) | Find the closest facet to a point. |
wall.facet.num | Get the number of facets. |
wall.facet.typeid | Get the facet type number. |
wall.find(INT) | Find a wall. |
wall.groupmap(STR<,INT>) | Get walls that belong to a group. |
wall.inbox(VEC,VEC<,BOOL>) | Get walls with extents intersecting a box. |
wall.list | Get the global wall list. |
wall.maxid | Get the maximum wall ID. |
wall.near(VEC<,FLT>) | Find the closest wall to a point. |
wall.num | Get the number of walls. |
wall.thermal.facet.find(INT) | Find a thermal facet. |
wall.thermal.facet.inbox(VEC,VEC<,BOOL>) | Get thermal facets with extents intersecting a box. |
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.typeid | Get the thermal facet type number. |
wall.thermal.find(INT) | Find a thermal wall. |
wall.thermal.inbox(VEC,VEC<,BOOL>) | Get thermal walls with extents intersecting a box. |
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.typeid | Get the thermal wall type number. |
wall.typeid | Get the wall type number. |
wall.vertex.find(INT) | Find a vertex. |
wall.vertex.inbox(VEC,VEC) | Get wall vertices in a box. |
wall.vertex.list | Get the global vertex list. |
wall.vertex.maxid | Get the maximum vertex ID. |
wall.vertex.near(VEC<,FLT>) | Find the closest vertex to a point. |
wall.vertex.num | Get the number of wall vertices. |
wall.vertex.typeid | Get the vertex type number. |
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.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.isgroup(BCF_PNT,STR<,STR>) | Query the existence of a group. |
ball.cfd.pos(BCF_PNT<,INT>) | Get the CFD ball position. |
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.euler(B_PNT<,INT>)(3D ONLY) | Get/set the ball orientation. |
ball.extra(B_PNT<,INT>) | Get/set ball extra variable. |
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.id(B_PNT) | Get the ball ID. |
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.mass(B_PNT) | Get the inertial ball mass. |
ball.mass.real(B_PNT) | Get the real (gravitational) ball mass. |
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.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.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.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.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.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.mass.factor(BZB_PNT) | Get/set the ball-zone coupled ball mass factor. |
ball.zone.gp.gp(GP_PNT) | Get the gridpoint pointer. |
ball.zone.gp.mass.factor(BZGP_PNT) | Get/set the ball-zone coupled gridpoint mass factor. |
brick.assemble(BR_PNT,VEC<,INT><,INT><,INT>) | Replicate a brick. |
brick.delete(BR_PNT) | Delete a brick. |
brick.id(BR_PNT) | Get the brick ID. |
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.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.isgroup(CLCF_PNT,STR<,STR>) | Query the existence of a group. |
clump.cfd.pebble.clump(CLPCF_PNT) | Get the CFD pebble’s CFD clump. |
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.isgroup(CLPCF_PNT,STR<,STR>) | Query the existence of a group. |
clump.cfd.pebble.pebble(CLPCF_PNT) | Get the host mechanical pebble. |
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.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.euler(CL_PNT<,INT>)(3D ONLY) | Get/set the clump orientation. |
clump.extra(CL_PNT<,INT>) | Get/set a clump extra variable. |
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.id(CL_PNT) | Get the clump ID. |
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.mass(CL_PNT) | Get the inertial clump mass. |
clump.mass.real(CL_PNT) | Get the real (gravitational) clump mass. |
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.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.group(CLP_PNT<,STR>) | Get/set pebble groups. |
clump.pebble.group.remove(CL_PNT,STR) | Remove pebble groups. |
clump.pebble.id(CLP_PNT) | Get the pebble ID. |
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.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.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.make(CL_PNT,STR) | Make a clump template from a clump. |
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.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.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.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.isgroup(CLT_PNT,STR<,STR>) | Query the existence of a group. |
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.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.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.pebble(CLPTH_PNT) | Get the host mechanical pebble. |
clump.thermal.pebble.prop(CLPTH_PNT,STR) | Get/set a thermal pebble property. |
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.vel(CL_PNT<,INT>) | Get/set the clump velocity. |
clump.vol(CL_PNT) | Get/set the clump volume. |
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.extra(C_PNT<,INT>) | Get/set contact extra variable. |
contact.fid(C_PNT) | Get the contact fracture ID. |
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.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.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.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. |
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. |
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.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.isgroup(ECF_PNT,STR<,STR>) | Query the existence of a group. |
element.cfd.node.adjacentmap(ECF_PNT) | Get CFD elements sharing a node. |
element.cfd.node.pos(ECF_PNT,INT<,INT>) | Get the CFD element node position. |
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.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. |
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.childmap(FG_PNT) | Get the children fragment IDs. |
fragment.id(FG_PNT) | Get the fragment ID. |
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.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.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.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.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.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.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.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.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.set.closest(GSET_PNT,VEC<,FLT>) | Get closest node coordinate vector from the position supplied . |
geom.set.create(STR<,INT>) | Create a geometry set. |
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.id(GSET_PNT) | Get the 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.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. |
measure.coordination(MEAS_PNT) | Get the measurement coordination number. |
measure.delete(MEAS_PNT) | Delete a measurement object. |
measure.id(MEAS_PNT) | Get the measurement ID. |
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. |
rblock.aspect.ratio(RB_PNT) | Get the rigid block aspect ratio. |
rblock.ball.pos(RB_PNT<,INT>) | Get the rigid block ball position. |
rblock.ball.radius(RB_PNT) | Get the rigid block ball radius. |
rblock.collide(RB_PNT,RB_PNT) | Get the intersection status of two rigid blocks. |
rblock.contactmap(RB_PNT<,INT,PNT>) | Get active contacts around a rblock. |
rblock.contactmap.all(RB_PNT<,INT,PNT>) | Get all contacts around a rigid block. |
rblock.contactnum(RB_PNT<,INT>) | Get number of active contacts around a rblock. |
rblock.contactnum.all(RB_PNT<,INT>) | Get number of contacts around a rblock. |
rblock.damp(RB_PNT) | Get/set rigid block local damping factor. |
rblock.delete(RB_PNT) | Delete a rigid block. |
rblock.density(RB_PNT) | Get/set rigid block density. |
rblock.disp(RB_PNT<,INT>) | Get/set the rigid block displacement. |
rblock.euler(RB_PNT<,INT>)(3D ONLY) | Get/set the rigid block orientation. |
rblock.extra(RB_PNT<,INT>) | Get/set rigid block extra variable. |
rblock.facet.area(RB_PNT,INT) | Get the rigid block facet area. |
rblock.facet.centroid(RB_PNT,INT<,INT>) | Get the facet centroid. |
rblock.facet.closest(RB_PNT,INT,VEC<,INT>) | Get the closest point on a facet. |
rblock.facet.map(RB_PNT) | Get the facet map. |
rblock.facet.normal(RB_PNT,INT<,INT>) | Get the facet normal. |
rblock.facet.num(RB_PNT) | Get the facet count. |
rblock.facet.vertex.pos(RB_PNT,INT,INT<,INT>) | Get the facet vertex position. |
rblock.fix(RB_PNT,INT) | Get/set rigid block fixity condition. |
rblock.force.app(RB_PNT<,INT>) | Get/set the rigid block applied force. |
rblock.force.contact(RB_PNT<,INT>) | Get/set the rigid block contact force. |
rblock.force.unbal(RB_PNT<,INT>) | Get the rigid block unbalanced force. |
rblock.fragment(RB_PNT) | Get/set rigid block fragment ID. |
rblock.group(RB_PNT<,STR>) | Get/set rigid block groups. |
rblock.group.remove(RB_PNT,STR) | Remove rigid block groups. |
rblock.id(RB_PNT) | Get the rigid block ID. |
rblock.inglobal(RB_PNT,VEC) | Rotate a vector from principal system. |
rblock.inprin(RB_PNT,VEC) | Rotate a vector to principal system. |
rblock.isbonded(RB_PNT<,INT,PNT>) | Get the rigid block bonded state. |
rblock.isgroup(RB_PNT,STR<,STR>) | Query the existence of a group. |
rblock.isprop(RB_PNT,STR) | Query the existence of a property. |
rblock.mass(RB_PNT) | Get the inertial rigid block mass. |
rblock.mass.real(RB_PNT) | Get the real (gravitational) rigid block mass. |
rblock.moi(RB_PNT<,INT<,INT>>) | Get the rigid block moment of inertia. |
rblock.moi.fix(RB_PNT) | Get/set the moment of inertia fixity state. |
rblock.moi.prin(RB_PNT<,INT>) | Get the rigid block principal moment of inertia. |
rblock.moi.prin.real(RB_PNT<,INT>) | Get/set the rigid block real principal moment of inertia. |
rblock.moi.real(RB_PNT<,INT<,INT>>) | Get/set the rigid block real moment of inertia. |
rblock.moment.app(RB_PNT<,INT>) | Get/set the rigid block applied moment. |
rblock.moment.contact(RB_PNT<,INT>) | Get/set the rigid block contact moment. |
rblock.moment.unbal(RB_PNT<,INT>) | Get the rigid block unbalanced moment. |
rblock.pos(RB_PNT<,INT>) | Get/set the rigid block position. |
rblock.prop(RB_PNT,STR) | Get/set a rigid block property. |
rblock.rotation(RB_PNT)(2D ONLY) | Get/set the rigid block orientation. |
rblock.rounding(RB_PNT) | Get the rigid block rounding. |
rblock.scalesphere(RB_PNT,FLT) | Scale the rigid block to an equivalent sphere. |
rblock.scalevol(RB_PNT,FLT) | Scale the rigid block. |
rblock.spin(RB_PNT<,INT>) | Get/set the rigid block angular velocity. |
rblock.stress(RB_PNT<,INT,INT>) | Get the stress tensor arising from all contacts acting on... |
rblock.template.delete(RBT_PNT) | Delete a rigid block template. |
rblock.template.moi(RBT_PNT<,INT<,INT>>) | Get the rigid block template moment of inertia. |
rblock.template.moi.prin(RBT_PNT<,INT>) | Get the rigid block template principal moment of inertia. |
rblock.template.name(RBT_PNT) | Get the rigid block template name. |
rblock.template.vol(RBT_PNT) | Get/set the rigid block template volume. |
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.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.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.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.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. |
wall.addfacet(W_PNT,VEC,ANY) | Add a facet. |
wall.closed(W_PNT) | Get the wall closure status. |
wall.contactmap(W_PNT<,INT><,PNT>) | Get active contacts around a wall. |
wall.contactmap.all(W_PNT<,INT><,PNT>) | Get all contacts around a wall. |
wall.contactnum(W_PNT<,INT>) | Get number of active contacts around a wall. |
wall.contactnum.all(W_PNT<,INT>) | Get number of contacts around a wall. |
wall.convex(W_PNT) | Get the convexity status. |
wall.cutoff(W_PNT) | Get/set the cutoff angle. |
wall.delete(W_PNT) | Delete a wall. |
wall.disp(W_PNT<,INT>) | Get/set the wall displacement. |
wall.euler(W_PNT<,INT>)(3D ONLY) | Get/set the wall orientation. |
wall.extra(W_PNT<,INT>) | Get/set wall extra variable. |
wall.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.group(WF_PNT<,STR>) | Get/set facet groups. |
wall.facet.group.remove(WF_PNT,STR) | Remove facet groups. |
wall.facet.id(WF_PNT) | Get the facet ID. |
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.normal(WF_PNT<,INT>) | Get the facet normal. |
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.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.force.contact(W_PNT<,INT>) | Get the sum of all contact forces acting on a... |
wall.fragment(W_PNT) | Get/set wall fragment ID. |
wall.group(W_PNT<,STR>) | Get/set wall groups. |
wall.group.remove(W_PNT,STR) | Remove wall groups. |
wall.id(W_PNT) | Get the wall ID. |
wall.inside(W_PNT,VEC) | Test whether a point is inside a wall. |
wall.isbonded(W_PNT<,INT,PNT>) | Get the wall bonded state. |
wall.isgroup(W_PNT,STR<,STR>) | Query the existence of a group. |
wall.moment.contact(W_PNT<,INT>) | Get the wall contact moment. |
wall.name(W_PNT) | Get the wall name. |
wall.pos(W_PNT<,INT>) | Get/set the wall position. |
wall.prop(W_PNT,STR) | Set a property of all facets. |
wall.rotation(W_PNT)(2D ONLY) | Get/set the wall orientation. |
wall.rotation.center(W_PNT<,INT>) | Get/set the wall center of rotation. |
wall.spin(W_PNT<,INT>) | Get/set the wall angular velocity. |
wall.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.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.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.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.wall(WFTH_PNT) | Get the thermal facet’s thermal wall. |
wall.thermal.facetlist(WTH_PNT) | Get the facets of 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.isgroup(CLT_PNT,STR<,STR>) | Query the existence of a group. |
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.wall(WTH_PNT) | Get the host mechanical wall. |
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.id(WV_PNT) | Get the vertex ID. |
wall.vertex.pos(WV_PNT<,INT>) | Get/set the vertex position. |
wall.vertex.vel(WV_PNT<,INT>) | Get/set the vertex velocity. |
wall.vertexlist(W_PNT) | Get the vertices of a wall. |
Was this helpful? ... | PFC © 2019, Itasca | Updated: Apr 26, 2019 |