Rename.

Author: prmukherj

doc/api_rstgen.py

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

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 VisualizerWindow, Mesh
+    from ansys.fluent.visualization import GraphicsWindow, Mesh
 
     mesh = Mesh(solver=solver_session, show_edges=True, surfaces=["in1", "in2", "in3"])
-    window = VisualizerWindow()
+    window = GraphicsWindow()
     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 = VisualizerWindow()
+    window = GraphicsWindow()
     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 = VisualizerWindow()
+    window = GraphicsWindow()
     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 = VisualizerWindow()
+    window = GraphicsWindow()
     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 = VisualizerWindow()
+    window = GraphicsWindow()
     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 = VisualizerWindow()
+    window = GraphicsWindow()
     window.add_graphics(pathlines)
     window.show()
 
@@ -155,7 +155,7 @@ Generate an XY plot of temperature variations at an outlet:
         surfaces=["outlet"],
         y_axis_function="temperature",
     )
-    window = VisualizerWindow()
+    window = GraphicsWindow()
     window.add_plot(xy_plot)
     window.show()
 
@@ -169,7 +169,7 @@ Plot solution residuals:
 
     residual = Monitor(solver=solver_session)
     residual.monitor_set_name = "residual"
-    window = VisualizerWindow()
+    window = GraphicsWindow()
     window.add_plot(residual)
     window.show()
 
@@ -184,7 +184,7 @@ 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 = VisualizerWindow()
+    window = GraphicsWindow()
     window.add_plot(mass_bal_rplot, position=(0, 0))
 
     point_vel_rplot = Monitor(solver=solver_session, monitor_set_name="point-vel-rplot")
@@ -209,7 +209,7 @@ stages. Graphics updates occur:
 
 .. code-block:: python
 
-    from ansys.fluent.visualization import Contour, XYPlot, Monitor, VisualizerWindow
+    from ansys.fluent.visualization import Contour, XYPlot, Monitor, GraphicsWindow
 
     contour_object = Contour(
         solver=solver_session, field="velocity-magnitude", surfaces=["symmetry"]
@@ -222,15 +222,15 @@ stages. Graphics updates occur:
     monitor_object = Monitor(solver=solver_session)
     monitor_object.monitor_set_name = "residual"
 
-    contour_window = VisualizerWindow()
+    contour_window = GraphicsWindow()
     contour_window.add_graphics(contour_object)
     contour_window.show()
 
-    xy_plot_window = VisualizerWindow()
+    xy_plot_window = GraphicsWindow()
     xy_plot_window.add_plot(xy_plot_object)
     xy_plot_window.show()
 
-    monitor_window = VisualizerWindow()
+    monitor_window = GraphicsWindow()
     monitor_window.add_plot(monitor1)
     monitor_window.show()
 

examples/00-postprocessing/updated_exhaust_manifold_example.py

@@ -58,12 +58,12 @@
 
 from ansys.fluent.visualization import (
     Contour,
+    GraphicsWindow,
     Mesh,
     Monitor,
     Pathline,
     Surface,
     Vector,
-    VisualizerWindow,
     XYPlot,
     set_config,
 )
@@ -112,7 +112,7 @@
     "solid_up:1:830-shadow",
 ]
 mesh = Mesh(solver=solver_session, show_edges=True, surfaces=mesh_surfaces_list)
-graphics_window = VisualizerWindow()
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(mesh, position=(0, 0))
 
 mesh = Mesh(solver=solver_session, surfaces=mesh_surfaces_list)
@@ -129,7 +129,7 @@
 surf_xy_plane.definition.plane_surface.creation_method = "xy-plane"
 plane_surface_xy = surf_xy_plane.definition.plane_surface.xy_plane
 plane_surface_xy.z = -0.0441921
-graphics_window = VisualizerWindow()
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(surf_xy_plane, position=(0, 0))
 
 ###############################################################################
@@ -167,7 +167,7 @@
 iso_surf1 = surf_outlet_plane.definition.iso_surface
 iso_surf1.field = "y-coordinate"
 iso_surf1.iso_value = -0.125017
-graphics_window = VisualizerWindow()
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(surf_outlet_plane, position=(0, 0))
 
 ###############################################################################
