Skip to content
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

docs: Document missing TUI commands #3487

Merged
merged 1 commit into from
Nov 15, 2024
Merged

docs: Document missing TUI commands #3487

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions doc/source/user_guide/legacy/tui.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,3 +170,14 @@ Limitations
-----------
#. The command ``file.set_batch_options`` is not supported because batch options are automatically
configured to ensure the execution environment in Fluent is correctly set for remote operations.

#. The commands under the TUI menus ``display.views`` and ``display.set.windows`` are not available
in PyFluent meshing session. Those commands can be executed using the ``execute_tui`` method.
For example:

.. code-block:: python

<meshing_session>.execute_tui("/display/views/camera/position 2 3 4")
<meshing_session>.execute_tui("/display/set/windows/open-window 2")

The argument to the ``execute_tui`` method is the exact TUI command string in Fluent.