Update docs.

Author: prmukherj

doc/api_rstgen.py

@@ -47,7 +47,7 @@ def _get_file_path(folder_name: str, file_name: str):
         "Pathline",
         "XYPlot",
         "Monitor",
-        "GraphicsWindow",
+        "VisualizerWindow",
     ]
 }
 

doc/source/users_guide/index.rst

@@ -45,10 +45,10 @@ The following example demonstrates how to display a mesh with and without edges:
 
 .. code-block:: python
 
-    from ansys.fluent.visualization import GraphicsWindow, Mesh
+    from ansys.fluent.visualization import VisualizerWindow, Mesh
 
     mesh = Mesh(solver=solver_session, show_edges=True, surfaces=["in1", "in2", "in3"])
-    window = GraphicsWindow(grid=(1, 2))
+    window = VisualizerWindow()
     window.add_graphics(mesh, position=(0, 0))
 
     mesh = Mesh(solver=solver_session, surfaces=["in1", "in2", "in3"])
@@ -67,7 +67,7 @@ Create and visualize a plane surface at a specified z-coordinate:
     surf_xy_plane.type = "plane-surface"
     surf_xy_plane.creation_method = "xy-plane"
     surf_xy_plane.z = -0.0441921
-    window = GraphicsWindow()
+    window = VisualizerWindow()
     window.add_graphics(surf_xy_plane)
     window.show()
 
@@ -83,7 +83,7 @@ Generate an iso-surface based on the y-coordinate:
         field="y-coordinate",
         iso_value=-0.125017
         )
-    window = GraphicsWindow()
+    window = VisualizerWindow()
     window.add_graphics(surf_outlet_plane)
     window.show()
 
@@ -100,7 +100,7 @@ Plot a temperature contour over selected surfaces:
         field="temperature",
         surfaces=["in1", "in2", "in3"],
     )
-    window = GraphicsWindow()
+    window = VisualizerWindow()
     window.add_graphics(temperature_contour_manifold)
     window.show()
 
@@ -118,7 +118,7 @@ Visualize velocity vectors over a selected surface:
         surfaces=["solid_up:1:830"],
         scale=2,
     )
-    window = GraphicsWindow()
+    window = VisualizerWindow()
     window.add_graphics(velocity_vector)
     window.show()
 
@@ -134,7 +134,7 @@ Visualize pathlines to analyze flow patterns:
     pathlines.field = "velocity-magnitude"
     pathlines.surfaces = ["inlet", "inlet1", "inlet2"]
 
-    window = GraphicsWindow()
+    window = VisualizerWindow()
     window.add_graphics(pathlines)
     window.show()
 
@@ -155,8 +155,8 @@ Generate an XY plot of temperature variations at an outlet:
         surfaces=["outlet"],
         y_axis_function="temperature",
     )
-    window = GraphicsWindow()
-    window.add_graphics(xy_plot)
+    window = VisualizerWindow()
+    window.add_plot(xy_plot)
     window.show()
 
 Display solution residual plot
@@ -169,8 +169,8 @@ Plot solution residuals:
 
     residual = Monitor(solver=solver_session)
     residual.monitor_set_name = "residual"
-    window = GraphicsWindow()
-    window.add_graphics(residual)
+    window = VisualizerWindow()
+    window.add_plot(residual)
     window.show()
 
 Display solution monitors plot
@@ -184,11 +184,11 @@ Monitor solution convergence using mass balance and velocity plots:
 
     mass_bal_rplot = Monitor(solver=solver_session)
     mass_bal_rplot.monitor_set_name = "mass-bal-rplot"
-    window = GraphicsWindow(grid=(1, 2))
-    window.add_graphics(mass_bal_rplot, position=(0, 0))
+    window = VisualizerWindow()
+    window.add_plot(mass_bal_rplot, position=(0, 0))
 
     point_vel_rplot = Monitor(solver=solver_session, monitor_set_name="point-vel-rplot")
-    window.add_graphics(point_vel_rplot, position=(0, 1))
+    window.add_plot(point_vel_rplot, position=(0, 1))
     window.show()
 
 Interactive Graphics
@@ -209,7 +209,7 @@ stages. Graphics updates occur:
 
 .. code-block:: python
 