@@ -194,7 +194,7 @@
 iso_surf3.field = "velocity-magnitude"
 iso_surf3.rendering = "contour"
 iso_surf3.iso_value = 0.0
-graphics_window = VisualizerWindow()
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(surf_vel_contour, position=(0, 0))
 
 ###############################################################################
@@ -250,11 +250,11 @@
 pathlines.field = "velocity-magnitude"
 pathlines.surfaces = ["inlet", "inlet1", "inlet2"]
 
-graphics_window = VisualizerWindow()
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(pathlines)
 graphics_window.show()
 
-graphics_window = VisualizerWindow()
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(mesh, opacity=0.05)
 graphics_window.add_graphics(velocity_vector)
 graphics_window.show()
@@ -269,7 +269,7 @@
     surfaces=["outlet"],
     y_axis_function="temperature",
 )
-plot_window = VisualizerWindow()
+plot_window = GraphicsWindow()
 plot_window.add_plot(xy_plot_object, position=(0, 0))
 
 ###############################################################################

examples/00-postprocessing/updated_script_manifold_example.py

@@ -61,12 +61,12 @@
 
 from ansys.fluent.visualization import (
     Contour,
+    GraphicsWindow,
     Mesh,
     Monitor,
     Pathline,
     Surface,
     Vector,
-    VisualizerWindow,
     XYPlot,
 )
 
@@ -85,7 +85,7 @@
 vector1 = Vector(
     solver=session, surfaces=["solid_up:1:830"], scale=4.0, skip=0, field="temperature"
 )
-p_vect = VisualizerWindow()
+p_vect = GraphicsWindow()
 p_vect.add_graphics(vector1)
 p_vect.show()
 
@@ -99,45 +99,45 @@
 
 p1 = XYPlot(solver=session, surfaces=["solid_up:1:830"])
 p1.y_axis_function = "temperature"
-p_xy = VisualizerWindow()
+p_xy = GraphicsWindow()
 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 = GraphicsWindow()
 p_res.add_plot(residual)
 p_res.show()
 
 mtr = Monitor(solver=session)
 mtr.monitor_set_name = "mass-tot-rplot"
-p_mtr = VisualizerWindow()
+p_mtr = GraphicsWindow()
 p_mtr.add_plot(mtr)
 p_mtr.show()
 
 mbr = Monitor(solver=session)
 mbr.monitor_set_name = "mass-bal-rplot"
-p_mbr = VisualizerWindow()
+p_mbr = GraphicsWindow()
 p_mbr.add_plot(mbr)
 p_mbr.show()
 
-p_mesh = VisualizerWindow()
+p_mesh = GraphicsWindow()
 p_mesh.add_graphics(mesh1)
 p_mesh.show()
-p_vect = VisualizerWindow()
+p_vect = GraphicsWindow()
 p_vect.add_graphics(vector1)
 p_vect.show()
-p_cont = VisualizerWindow()
+p_cont = GraphicsWindow()
 p_cont.add_graphics(contour1)
 p_cont.show()
-p_pathline = VisualizerWindow()
+p_pathline = GraphicsWindow()
 p_pathline.add_graphics(pathlines1)
 p_pathline.show()
 
 p_cont._visualizer.plotter.view_isometric()
 
-p_surf = VisualizerWindow()
+p_surf = GraphicsWindow()
 p_surf.add_graphics(surface1)
 p_surf.show()
 

src/ansys/fluent/visualization/__init__.py

@@ -62,4 +62,4 @@ def version_info() -> str:
 from ansys.fluent.visualization.graphics import Graphics  # noqa: F401
 from ansys.fluent.visualization.plotter import Plots  # noqa: F401
 from ansys.fluent.visualization.registrar import get_visualizer, register_visualizer
-from ansys.fluent.visualization.visualizer import VisualizerWindow
+from ansys.fluent.visualization.visualizer import GraphicsWindow

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

@@ -35,7 +35,7 @@
 _qt_window = None
 
 
-class GraphicsWindow:
+class _GraphicsWindow:
     """Create a graphics window to perform operations like display,
     save, animate, etc. on graphics objects.
     """
