Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
3c82ac6
Edits to index.rst for User guide
PipKat Aug 11, 2022
b92a119
Edits to getting started and user guide files
PipKat Aug 12, 2022
f3729fd
Edits to API files
PipKat Aug 12, 2022
27c18dc
Edits to example files
PipKat Aug 12, 2022
d8e8961
Edits to contributing file
PipKat Aug 12, 2022
cc4830a
Fix issues for failing checks
PipKat Aug 12, 2022
619b03a
commit fixes made by pre-commit
PipKat Aug 12, 2022
f1fb822
Fix errors causing Buid Documentation check failure
PipKat Aug 12, 2022
5ee153b
Try to fix issue in solver settings file
PipKat Aug 12, 2022
e289adb
Try again to fix issue in solver settings file
PipKat Aug 12, 2022
be3b810
Update README.rst
PipKat Aug 15, 2022
f32d3d2
Fix indentation in settings.rst
jorgepiloto Aug 15, 2022
fe780e6
Apply suggestions from code review
PipKat Aug 15, 2022
17e2ec2
Fix format error
PipKat Aug 15, 2022
4095df1
Edit again to try to resolve error
PipKat Aug 15, 2022
2ed0afe
Try to fix error based on a similar set of commands
PipKat Aug 15, 2022
3fd588c
Apply suggestions from code review
PipKat Aug 19, 2022
47d730f
Edit "refresh" method description
PipKat Aug 19, 2022
2705824
Edits to launch_fluent method
PipKat Aug 19, 2022
37b4da3
Fix format error.
PipKat Aug 19, 2022
fb25bb7
Remove extra spaces at end of launch_fluent method
PipKat Aug 19, 2022
6932e14
Merge branch 'main' into doc/edits_based_on_rendered_doc
PipKat Aug 22, 2022
76e96f4
Merge branch 'main' into doc/edits_based_on_rendered_doc
PipKat Aug 22, 2022
5d35aa4
Merge branch 'main' into doc/edits_based_on_rendered_doc
RobPasMue Aug 23, 2022
dc975d1
Apply suggestions from code review
PipKat Aug 23, 2022
6611462
Merge branch 'main' into doc/edits_based_on_rendered_doc
PipKat Aug 23, 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
53 changes: 27 additions & 26 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ Documentation and issues
For comprehesive information on PyFluent, see the latest release
`documentation <https://fluentdocs.pyansys.com>`_.

On the `PyFluent Issues <https://github.com/pyansys/pyfluent/issues>`_, you can create
On the `PyFluent Issues <https://github.com/pyansys/pyfluent/issues>`_ page, you can create
issues to submit questions, report bugs, and request new features. To reach
the project support team, email `pyansys.support@ansys.com <pyansys.support@ansys.com>`_.
the PyAnsys support team, email `pyansys.support@ansys.com <pyansys.support@ansys.com>`_.

Installation
------------
The ``ansys-fluent-core`` package currently supports Python 3.7 through Python
The ``ansys-fluent-core`` package supports Python 3.7 through Python
3.10 on Windows and Linux.

Install the latest release from `PyPI
Expand All @@ -53,15 +53,15 @@ Install the latest release from `PyPI

pip install ansys-fluent-core

Alternatively, install the latest version from the `PyFluent GitHub
repository <https://github.com/pyansys/pyfluent>`_ with:
Alternatively, install the latest release from `GitHub <https://github.com/pyansys/pyfluent>`_
with:

.. code:: console

pip install git+https://github.com/pyansys/pyfluent.git

If you plan on doing local "development" of PyFluent with Git, install
with:
If you plan on doing local *development* of PyFluent with Git, install
the latest release with:

.. code:: console

Expand All @@ -73,15 +73,15 @@ with:

Dependencies
------------
You must have a locally-installed, licensed copy of Ansys to run Fluent. The
first supported version is 2022 R2.
You must have a licensed copy of Ansys Fluent installed locally. PyFluent
supports Fluent 2022 R2 and later.

Getting started
---------------

Launching Fluent
~~~~~~~~~~~~~~~~
You can launch Fluent from Python using the ``launch_fluent`` function:
To launch Fluent from Python, use the ``launch_fluent`` method:

.. code:: python

Expand All @@ -91,12 +91,12 @@ You can launch Fluent from Python using the ``launch_fluent`` function:

To use a non-default installation location, set the ``PYFLUENT_FLUENT_ROOT``
environment variable to the ``<version>/fluent`` directory, where ``<version>``
is the Ansys release version that you would like to use. For example, ``v222``
uses version 2022 R2.
is the Fluent release that you would like to use. For example, ``v222``
uses release 2022 R2.

Basic Usage
~~~~~~~~~~~
You can run Fluent TUI commands using the ``session.tui`` interface:
You can use the ``session.solver.tui`` interface to run all Fluent TUI commands:

.. code:: python

Expand All @@ -105,22 +105,23 @@ You can run Fluent TUI commands using the ``session.tui`` interface:
session.solver.tui.solve.initialize.initialize_flow()
session.solver.tui.solve.dual_time_iterate(2, 3)

In addition to all TUI commands being available, there are the
`PyFluent Parametric <https://fluentparametric.docs.pyansys.com/>`_ and
`PyFluent Visualization <https://fluentvisualization.docs.pyansys.com/>`_ packages.
You can also install and use these PyFluent libraries:

- The PyFluent Parametric package provides access to Fluent's parametric workflows.
- The PyFluent Visualization package provides postprocessing and visualization
capabilities using `pyvista <https://docs.pyvista.org/>`_ and `matplotlib <https://matplotlib.org/>`_.
- `PyFluent Parametric <https://fluentparametric.docs.pyansys.com/>`_, which provides
access to Fluent's parametric workflows.
- `PyFluent Visualization <https://fluentvisualization.docs.pyansys.com/>`_, which
provides postprocessing and visualization capabilities using the `pyvista <https://docs.pyvista.org/>`_
and `matplotlib <https://matplotlib.org/>`_ packages.

License and acknowledgments
---------------------------
``PyFluent`` is licensed under the MIT license.
PyFluent is licensed under the MIT license.

This module, ``ansys-fluent`` makes no commercial claim over Ansys whatsoever.
PyFluent extends the functionality of Fluent by adding a Python interface
PyFluent makes no commercial claim over Ansys whatsoever. This library
extends the functionality of Ansys Fluent by adding a Python interface
to Fluent without changing the core behavior or license of the original
software. The use of the interactive control of ``PyFluent`` requires a
legally licensed local copy of Fluent. For more information about Fluent,
visit the `Fluent page <https://www.ansys.com/products/fluids/ansys-fluent>`_
on the Ansys website.
software. The use of the interactive Fluent control of PyFluent requires a
legally licensed local copy of Fluent.

For more information on Fluent, see the `Ansys Fluent <https://www.ansys.com/products/fluids/ansys-fluent>`_
page on the Ansys website.
4 changes: 2 additions & 2 deletions doc/source/api/core/meshing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Meshing
=======
This module allows you to use Fluent meshing capabilities from Python. Both
of the meshing workflows and the meshing TUI commands are available.
The ``meshing`` module allows you to use Fluent meshing capabilities from Python.
Meshing workflows and meshing TUI commands are available.

Workflow example
----------------
Expand Down
6 changes: 3 additions & 3 deletions doc/source/api/core/solver/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ EventsManager
=============

An instance of ``EventsManager`` exists as an active ``events_manager`` property in each
solution-mode session object. You can register client callbacks with the EventsManager.
The EventsManager calls each callback whenever a server-side event occurs, passing session ID
and event information arguments to the callback. The EventsManager is useful for solution
solution mode session object. You can register client callbacks with the EventsManager.
The EventsManager calls each callback whenever a server-side event occurs, passing the session
ID and event information arguments to the callback. The EventsManager is useful for solution
monitoring and updating graphics during runtime.

Supported events are:
Expand Down
29 changes: 15 additions & 14 deletions doc/source/api/core/solver/fielddata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,20 @@ can access Fluent surface, scalar, and vector field data.

Multiple fields in a request
----------------------------
You can combine requests for multiple fields in a single request and receive
the data for all fields in a single response.
You can get data for multiple fields in a single request and see
the data for all of these fields in a single response.

**Request**

The ``add_get_<items>_request`` methods combine requests for multiple fields in a single request.
The ``add_get_<items>_request`` methods combine requests for multiple fields in a single request:

- ``add_get_surfaces_request`` adds a surfaces request.
- ``add_get_scalar_fields_request`` adds a scalar fields request.
- ``add_get_vector_fields_request`` adds a vector fields request.

**Response**
The ``get_fields`` method returns all requested fields in a single response. It provides
the dictionary containing the requested fields as a numpy array in the following order:
a dictionary containing the requested fields as a numpy array in the following order:

``tag_id [int]-> surface_id [int] -> field_name [str] -> field_data[np.array]``

Expand All @@ -41,7 +41,7 @@ node location[4], ``tag_id`` is ``(4|8)``, or 12.

Surface ID
----------
The surface ID is the same one as passed in the request.
The surface ID is the same one that is passed in the request.

Field name
----------
Expand All @@ -52,10 +52,10 @@ Surface request
The response to a surface request contains any of the following fields, depending on the
request arguments:

- faces, which contain face connectivity
- vertices, which contain node coordinates
- centroid, which contains face centroids
- face-normal, which contains face normals
- ``faces``, which contain face connectivity
- ``vertices``, which contain node coordinates
- ``centroid``, which contains face centroids
- ``face-normal``, which contains face normals


Scalar field request
Expand All @@ -67,8 +67,8 @@ Vector field request
~~~~~~~~~~~~~~~~~~~~
The response to a vector field request contains two fields:

- vector field, with the same name as the vector field name passed in the request
- vector-scale
- ``vector field``, with the same name as the vector field name that is passed in the request
- ``vector-scale``, a float value indicating the vector scale.


Example
Expand Down Expand Up @@ -162,12 +162,13 @@ the requested field.
``surface_id [int] -> field[np.array]``

For a vector field request, the response is a dictionary of surface IDs and a tuple of a numpy array of ``vector field``
and ``vector scale``.
and ``vector-scale``.

``surface_id [int] -> (vector field [np.array], vector-scale [float])``

It is important to note that in Fluent, you can associate a surface name with multiple surface
IDs. Thus, a response can contain a surface ID as a key of the returned dictionary.
.. note::
In Fluent, you can associate a surface name with multiple surface IDs.
Thus, a response can contain a surface ID as a key of the returned dictionary.

Example
~~~~~~~
Expand Down
7 changes: 3 additions & 4 deletions doc/source/api/core/solver/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@
Solver
======

This module allows you to use Fluent solver capabilities from Python. While
the :ref:`ref_solver_tui`-based commands are available, you can also use
the :ref:`ref_settings`, in addition to having access to Fluent surface, scalar
and vector field data, and events and monitoring.
The ``solver`` module allows you to use Fluent solver capabilities from Python. You
can use both :ref:`ref_solver_tui` commands and :ref:`ref_settings` to access Fluent
events, monitoring, and field data (surface, scalar, and vector).

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

Expand Down
Loading