Merge branch 'main' of https://github.com/pyansys/pyfluent-visualization into main

Author: prmukherj

.github/workflows/ci_cd.yml

@@ -41,7 +41,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [windows-latest, ubuntu-latest]
+        os: [windows-latest, public-ubuntu-latest-8-cores]
         python-version: ['3.10', '3.11', '3.12', '3.13']
       fail-fast: false
 
@@ -54,17 +54,32 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install OS packages
-        if:  matrix.os == 'ubuntu-latest'
+        if:  matrix.os == 'public-ubuntu-latest-8-cores'
         run: |
           sudo apt update
           sudo apt install libegl1
 
       - name: Install pyfluent-visualization
         run: make install
 
+      - name: Login to GitHub Container Registry
+        if:  matrix.os == 'public-ubuntu-latest-8-cores'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ secrets.BOT_APPLICATION_ID }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Pull Fluent docker image
+        if:  matrix.os == 'public-ubuntu-latest-8-cores'
+        run: make docker-pull
+        env:
+          FLUENT_IMAGE_TAG: v25.2.0
+
       - name: Test with pytest
         run: make unittest
-
+        env:
+          FLUENT_IMAGE_TAG: v25.2.0
 
   docs:
     name: Documentation

doc/source/users_guide/index.rst

@@ -48,7 +48,7 @@ The following example demonstrates how to display a mesh with and without edges:
     from ansys.fluent.visualization import GraphicsWindow, Mesh
 
     mesh = Mesh(solver=solver_session, show_edges=True, surfaces=["in1", "in2", "in3"])
-    window = GraphicsWindow(grid=(1, 2))
+    window = GraphicsWindow()
     window.add_graphics(mesh, position=(0, 0))
 
     mesh = Mesh(solver=solver_session, surfaces=["in1", "in2", "in3"])
@@ -156,7 +156,7 @@ Generate an XY plot of temperature variations at an outlet:
         y_axis_function="temperature",
     )
     window = GraphicsWindow()
-    window.add_graphics(xy_plot)
+    window.add_plot(xy_plot)
     window.show()
 
 Display solution residual plot
@@ -170,7 +170,7 @@ Plot solution residuals:
     residual = Monitor(solver=solver_session)
     residual.monitor_set_name = "residual"
     window = GraphicsWindow()
-    window.add_graphics(residual)
+    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 = GraphicsWindow()
+    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
@@ -227,11 +227,11 @@ stages. Graphics updates occur:
     contour_window.show()
 
     xy_plot_window = GraphicsWindow()
-    xy_plot_window.add_graphics(xy_plot_object)
+    xy_plot_window.add_plot(xy_plot_object)
     xy_plot_window.show()
 
     monitor_window = GraphicsWindow()
-    monitor_window.add_graphics(monitor1)
+    monitor_window.add_plot(monitor1)
     monitor_window.show()
 
     def auto_refresh_graphics(session, event_info):

doc/source/users_guide/integration.rst

@@ -4,4 +4,4 @@
 Integrating Custom Rendering Libraries with PyFluent-Visualization
 ==================================================================
 
-Will be available soon.
+Coming soon.

examples/00-postprocessing/post_processing_exhaust_manifold.py

@@ -40,11 +40,12 @@
 import ansys.fluent.core as pyfluent
 from ansys.fluent.core import examples
 
-from ansys.fluent.visualization import Graphics, Plots, set_config
+from ansys.fluent.visualization import Graphics, Plots, config
 
 pyfluent.CONTAINER_MOUNT_PATH = pyfluent.EXAMPLES_PATH
 
-set_config(blocking=True, set_view_on_display="isometric")
+config.interactive = False
+config.view = "isometric"
 
 ###############################################################################
 # Download files and launch Fluent

examples/00-postprocessing/script_manifold.py

@@ -52,9 +52,9 @@
     ui_mode="gui",
 )
 
-from ansys.fluent.visualization import set_config
+from ansys.fluent.visualization import config
 
-set_config(blocking=False)
+config.interactive = True
 
 
 from ansys.fluent.visualization import Graphics, Plots

examples/00-postprocessing/updated_exhaust_manifold_example.py

@@ -65,12 +65,13 @@
     Surface,
     Vector,
     XYPlot,