@@ -100,7 +100,7 @@ def save_graphic(
         --------
         >>> import ansys.fluent.core as pyfluent
         >>> from ansys.fluent.core import examples
-        >>> from ansys.fluent.visualization import VisualizerWindow, Vector
+        >>> from ansys.fluent.visualization import GraphicsWindow, Vector
         >>>
         >>> import_case = examples.download_file(
         >>> file_name="exhaust_system.cas.h5", directory="pyfluent/exhaust_system"
@@ -116,7 +116,7 @@ def save_graphic(
         >>> velocity_vector = Vector(
         >>> solver=solver_session, field="pressure", surfaces=["solid_up:1:830"]
         >>> )
-        >>> graphics_window = VisualizerWindow()
+        >>> graphics_window = GraphicsWindow()
         >>> graphics_window.add_graphics(velocity_vector)
         >>> graphics_window.save_graphic("saved_vector.svg")
         """

src/ansys/fluent/visualization/plotter/plotter_windows.py

@@ -23,7 +23,7 @@
 from ansys.fluent.visualization.plotter import plotter_windows_manager
 
 
-class PlotterWindow:
+class _PlotterWindow:
     def __init__(self, grid: tuple = (1, 1)):
         self._grid = grid
         self._plot_objs = []

src/ansys/fluent/visualization/visualizer.py

@@ -25,27 +25,27 @@
 
 import ansys.fluent.visualization as pyviz
 from ansys.fluent.visualization.graphics import graphics_windows_manager
-from ansys.fluent.visualization.graphics.graphics_windows import GraphicsWindow
-from ansys.fluent.visualization.plotter.plotter_windows import PlotterWindow
+from ansys.fluent.visualization.graphics.graphics_windows import _GraphicsWindow
+from ansys.fluent.visualization.plotter.plotter_windows import _PlotterWindow
 
 
-class VisualizerWindow:
+class GraphicsWindow:
     """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
+    >>> from ansys.fluent.visualization import GraphicsWindow
 
-    >>> graphics_window = VisualizerWindow()
+    >>> graphics_window = GraphicsWindow()
     >>> 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 = GraphicsWindow()
     >>> 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))
@@ -54,7 +54,7 @@ class VisualizerWindow:
     """
 
     def __init__(self):
-        """__init__ method of VisualizerWindow class."""
+        """__init__ method of GraphicsWindow class."""
         self._graphics_objs = []
         self.window_id = None
         self._visualizer = None
@@ -138,12 +138,12 @@ def show(self, visualizer=None) -> None:
         if self.window_id not in graphics_windows_manager._post_windows:
             graphics_windows_manager._post_windows[self.window_id] = None
         if self._all_plt_objs() and not pyviz.SINGLE_WINDOW:
-            self._visualizer = PlotterWindow(
+            self._visualizer = _PlotterWindow(
                 grid=self._show_find_grid_size(self._list_of_positions)
             )
             self._visualizer._plot_objs = self._graphics_objs
         else:
-            self._visualizer = GraphicsWindow(
+            self._visualizer = _GraphicsWindow(
                 grid=self._show_find_grid_size(self._list_of_positions)
             )
             self._visualizer._graphics_objs = self._graphics_objs
@@ -170,7 +170,7 @@ def save_graphic(
         --------
         >>> import ansys.fluent.core as pyfluent
         >>> from ansys.fluent.core import examples
-        >>> from ansys.fluent.visualization import VisualizerWindow, Vector
+        >>> from ansys.fluent.visualization import GraphicsWindow, Vector
         >>>
         >>> import_case = examples.download_file(
         >>> file_name="exhaust_system.cas.h5", directory="pyfluent/exhaust_system"
@@ -186,7 +186,7 @@ def save_graphic(
         >>> velocity_vector = Vector(
         >>> solver=solver_session, field="pressure", surfaces=["solid_up:1:830"]
         >>> )
-        >>> graphics_window = VisualizerWindow()
+        >>> graphics_window = GraphicsWindow()
         >>> graphics_window.add_graphics(velocity_vector)
         >>> graphics_window.save_graphic("saved_vector.svg")
         """