pfc_browse_reference
Browse PFC reference documentation for syntax elements and model properties. Use to find contact model properties, range filtering syntax, and plot item configuration.
Instructions
Browse PFC reference documentation (syntax elements, model properties).
References are language elements used within commands, not standalone commands.
Navigation levels:
No topic: All reference categories
Category (e.g., "contact-models"): List items in category
Full path (e.g., "contact-models linear"): Full documentation
When to use:
Need contact model property names (kn, ks, fric, pb_*)
Need range filtering syntax (position, cylinder, group, id)
Need plot item configuration (color-by, cut plane, transparency, legend)
Setting up "contact cmat add model ... property ..." commands
Using range filters in any PFC command
Configuring "plot item create" commands
Related tools:
pfc_browse_commands: Command syntax (e.g., "ball create")
pfc_query_command: Search commands by keywords
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | No | Reference topic to browse (space-separated path). Examples: - None or '': List all reference categories - 'contact-models': List all contact models - 'contact-models linear': Linear model properties - 'range-elements': Range elements overview (24 elements) - 'range-elements position': Position range syntax - 'plot-items': Plot item types (ball, wall, contact keywords) - 'plot-items ball': Ball overview + available sub-topics - 'plot-items ball color-by': Ball color-by keyword details | |
| version | No | PFC documentation version (6.0/7.0/9.0). Defaults to 7.0. Filters contact models by version availability; range-elements and plot-items are version-agnostic. | 7.0 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||