-    from ansys.fluent.visualization import Contour, XYPlot, Monitor, GraphicsWindow
+    from ansys.fluent.visualization import Contour, XYPlot, Monitor, VisualizerWindow
 
     contour_object = Contour(
         solver=solver_session, field="velocity-magnitude", surfaces=["symmetry"]
@@ -222,16 +222,16 @@ stages. Graphics updates occur:
     monitor_object = Monitor(solver=solver_session)
     monitor_object.monitor_set_name = "residual"
 
-    contour_window = GraphicsWindow()
+    contour_window = VisualizerWindow()
     contour_window.add_graphics(contour_object)
     contour_window.show()
 
-    xy_plot_window = GraphicsWindow()
-    xy_plot_window.add_graphics(xy_plot_object)
+    xy_plot_window = VisualizerWindow()
+    xy_plot_window.add_plot(xy_plot_object)
     xy_plot_window.show()
 
-    monitor_window = GraphicsWindow()
-    monitor_window.add_graphics(monitor1)
+    monitor_window = VisualizerWindow()
+    monitor_window.add_plot(monitor1)
     monitor_window.show()
 
     def auto_refresh_graphics(session, event_info):

examples/00-postprocessing/updated_script_manifold_example.py

@@ -100,26 +100,26 @@
 p1 = XYPlot(solver=session, surfaces=["solid_up:1:830"])
 p1.y_axis_function = "temperature"
 p_xy = VisualizerWindow()
-p_xy.add_graphics(p1)
+p_xy.add_plot(p1)
 p_xy.show()
 
 session.monitors.get_monitor_set_names()
 residual = Monitor(solver=session)
 residual.monitor_set_name = "residual"
 p_res = VisualizerWindow()
-p_res.add_graphics(residual)
+p_res.add_plot(residual)
 p_res.show()
 
 mtr = Monitor(solver=session)
 mtr.monitor_set_name = "mass-tot-rplot"
 p_mtr = VisualizerWindow()
-p_mtr.add_graphics(mtr)
+p_mtr.add_plot(mtr)
 p_mtr.show()
 
 mbr = Monitor(solver=session)
 mbr.monitor_set_name = "mass-bal-rplot"
 p_mbr = VisualizerWindow()
-p_mbr.add_graphics(mbr)
+p_mbr.add_plot(mbr)
 p_mbr.show()
 
 p_mesh = VisualizerWindow()
@@ -135,35 +135,36 @@
 p_pathline.add_graphics(pathlines1)
 p_pathline.show()
 
-p_cont.plotter.view_isometric()
+p_cont._visualizer.plotter.view_isometric()
 
 p_surf = VisualizerWindow()
 p_surf.add_graphics(surface1)
 p_surf.show()
 
 
 def auto_refersh_call_back_iteration(session, event_info):
-    p_cont.refresh_windows(session.id)
-    p_res.refresh_windows(session.id)
-    p_mtr.refresh_windows(session.id)
-    p_mbr.refresh_windows(session.id)
+    p_cont.refresh(session.id)
+    p_res.refresh(session.id)
+    p_mtr.refresh(session.id)
+    p_mbr.refresh(session.id)
 
 
 def auto_refersh_call_back_time_step(session, event_info):
-    p_res.refresh_windows(session.id)
+    p_res.refresh(session.id)
 
 
 def initialize_call_back(session, event_info):
-    p_res.refresh_windows(session.id)
-    p_mtr.refresh_windows(session.id)
+    p_res.refresh(session.id)
+    p_mtr.refresh(session.id)
 
 
-cb_init_id = session.events.register_callback("InitializedEvent", initialize_call_back)
-cb_data_read_id = session.events.register_callback(
-    "DataReadEvent", initialize_call_back
-)
-cb_itr_id = session.events.register_callback(
+session.events.register_callback("InitializedEvent", initialize_call_back)
+session.events.register_callback("DataReadEvent", initialize_call_back)
+session.events.register_callback(
     "IterationEndedEvent", auto_refersh_call_back_iteration
 )
 
-p_cont.animate_windows(session.id)
+p_cont.animate(session.id)
+
+session.settings.solution.initialization.hybrid_initialize()
+session.settings.solution.run_calculation.iterate(iter_count=50)

src/ansys/fluent/visualization/graphics/graphics_windows.py

@@ -38,25 +38,6 @@
 class GraphicsWindow:
     """Create a graphics window to perform operations like display,
     save, animate, etc. on graphics objects.
-
-    Examples
-    --------
-    You can add graphics objects like mesh, surface or plots and then display it.
-
-    >>> from ansys.fluent.visualization import VisualizerWindow
-
-    >>> graphics_window = VisualizerWindow()
-    >>> graphics_window.add_graphics(mesh_object)
-    >>> graphics_window.show()
-
-    You can add multiple graphics objects and display as a structured layout.
-
-    >>> graphics_window = VisualizerWindow()
-    >>> graphics_window.add_graphics(mesh_object, position=(0, 0))
-    >>> graphics_window.add_graphics(temperature_contour_object, position=(0, 1))
-    >>> graphics_window.add_graphics(velocity_vector_object, position=(1, 0))
-    >>> graphics_window.add_plot(xy_plot, position=(1, 1))
-    >>> graphics_window.show()
     """
 
     def __init__(self, grid: tuple = (1, 1)):

src/ansys/fluent/visualization/visualizer.py

@@ -32,6 +32,25 @@
 class VisualizerWindow:
     """Create a graphics window to perform operations like display,
     save, animate, etc. on graphics and plot objects.
+
+    Examples
+    --------
+    You can add graphics objects like mesh, surface or plots and then display it.
+
+    >>> from ansys.fluent.visualization import VisualizerWindow
+
+    >>> graphics_window = VisualizerWindow()
+    >>> graphics_window.add_graphics(mesh_object)
+    >>> graphics_window.show()
+
+    You can add multiple graphics objects and display as a structured layout.
+
+    >>> graphics_window = VisualizerWindow()
+    >>> graphics_window.add_graphics(mesh_object, position=(0, 0))
+    >>> graphics_window.add_graphics(temperature_contour_object, position=(0, 1))
+    >>> graphics_window.add_graphics(velocity_vector_object, position=(1, 0))
+    >>> graphics_window.add_plot(xy_plot, position=(1, 1))
+    >>> graphics_window.show()
     """
 
     def __init__(self):