From 8aed1475a9c0295b9a27eadcbc67ce345153d5c0 Mon Sep 17 00:00:00 2001 From: Stephen Fuqua Date: Wed, 6 Jul 2022 10:24:32 -0400 Subject: [PATCH 1/5] conflicts --- doc/source/api/core/index.rst | 9 +++++++ doc/source/api/core/solver/index.rst | 5 ++++ doc/source/api/index.rst | 39 ++++++++++++++++++++++++++++ 3 files changed, 53 insertions(+) diff --git a/doc/source/api/core/index.rst b/doc/source/api/core/index.rst index c7a40aeb0a56..c5116c5c0a5b 100644 --- a/doc/source/api/core/index.rst +++ b/doc/source/api/core/index.rst @@ -2,6 +2,15 @@ Core ==== + +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 APIs for the meshing and solver components of Fluent. + +Aside from the core API, there is also the separate Parametric +Study API, as well as the separate Visualization API. + .. currentmodule:: ansys.fluent.core .. autosummary:: diff --git a/doc/source/api/core/solver/index.rst b/doc/source/api/core/solver/index.rst index e70bd1b6d8d8..387f18e9d6d8 100644 --- a/doc/source/api/core/solver/index.rst +++ b/doc/source/api/core/solver/index.rst @@ -2,6 +2,11 @@ Solver ====== +This module allows you to use Fluent solver capabilities from Python. While +the solver TUI commands are available, you can also use the settings-based object +API (Beta), in addition to access to Fluent surface, scalar +and vector field data, and events and monitoring. + .. currentmodule:: ansys.fluent.core.solver .. autosummary:: diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst index c4f7455da86b..509d5ba5582a 100644 --- a/doc/source/api/index.rst +++ b/doc/source/api/index.rst @@ -4,6 +4,45 @@ 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 APIs for the meshing and solver components of Fluent. + +ANote that aside from the core API, there is also the separate +Parametric Study API, as well as the separate Visualization API. + +Launching Fluent +---------------- + +The API for this component provides access to starting Fluent locally in +server mode or connecting to a running Fluent server instance. + +Pythonic Utilities +------------------ + +The API is currently comprosed of only a function to allow for +asynchonous execution. + +Meshing Mode +------------ + +The meshing API is dedicated to capturing the capabilities of +the Fluent Meshing guided workflows and associated tools. The API +consists of a TUI-based API that is derived from the Fluent (meshing) +text command interface, as well as a datamodel-driven meshing workflow +interface that manages the workflow tasks, meshing functions, and +part management. + +Solver Mode +----------- + +The solver API is dedicated to capturing the power of the +Fluent solver. The API consists of a settings-based API (beta) +or TUI-based API that is derived from the Fluent (solver) text +command interface, as well as access to Fluent surface, scalar +and vector field data. + .. currentmodule:: ansys.fluent .. autosummary:: From c9a24bc449c2825d8ded9725167e07f399801d74 Mon Sep 17 00:00:00 2001 From: Stephen Fuqua Date: Wed, 6 Jul 2022 10:25:19 -0400 Subject: [PATCH 2/5] update --- doc/source/api/index.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst index 509d5ba5582a..d0c7fe138158 100644 --- a/doc/source/api/index.rst +++ b/doc/source/api/index.rst @@ -9,8 +9,9 @@ Here, you can find the application programming interfaces for such things as launching Fluent, assorted utilities, as well as the APIs for the meshing and solver components of Fluent. -ANote that aside from the core API, there is also the separate -Parametric Study API, as well as the separate Visualization API. +Note that aside from the core API, there is also the separate +Parametric Study API (``ansys-fluent-parametric``), as well as the +separate Visualization API (``ansys-fluent-visualization``). Launching Fluent ---------------- From 27975cab1d60994e00dd50ec627ebbb9be0f9503 Mon Sep 17 00:00:00 2001 From: Stephen Fuqua Date: Wed, 6 Jul 2022 13:15:56 -0400 Subject: [PATCH 3/5] conflicts --- doc/source/api/core/index.rst | 5 +---- doc/source/api/core/solver/index.rst | 4 ++-- doc/source/api/index.rst | 31 ++++++++++++---------------- 3 files changed, 16 insertions(+), 24 deletions(-) diff --git a/doc/source/api/core/index.rst b/doc/source/api/core/index.rst index c5116c5c0a5b..897b9aca39a3 100644 --- a/doc/source/api/core/index.rst +++ b/doc/source/api/core/index.rst @@ -6,10 +6,7 @@ Core 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 APIs for the meshing and solver components of Fluent. - -Aside from the core API, there is also the separate Parametric -Study API, as well as the separate Visualization API. +the interfaces for the meshing and solver components of Fluent. .. currentmodule:: ansys.fluent.core diff --git a/doc/source/api/core/solver/index.rst b/doc/source/api/core/solver/index.rst index 387f18e9d6d8..ffbfe763a481 100644 --- a/doc/source/api/core/solver/index.rst +++ b/doc/source/api/core/solver/index.rst @@ -3,8 +3,8 @@ Solver ====== This module allows you to use Fluent solver capabilities from Python. While -the solver TUI commands are available, you can also use the settings-based object -API (Beta), in addition to access to Fluent surface, scalar +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 diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst index d0c7fe138158..b3a34f53a776 100644 --- a/doc/source/api/index.rst +++ b/doc/source/api/index.rst @@ -7,42 +7,37 @@ 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 APIs for the meshing and solver components of Fluent. - -Note that aside from the core API, there is also the separate -Parametric Study API (``ansys-fluent-parametric``), as well as the -separate Visualization API (``ansys-fluent-visualization``). +the interfaces for the meshing and solver components of Fluent. Launching Fluent ---------------- -The API for this component provides access to starting Fluent locally in +This component provides access to starting Fluent locally in server mode or connecting to a running Fluent server instance. Pythonic Utilities ------------------ -The API is currently comprosed of only a function to allow for +This component consists solely of a function to allow for asynchonous execution. Meshing Mode ------------ -The meshing API is dedicated to capturing the capabilities of -the Fluent Meshing guided workflows and associated tools. The API -consists of a TUI-based API that is derived from the Fluent (meshing) -text command interface, as well as a datamodel-driven meshing workflow -interface that manages the workflow tasks, meshing functions, and -part management. +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 API is dedicated to capturing the power of the -Fluent solver. The API consists of a settings-based API (beta) -or TUI-based API that is derived from the Fluent (solver) text -command interface, as well as access to Fluent surface, scalar -and vector field data. +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 From f6e8ff73dc4040910168dea7e1eae8c7700d743c Mon Sep 17 00:00:00 2001 From: Sean Pearson <93727996+seanpearsonuk@users.noreply.github.com> Date: Wed, 6 Jul 2022 18:21:43 +0100 Subject: [PATCH 4/5] Update doc/source/api/core/solver/index.rst --- doc/source/api/core/solver/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/api/core/solver/index.rst b/doc/source/api/core/solver/index.rst index ffbfe763a481..b51c72d9d429 100644 --- a/doc/source/api/core/solver/index.rst +++ b/doc/source/api/core/solver/index.rst @@ -2,7 +2,7 @@ Solver ====== -This module allows you to use Fluent solver capabilities from Python. While +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. From f86c09ae2671a3c0361f56b479d0c53a8be0b455 Mon Sep 17 00:00:00 2001 From: "ANSYS\\spearson" Date: Wed, 6 Jul 2022 19:48:43 +0100 Subject: [PATCH 5/5] doc --- doc/source/api/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst index b3a34f53a776..51d695e80e5b 100644 --- a/doc/source/api/index.rst +++ b/doc/source/api/index.rst @@ -7,7 +7,7 @@ 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. +the interfaces for the meshing and solver components of Fluent. Launching Fluent ---------------- @@ -19,7 +19,7 @@ Pythonic Utilities ------------------ This component consists solely of a function to allow for -asynchonous execution. +asynchronous execution. Meshing Mode ------------