itasca_browse_reference
Browse ITASCA reference documentation by engine to find model properties, range filter syntax, and plot item configuration. Navigate categories or full paths for setup details.
Instructions
Browse ITASCA reference documentation (syntax elements, model properties).
Works across engines via the required software selector (pfc/flac/3dec).
References are language elements used within commands, not standalone commands.
Navigation levels:
No topic: All reference categories for the engine
Category (e.g., "constitutive-models"): List items in category
Full path (e.g., "constitutive-models mohr-coulomb"): Full documentation
Sub-item path (e.g., "plot-items zone contour"): Sub-item details
When to use:
Need material/contact/joint model property names (kn, ks, fric, cohesion, friction, ...)
Need range filtering syntax (position, cylinder, group, id)
Need plot item configuration (contour, label, color-by, cut, transparency, legend)
Setting up model-assignment commands (e.g. "... cmodel assign ... property ...")
Using range filters in any command
Configuring "plot item create" commands
Related tools:
itasca_browse_commands: Command syntax (e.g., "zone create")
itasca_query_command: Search commands by keywords
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | No | Reference topic to browse (space-separated path). Categories vary by engine — call with no topic first to discover them. Examples (by engine): - None or '': List all reference categories for the chosen engine - PFC 'contact-models' / 'contact-models linear': contact model + its properties - FLAC 'constitutive-models' / 'constitutive-models mohr-coulomb': zone model + properties - 3DEC 'joint-models' / 'joint-models mohr': joint (sub-contact) model + properties - 'range-elements' / 'range-elements cylinder': range filter syntax (all engines) - 'plot-items' / 'plot-items <type>' / 'plot-items <type> <sub>': plot item keywords | |
| version | No | Documentation version (PFC: 6.0/7.0/9.0, FLAC: 7.0/9.0). Only gates version-specific items (e.g. PFC contact models by availability). range-elements, plot-items, and the FLAC/3DEC reference sets are version-agnostic, so the value is ignored for them. 9.0-only engines (MPoint, MassFlow) always resolve at 9.0. | 7.0 |
| software | Yes | ITASCA engine to query: 'pfc', 'flac', '3dec', 'mpoint', or 'massflow'. Required — there is no default engine. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||