Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions doc/source/api/core/solver/tui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

Solver TUI
==========
The PyFluent solver text user interface (TUI) API is provided to command the
Fluent solver using commands that are Pythonic versions of the TUI commands used
in the Fluent console. Much like Fluent's TUI the API provides a hierarchical
interface to the underlying procedural interface of the program.

The solver TUI API does not support Fluent TUI features such as aliases or
command abbreviation. As an alternative, using this API in an interactive
session is easier if you install a tool such as
`pyreadline3 <https://github.com/pyreadline3/pyreadline3>`_ which provides
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 TUI based examples in our gallery provide a guide for how to use this API.

.. currentmodule:: ansys.fluent.core.solver

.. autosummary::
Expand Down
2 changes: 1 addition & 1 deletion doc/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,6 @@ following environment variable:

.. code::

set PYFLUENT_SHOW_SERVER_GUI=1 # Windows
set PYFLUENT_SHOW_SERVER_GUI=1 # Windows
export PYFLUENT_SHOW_SERVER_GUI=1 # Linux (bash)

24 changes: 20 additions & 4 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,33 @@ Ansys Fluent is a state-of-the-art computational fluid dynamics (CFD) software
package for modeling fluid flow, heat transfer, and chemical reactions in
complex geometries.

Ansys Fluent provides complete mesh flexibility, including the ability to solve
your flow problems using unstructured meshes that can be generated about complex
geometries with relative ease. Supported mesh types include 2D
triangular/quadrilateral, 3D tetrahedral/hexahedral/pyramid/wedge/polyhedral,
and mixed (hybrid) meshes. Ansys Fluent also enables you to refine or coarsen
your mesh based on the flow solution.

You can read your mesh into Ansys Fluent, or, for 3D geometries, create your
mesh using the meshing mode of Fluent. All other operations are performed within
the solution mode of Fluent, including setting boundary conditions, defining
fluid properties, executing the solution, refining the mesh, and postprocessing
and viewing the results.

Python and Fluent
-----------------
Python is a portable, dynamically typed, interpreted programming language that
is easy to learn, read, and write. It is free to use and distribute and is
supported by a vast support library of thousands of available packages.

PyFluent is part of the growing `PyAnsys <https://docs.pyansys.com>`_ ecosystem
that lets you use Ansys Fluent within or alongside any other Python environment,
PyFluent is part of the `PyAnsys <https://docs.pyansys.com>`_ ecosystem that
lets you use Ansys Fluent within or alongside any other Python environment,
whether it is in conjunction with other Ansys Python libraries and packages or
with other external Python products.

PyFluent launches or connects with a running Fluent process as a server using
gRPC interfaces, but all you need to interact with is the Python interface.
PyFluent implements a client-server architecture. PyFluent launches or connects
with a running Fluent process as a server using gRPC interfaces, but all you
need to interact with is the Python interface.

You can use PyFluent to programmatically create, interact with and control an
Ansys Fluent session to create your own customized workspace. In addition, you
Expand Down