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.

Sign up for GitHub

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

Bringing over small edits from the release that were supposed to go b… #680

Merged
merged 8 commits into from
Jul 29, 2022
Merged

Bringing over small edits from the release that were supposed to go b… #680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
17744c5
Bringing over small edits from the release that were supposed to go b…
Jul 27, 2022
eb6cb82
Update doc/source/api/core/index.rst
smf2001 Jul 28, 2022
50a5535
Update doc/source/api/core/index.rst
smf2001 Jul 28, 2022
dd27b86
Update doc/source/api/index.rst
smf2001 Jul 28, 2022
a8991c2
Update doc/source/api/core/solver/index.rst
smf2001 Jul 28, 2022
0576c8c
Update index.rst
smf2001 Jul 28, 2022
60432db
Update index.rst
smf2001 Jul 28, 2022
8f1603e
Merge branch 'main' into doc/minor-updates-for-intro-text-for-api
smf2001 Jul 29, 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
7 changes: 6 additions & 1 deletion doc/source/api/core/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Core
====

This section describes the Fluent Python API (application programming interface).
Here, you can find methods for launching Fluent and using assorted utilities
and Fluent meshing and solver components.

.. currentmodule:: ansys.fluent.core

.. autosummary::
Expand All @@ -15,4 +20,4 @@ Core
utils
meshing/index
solver/index


6 changes: 6 additions & 0 deletions doc/source/api/core/solver/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

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.

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

.. autosummary::
Expand Down
37 changes: 36 additions & 1 deletion doc/source/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,41 @@
API reference
=============

This section describes the core Pythonic interfaces for Fluent.
Here, you can find the application programming interfaces for
such things as launching Fluent, assorted utilities, as well as
the interfaces for the meshing and solver components of Fluent.

Launching Fluent
----------------

This component provides access to starting Fluent locally in
server mode or connecting to a running Fluent server instance.

Pythonic utilities
------------------

This component consists solely of a function to allow for
asynchronous execution.

Meshing mode
------------

The meshing mode is dedicated to capturing the capabilities of
the Fluent Meshing guided workflows and associated tools. This component
consists of an interface that is derived from the Fluent (meshing)
TUI, as well as a meshing workflow interface that manages workflow
tasks, meshing functions, and part management.

Solver mode
-----------

The solver mode is dedicated to capturing the power of the
Fluent solver. This component consists of a :ref:`ref_settings`-based
interface or a :ref:`ref_solver_tui`-based interface that is derived
from the Fluent (solver) TUI, as well as access to Fluent surface,
scalar and vector field data.

.. currentmodule:: ansys.fluent

.. autosummary::
Expand All @@ -13,4 +48,4 @@ API reference
:maxdepth: 4
:hidden:

core/index
core/index