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.

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

Meshing queries refactoring, improved error handling and doc updates #1585

Merged
merged 24 commits into from
May 15, 2023
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
12 changes: 12 additions & 0 deletions doc/source/api/general/services/batch_ops.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_batch_ops:

batch_ops
=========

.. automodule:: ansys.fluent.core.services.batch_ops
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/error_handler.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_error_handler:

error_handler
=============

.. automodule:: ansys.fluent.core.services.error_handler
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/events.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_events_code:

events
======

.. autoclass:: ansys.fluent.core.services.events.EventsService
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/field_data.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_field_data_code:

field_data
==========

.. automodule:: ansys.fluent.core.services.field_data
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/health_check.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_health_check:

health_check
============

.. automodule:: ansys.fluent.core.services.health_check
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
37 changes: 31 additions & 6 deletions doc/source/api/general/services/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,46 @@
Services
========

.. currentmodule:: ansys.fluent.core.services
============================== ====================================================================================
:ref:`ref_batch_ops` | Executes operations in batch in Fluent.

.. autosummary::
:toctree: _autosummary
:template: flobject-module-template.rst
:recursive:
:ref:`ref_error_handler` Handles gRPC service errors.

:ref:`ref_events_code` Begins and ends event streaming service of Fluent.

:ref:`ref_field_data_code` Extracts Fluent field data and provides access to Fluent field information.

:ref:`ref_health_check` Checks status of Fluent connection whether Fluent is serving or not.

:ref:`ref_interceptors` Intercepts batch gRPC calls and provides access to batch computation information.

:ref:`ref_meshing_queries` Query and utility functions that extracts information of particular labels, types,
group of zones involved in series of various meshing operations.

:ref:`ref_monitor` Begins and ends monitor streaming service of Fluent also gives monitors information.

:ref:`ref_scheme_eval` Evaluates and executes Fluent's scheme code.

:ref:`ref_settings` Extracts and modifies Fluent settings services.

:ref:`ref_streaming` Begins and ends streaming service of Fluent.

:ref:`ref_transcript` Begins and ends transcript streaming service of Fluent.
============================== ====================================================================================

.. toctree::
:maxdepth: 1
:hidden:

batch_ops
error_handler
events
field_data
health_check
interceptors
meshing_queries
monitor
scheme_eval
settings
streaming
transcript
transcript
12 changes: 12 additions & 0 deletions doc/source/api/general/services/interceptors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_interceptors:

interceptors
============

.. automodule:: ansys.fluent.core.services.interceptors
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/meshing_queries.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_meshing_queries:

meshing_queries
===============

.. autoclass:: ansys.fluent.core.services.meshing_queries.MeshingQueries
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/monitor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_monitor:

monitor
=======

.. automodule:: ansys.fluent.core.services.monitor
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/scheme_eval.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_scheme_eval:

scheme_eval
===========

.. automodule:: ansys.fluent.core.services.scheme_eval
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/settings.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_settings:

settings
========

.. automodule:: ansys.fluent.core.services.settings
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/streaming.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_streaming:

streaming
=========

.. automodule:: ansys.fluent.core.services.streaming
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
12 changes: 12 additions & 0 deletions doc/source/api/general/services/transcript.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _ref_transcript:

transcript
==========

.. automodule:: ansys.fluent.core.services.transcript
:members:
:show-inheritance:
:undoc-members:
:exclude-members: __weakref__, __dict__
:special-members: __init__
:autosummary:
17 changes: 17 additions & 0 deletions doc/styles/Vocab/ANSYS/accept.txt
Original file line number Diff line number Diff line change
@@ -1,26 +1,36 @@
ANSYS
Ansys
ansys
batch_ops
CaseFile
CommandArguments
error_handler
events
EventsManager
endblock
endfor
endif
field_data
Fluent
fluent
fluent_connection
Fluent's
fullname
grpc
gRPC
health_check
hexahedral
interceptors
Journaling
journaling
Matplotlib
matplotlib
mesher
meshing's
meshing_queries
metaclass
metaclasses
monitor
MonitorsManager
numpy
pathlines
Expand All @@ -33,17 +43,24 @@ pyansys
PyFluent
Pythonic
pyvista
rpc
rpvars
sbatch
scheme_eval
session
session_meshing
session_base_meshing
session_pure_meshing
session_solver
session_solver_icing
session_solver_lite
settings
Settings
streaming
Streaming
Session
Slurm
transcript
UDFs
Univa
venv
Loading