Skip to content

Information updated about TUI entries usage #518

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 22, 2022
Merged

Information updated about TUI entries usage #518

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c13a6b
Information updated about TUI entries usage in the TUI API
hpohekar Jun 17, 2022
f64954c
API call, interaction and TUI changed to command and Console respecti…
hpohekar Jun 21, 2022
587a6f1
Single backticks added to –python code and TUI commands
hpohekar Jun 21, 2022
1303a08
Single backticks added to –python code and TUI commands
hpohekar Jun 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions codegen/data/tui_menu_descriptions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@
both command line completion and history. You can also use Python standard
`help` and `dir` commands on any object in the API to inspect it further.

The arguments to a TUI command are just those that would be passed in direct interaction with the
Fluent Console, but in a Pythonic style. For instance the TUI command `/define/models/energy? #t` becomes
`_session_.solver.tui.define.energy(False)`.

Care must be taken wherever the TUI expects a quoted string as input: in such cases the Python argument
should be provided as a double quoted string embedded inside single quotes. For instance
`/define/boundary_conditions/velocity_inlet "IF(t<=10e-6[sec],3.58[m/s]*cos(PI*t/30e-6[s]),0[m/s])"`
in the TUI would be written as `session.solver.tui.define.boundary_conditions.velocity_inlet("inlet2", "no", "no", "yes", "yes", "no",
'"IF(t<=10e-6[sec],3.58[m/s]*cos(PI*t/30e-6[s]),0[m/s])"', "no", 0, "no", 300, "no", "no", "no", "yes", 10, 0.04)` in Python.

The TUI based examples in our gallery provide a guide for how to use this API.
"""
}