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
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,10 @@ jobs:
src/ansys/fluent/core/meshing/tui.py
src/ansys/fluent/core/solver/settings
src/ansys/fluent/core/solver/tui.py
doc/source/api/core/meshing/tui
doc/source/api/core/meshing/datamodel
doc/source/api/core/solver/tui
doc/source/api/core/solver/datamodel
key: API-Code-v${{ env.API_CODE_CACHE }}-${{ steps.version.outputs.PYFLUENT_VERSION }}-${{ matrix.image-tag }}-${{ hashFiles('codegen/**') }}-${{ github.sha }}
restore-keys: API-Code-v${{ env.API_CODE_CACHE }}-${{ steps.version.outputs.PYFLUENT_VERSION }}-${{ matrix.image-tag }}-${{ hashFiles('codegen/**') }}

Expand Down
2 changes: 2 additions & 0 deletions doc/source/api/core/solver/events.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _ref_events:

:orphan:

EventsManager
=============

Expand Down
2 changes: 2 additions & 0 deletions doc/source/api/core/solver/monitors.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
.. _ref_monitors:

:orphan:

MonitorsManager
===============

Expand Down
9 changes: 7 additions & 2 deletions doc/source/api/core/solver/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ issue commands with a hierarchy of objects.
Top-level Objects
-----------------

The top-level settings object is available as the ``root`` property of session.solver.
The top-level settings object is available as the :ref:`root<settings_root_section>` property of session.solver.

.. code-block::

Expand Down Expand Up @@ -203,6 +203,11 @@ Example(2): The list of valid commands can be accessed as follows:
>>> root.solution.run_calculation.get_active_command_names()
['iterate']

.. _settings_root_section:

Settings Objects Root
---------------------
:ref:`Settings root<root>`

The ``root`` object is the top-level settings object which contains all other
settings objects in a hierarchical structure. The full API documentation of settings
objects can be browsed from the :ref:`root object's page<root>`.
13 changes: 8 additions & 5 deletions doc/source/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ code that could be executed in Fluent for the current mode:

.. code:: python

unsteady = solver_session.scheme_eval.scheme_eval("(rp-unsteady?)")
unsteady = solver_session.scheme_eval.scheme_eval("(rp-unsteady?)")

Surface field and mesh data services are available in solution mode only via
the ``field_data`` object attribute of the session object:
Expand All @@ -160,16 +160,16 @@ The connection status of any session can be verified as follows

.. code:: python

health = solver_session.check_health()​​
health = solver_session.check_health()

Streaming of the Fluent transcript can be stopped/started as follows (it is
automatically started by default):

.. code:: python

solver_session.stop_transcript()​​
solver_session.stop_transcript()

solver_session.start_transcript()​​
solver_session.start_transcript()

Streaming of events pertaining to various, specific solver event types can be
enabled/disabled via the ``events_manager`` attribute of a solution-mode session:
Expand All @@ -178,7 +178,10 @@ enabled/disabled via the ``events_manager`` attribute of a solution-mode session

solver_session.events_manager.start()

Event management is detailed further here: :ref:`ref_events`.
..

Add the following line after fixing events_manager doc
Event management is detailed further here: <ref to event_manager doc>

The global logging level can be controlled at any time:

Expand Down
7 changes: 7 additions & 0 deletions src/ansys/fluent/core/solver/events_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,13 @@ def _listen_events(self):

@property
def events_list(self) -> List[str]:
"""Returns the list of supported events.

Returns
-------
List[str]
List of supported events.
"""
return self._events_list

def register_callback(
Expand Down