-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ce703e6
commit 081d6af
Showing
1 changed file
with
21 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,12 +34,11 @@ What is PyFluent? | |
----------------- | ||
|
||
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. | ||
lets you use Ansys Fluent within any other Python environment in conjunction | ||
with other PyAnsys libraries and with other external Python libraries. | ||
|
||
PyFluent implements a client-server architecture. PyFluent launches or connects | ||
with a running Fluent process as a server using Google remote procedure calls, | ||
with a running Fluent process as a server using Google remote procedure calls, | ||
or 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 | ||
|
@@ -49,23 +48,34 @@ customized scripts. | |
|
||
Features | ||
-------- | ||
The primary package, ``ansys-fluent``, provides features such as: | ||
The primary package, ``ansys-fluent-core``, provides features such as: | ||
|
||
- Ability to launch the Fluent solver in serial or parallel and connect to | ||
already running Fluent sessions using the :ref:`ref_launcher_launcher` module. | ||
- Scripting of Fluent's meshing capabilities. See the :ref:`ref_meshing` module | ||
for more information. | ||
- Scripting using Fluent's TUI commands. See the :ref:`ref_solver_tui` module for | ||
more information about the available commands. | ||
- and more... | ||
- Scripting using all of Fluent's TUI commands. See the :ref:`ref_solver_tui` | ||
module for more information about the available commands. | ||
- Ability to run more than one Fluent session asynchronously. See the | ||
:ref:`ref_utils` module for more information. | ||
- Ability to retrive Fluent field data as numpy arryas for custom post | ||
processing using standard Python libraries such as matplotlib. See the | ||
:ref:`ref_field_data` module for more information. | ||
- Ability to register function callbacks on Fluent solver events such as when a | ||
case or data file is read, or the Fluent solver completes an iteration. See | ||
the :ref:`ref_events` module for more information. | ||
- Ability to retrive solver monitors such as residuals using the | ||
:ref:`ref_monitors` module. | ||
|
||
Documentation and Issues | ||
------------------------ | ||
|
||
In addition to installation, usage, and contribution information, the PyFluent | ||
documentation provides API documentation, examples, and code guidelines. | ||
|
||
On the PyFluent Issues page, you can create issues to submit questions, | ||
report bugs, and request new features. To reach the project support team, | ||
email [email protected]. | ||
On the PyFluent Issues page, you can create issues to submit questions, report | ||
bugs, and request new features. To reach the project support team, email | ||
[email protected]. | ||
|
||
License | ||
------- | ||
|