-    set_config,
+    config,
 )
 
 pyfluent.CONTAINER_MOUNT_PATH = pyfluent.EXAMPLES_PATH
 
-set_config(blocking=True, set_view_on_display="isometric")
+config.interactive = False
+config.view = "isometric"
 
 ###############################################################################
 # Download files and launch Fluent
@@ -112,7 +113,7 @@
     "solid_up:1:830-shadow",
 ]
 mesh = Mesh(solver=solver_session, show_edges=True, surfaces=mesh_surfaces_list)
-graphics_window = GraphicsWindow(grid=(1, 2))
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(mesh, position=(0, 0))
 
 mesh = Mesh(solver=solver_session, surfaces=mesh_surfaces_list)
@@ -124,36 +125,36 @@
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Create a plane-surface XY plane.
 
-surf_xy_plane = Surface(solver=solver_session)
-surf_xy_plane.definition.type = "plane-surface"
-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 = GraphicsWindow(grid=(1, 3))
+surf_xy_plane = Surface(
+    solver=solver_session,
+    type="plane-surface",
+    creation_method="xy-plane",
+    z=-0.0441921,
+)
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(surf_xy_plane, position=(0, 0))
 
 ###############################################################################
 # Create plane-surface YZ plane
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Create a plane-surface YZ plane.
 
-surf_yz_plane = Surface(solver=solver_session)
-surf_yz_plane.definition.type = "plane-surface"
-surf_yz_plane.definition.plane_surface.creation_method = "yz-plane"
-plane_surface_yz = surf_yz_plane.definition.plane_surface.yz_plane
-plane_surface_yz.x = -0.174628
+surf_yz_plane = Surface(
+    solver=solver_session, type="plane-surface", creation_method="yz-plane", x=-0.174628
+)
 graphics_window.add_graphics(surf_yz_plane, position=(0, 1))
 
 ###############################################################################
 # Create plane-surface ZX plane
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Create a plane-surface ZX plane.
 
-surf_zx_plane = Surface(solver=solver_session)
-surf_zx_plane.definition.type = "plane-surface"
-surf_zx_plane.definition.plane_surface.creation_method = "zx-plane"
-plane_surface_zx = surf_zx_plane.definition.plane_surface.zx_plane
-plane_surface_zx.y = -0.0627297
+surf_zx_plane = Surface(
+    solver=solver_session,
+    type="plane-surface",
+    creation_method="zx-plane",
+    y=-0.0627297,
+)
 graphics_window.add_graphics(surf_zx_plane, position=(0, 2))
 graphics_window.show()
 
@@ -163,23 +164,20 @@
 # Create an iso-surface on the outlet plane.
 
 surf_outlet_plane = Surface(solver=solver_session)
-surf_outlet_plane.definition.type = "iso-surface"
-iso_surf1 = surf_outlet_plane.definition.iso_surface
-iso_surf1.field = "y-coordinate"
-iso_surf1.iso_value = -0.125017
-graphics_window = GraphicsWindow(grid=(2, 1))
+surf_outlet_plane.type = "iso-surface"
+surf_outlet_plane.field = "y-coordinate"
+surf_outlet_plane.iso_value = -0.125017
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(surf_outlet_plane, position=(0, 0))
 
 ###############################################################################
 # Create iso-surface on mid-plane
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Create an iso-surface on the mid-plane.
 
-surf_mid_plane_x = Surface(solver=solver_session)
-surf_mid_plane_x.definition.type = "iso-surface"
-iso_surf2 = surf_mid_plane_x.definition.iso_surface
-iso_surf2.field = "x-coordinate"
-iso_surf2.iso_value = -0.174
+surf_mid_plane_x = Surface(
+    solver=solver_session, type="iso-surface", field="x-coordinate", iso_value=-0.174
+)
 graphics_window.add_graphics(surf_mid_plane_x, position=(1, 0))
 graphics_window.show()
 
@@ -188,13 +186,14 @@
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Create an iso-surface using the velocity magnitude.
 
