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 11 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:
Empty file.
Empty file.
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:
36 changes: 30 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,45 @@
Services
========

.. currentmodule:: ansys.fluent.core.services
============================== ===============================================================================
:ref:`ref_batch_ops` | Batch rpc service.

.. autosummary::
:toctree: _autosummary
:template: flobject-module-template.rst
:recursive:
:ref:`ref_error_handler` Custom gRPC error handler.

:ref:`ref_events` Wrapper over the events gRPC service of Fluent.

:ref:`ref_field_data` Wrappers over FieldData gRPC service of Fluent.

:ref:`ref_health_check` Wrapper over the health check grpc service of Fluent.

:ref:`ref_interceptors` Interceptor classes to use with gRPC services.

:ref:`ref_meshing_queries` Wrapper over the meshing grpc service of Fluent.

:ref:`ref_monitor` Wrapper over the monitor grpc service of Fluent.

:ref:`ref_scheme_eval` Wrappers over SchemeEval gRPC service of Fluent.

:ref:`ref_settings` Wrapper to settings gRPC service of Fluent.

:ref:`ref_streaming` Wrapper over the streaming grpc services of Fluent.

:ref:`ref_transcript` Wrapper over the transcript grpc 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:
15 changes: 15 additions & 0 deletions doc/styles/Vocab/ANSYS/accept.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
ANSYS
Ansys
ansys
batch_ops
CaseFile
CommandArguments
error_handler
EventsManager
endblock
endfor
Expand All @@ -12,15 +14,21 @@ 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 +41,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