33==========
44User guide
55==========
6- You can use PyFluent-Visualization for postprocessing of Fluent results
7- to display graphics objects and plot data.
6+ PyFluent-Visualization enables postprocessing of Fluent results,
7+ allowing you to display graphical objects and plot data efficiently .
88
99Launch Fluent and read data
1010~~~~~~~~~~~~~~~~~~~~~~~~~~~
11+ Use the following script to launch Fluent and load your case and data files:
1112
1213.. code-block :: python
1314
@@ -32,10 +33,11 @@ Launch Fluent and read data
3233
3334 Graphics operations
3435-------------------
35- Graphics operations that PyFluent-Visualization supports:
36+ PyFluent-Visualization supports various graphical operations.
3637
3738Display mesh
3839~~~~~~~~~~~~
40+ The following example demonstrates how to display a mesh with and without edges:
3941
4042.. code-block :: python
4143
@@ -63,6 +65,7 @@ Display mesh
6365
6466 Display plane-surface
6567~~~~~~~~~~~~~~~~~~~~~
68+ Create and visualize a plane surface at a specified z-coordinate:
6669
6770.. code-block :: python
6871
@@ -78,6 +81,7 @@ Display plane-surface
7881
7982 Display iso-surface
8083~~~~~~~~~~~~~~~~~~~
84+ Generate an iso-surface based on the y-coordinate:
8185
8286.. code-block :: python
8387
@@ -88,6 +92,7 @@ Display iso-surface
8892
8993 Display contour
9094~~~~~~~~~~~~~~~
95+ Plot a temperature contour over selected surfaces:
9196
9297.. code-block :: python
9398
@@ -112,6 +117,7 @@ Display contour
112117
113118 Display vector
114119~~~~~~~~~~~~~~
120+ Visualize velocity vectors over a selected surface:
115121
116122.. code-block :: python
117123
@@ -129,6 +135,7 @@ Display vector
129135
130136 Display pathlines
131137~~~~~~~~~~~~~~~~~
138+ Visualize pathlines to analyze flow patterns:
132139
133140.. code-block :: python
134141
@@ -144,10 +151,11 @@ Display pathlines
144151
145152 Plot operations
146153---------------
147- Plot operations that PyFluent-Visualization supports:
154+ PyFluent-Visualization supports various plot operations.
148155
149156Display plot
150157~~~~~~~~~~~~
158+ Generate an XY plot of temperature variations at an outlet:
151159
152160.. code-block :: python
153161
@@ -164,6 +172,7 @@ Display plot
164172
165173 Display solution residual plot
166174~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175+ Plot solution residuals:
167176
168177.. code-block :: python
169178
@@ -177,6 +186,7 @@ Display solution residual plot
177186
178187 Display solution monitors plot
179188~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
189+ Monitor solution convergence using mass balance and velocity plots:
180190
181191.. code-block :: python
182192
@@ -194,15 +204,19 @@ Display solution monitors plot
194204
195205 Interactive Graphics
196206--------------------
197- The ``GraphicsWindow `` class provides for managing and directly interacting
198- with the graphics window. By registering the window with ``EventsManager ``, you
199- can update graphics during run time and create animations.
207+ The ``GraphicsWindow `` class provides functionality for managing and directly
208+ interacting with the graphics window. By registering the window with ``EventsManager ``,
209+ you can dynamically update graphics during runtime and create animations.
200210
201- The following example updates the graphics window (contour_window, xy_plot_window and
202- monitor_window) during solution initialization and whenever data is read.
203- During the calculation, it also updates the graphics window at
204- the end of every time step. These are done via. explicit callback registrations.
205- You can create an animation as well from a graphics window.
211+ The following example demonstrates how to update multiple graphics windows
212+ (contour_window, xy_plot_window, and monitor_window) during different solution
213+ stages. Graphics updates occur:
214+
215+ - During solution initialization
216+
217+ - Whenever data is read
218+
219+ - At the end of every time step during the calculation
206220
207221.. code-block :: python
208222
@@ -246,3 +260,10 @@ You can create an animation as well from a graphics window.
246260
247261 solver_session.settings.solution.initialization.hybrid_initialize()
248262 solver_session.settings.solution.run_calculation.iterate(iter_count = 50 )
263+
264+ These updates are implemented using explicit callback registrations.
265+ Additionally, animations can be created from a graphics window.
266+
267+ This guide provides a structured approach to using PyFluent-Visualization.
268+ For detailed usage of individual modules,
269+ refer to the respective module documentation, see :ref: `ref_visualization `.
0 commit comments