-surf_vel_contour = Surface(solver=solver_session)
-surf_vel_contour.definition.type = "iso-surface"
-iso_surf3 = surf_vel_contour.definition.iso_surface
-iso_surf3.field = "velocity-magnitude"
-iso_surf3.rendering = "contour"
-iso_surf3.iso_value = 0.0
-graphics_window = GraphicsWindow(grid=(2, 2))
+surf_vel_contour = Surface(
+    solver=solver_session,
+    type="iso-surface",
+    field="velocity-magnitude",
+    rendering="contour",
+    iso_value=0.0,
+)
+graphics_window = GraphicsWindow()
 graphics_window.add_graphics(surf_vel_contour, position=(0, 0))
 
 ###############################################################################
@@ -269,8 +268,8 @@
     surfaces=["outlet"],
     y_axis_function="temperature",
 )
-plot_window = GraphicsWindow(grid=(2, 2))
-plot_window.add_graphics(xy_plot_object, position=(0, 0))
+plot_window = GraphicsWindow()
+plot_window.add_plot(xy_plot_object, position=(0, 0))
 
 ###############################################################################
 # Create residual plot
@@ -279,7 +278,7 @@
 
 residual = Monitor(solver=solver_session)
 residual.monitor_set_name = "residual"
-plot_window.add_graphics(residual, position=(0, 1))
+plot_window.add_plot(residual, position=(0, 1))
 
 ###############################################################################
 # Solve and plot solution monitors
@@ -291,10 +290,10 @@
 
 mass_bal_rplot = Monitor(solver=solver_session)
 mass_bal_rplot.monitor_set_name = "mass-bal-rplot"
-plot_window.add_graphics(mass_bal_rplot, position=(1, 0))
+plot_window.add_plot(mass_bal_rplot, position=(1, 0))
 
 point_vel_rplot = Monitor(solver=solver_session, monitor_set_name="point-vel-rplot")
-plot_window.add_graphics(point_vel_rplot, position=(1, 1))
+plot_window.add_plot(point_vel_rplot, position=(1, 1))
 plot_window.show()
 
 ###############################################################################

examples/00-postprocessing/updated_script_manifold_example.py

@@ -33,12 +33,12 @@
 # Run the following in command prompt to execute this file:
 # exec(open("updated_script_manifold_example.py").read())
 
-from ansys.fluent.visualization import set_config
+from ansys.fluent.visualization import config
 
-set_config(blocking=False)
+config.interactive = True
 
 import ansys.fluent.core as pyfluent
-from ansys.fluent.core import examples
+from ansys.fluent.core import SolverEvent, examples
 
 import_case = examples.download_file(
     file_name="exhaust_system.cas.h5", directory="pyfluent/exhaust_system"
@@ -100,26 +100,26 @@
 p1 = XYPlot(solver=session, surfaces=["solid_up:1:830"])
 p1.y_axis_function = "temperature"
 p_xy = GraphicsWindow()
-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 = GraphicsWindow()
-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 = GraphicsWindow()
-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 = GraphicsWindow()
-p_mbr.add_graphics(mbr)
+p_mbr.add_plot(mbr)
 p_mbr.show()
 
 p_mesh = GraphicsWindow()
@@ -135,35 +135,24 @@
 p_pathline.add_graphics(pathlines1)
 p_pathline.show()
 
-p_cont.plotter.view_isometric()
+p_cont._renderer.plotter.view_isometric()
 
 p_surf = GraphicsWindow()
 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)
-
-
-def auto_refersh_call_back_time_step(session, event_info):
-    p_res.refresh_windows(session.id)
-
-
-def initialize_call_back(session, event_info):
-    p_res.refresh_windows(session.id)
-    p_mtr.refresh_windows(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
+p_res.real_time_update(
+    events=[SolverEvent.SOLUTION_INITIALIZED, SolverEvent.ITERATION_ENDED]
+)
+p_mtr.real_time_update(
+    events=[SolverEvent.SOLUTION_INITIALIZED, SolverEvent.ITERATION_ENDED]
+)
+p_mbr.real_time_update(
+    events=[SolverEvent.SOLUTION_INITIALIZED, SolverEvent.ITERATION_ENDED]
 )
-cb_itr_id = session.events.register_callback(
-    "IterationEndedEvent", auto_refersh_call_back_iteration
+p_cont.real_time_update(
+    events=[SolverEvent.SOLUTION_INITIALIZED, SolverEvent.ITERATION_ENDED]
 )
 
-p_cont.animate_windows(session.id)
+session.settings.solution.initialization.hybrid_initialize()
+session.settings.solution.run_calculation.iterate(iter_count=50)