ansys-fluent-visualization 0.15.dev0__tar.gz → 0.16.dev0__tar.gz

ansys_fluent_visualization-0.16.dev0/AUTHORS

@@ -0,0 +1,12 @@
+# This is the list of PyFluent Visualization's significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and want to be added to this file,
+# submit a request.
+#
+#
+ANSYS, Inc.

{ansys_fluent_visualization-0.15.dev0 → ansys_fluent_visualization-0.16.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-fluent-visualization
-Version: 0.15.dev0
+Version: 0.16.dev0
 Summary: A python wrapper for ansys Fluent visualization
 Home-page: https://github.com/ansys/pyfluent-visualization
 License: MIT
@@ -16,7 +16,8 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: ansys-fluent-core (>=0.27.dev0,<1.0)
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: ansys-fluent-core (>=0.28.dev0,<1.0)
 Requires-Dist: importlib-metadata (>=4.0,<5.0) ; python_version < "3.9"
 Requires-Dist: matplotlib (>=3.9.0)
 Requires-Dist: pyside6 (>=6.7.2,<6.8.0)
@@ -131,11 +132,11 @@ the PyFluent-Visualization documentation.
 
 .. code:: python
 
-   from ansys.fluent.visualization.pyvista import Graphics
+   from ansys.fluent.visualization import Graphics
    graphics = Graphics(session=session)
    temperature_contour = graphics.Contours["contour-temperature"]
    temperature_contour.field = "temperature"
-   temperature_contour.surfaces_list = ["in1", "in2", "out1"]
+   temperature_contour.surfaces = ["in1", "in2", "out1"]
    temperature_contour.display("window-1")
 
 Usage in a JupyterLab environment

{ansys_fluent_visualization-0.15.dev0 → ansys_fluent_visualization-0.16.dev0}/README.rst

@@ -101,11 +101,11 @@ the PyFluent-Visualization documentation.
 
 .. code:: python
 
-   from ansys.fluent.visualization.pyvista import Graphics
+   from ansys.fluent.visualization import Graphics
    graphics = Graphics(session=session)
    temperature_contour = graphics.Contours["contour-temperature"]
    temperature_contour.field = "temperature"
-   temperature_contour.surfaces_list = ["in1", "in2", "out1"]
+   temperature_contour.surfaces = ["in1", "in2", "out1"]
    temperature_contour.display("window-1")
 
 Usage in a JupyterLab environment

{ansys_fluent_visualization-0.15.dev0 → ansys_fluent_visualization-0.16.dev0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "poetry.core.masonry.api"
 [tool.poetry]
 # Check https://python-poetry.org/docs/pyproject/ for all available sections
 name = "ansys-fluent-visualization"
-version = "0.15.dev0"
+version = "0.16.dev0"
 description = "A python wrapper for ansys Fluent visualization"
 license = "MIT"
 authors = ["ANSYS, Inc. <ansys.support@ansys.com>"]
@@ -25,7 +25,7 @@ packages = [
 [tool.poetry.dependencies]
 python = ">=3.10,<4.0"
 importlib-metadata = {version = "^4.0", python = "<3.9"}
-ansys-fluent-core = "~=0.27.dev0"
+ansys-fluent-core = "~=0.28.dev0"
 pyvista = "~=0.44.1"
 pyvistaqt = "~=0.11.1"
 pyside6 = "~=6.7.2"

{ansys_fluent_visualization-0.15.dev0 → ansys_fluent_visualization-0.16.dev0}/src/ansys/fluent/visualization/__init__.py

@@ -5,8 +5,9 @@ try:
 except ModuleNotFoundError:
     import importlib_metadata
 
-_VERSION_INFO = "Build date: September 14, 2024 05:41 UTC ShaID: 11b8965"
+_VERSION_INFO = "Build date: November 28, 2024 14:47 UTC ShaID: 463438b"
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
+PLOTTER = "matplotlib"
 
 
 def version_info() -> str:
@@ -23,5 +24,18 @@ def version_info() -> str:
 
 
 from ansys.fluent.visualization._config import get_config, set_config  # noqa: F401
-from ansys.fluent.visualization.matplotlib import Plots  # noqa: F401
-from ansys.fluent.visualization.pyvista import Graphics  # noqa: F401
+from ansys.fluent.visualization.containers import (  # noqa: F401
+    Contour,
+    Mesh,
+    Monitor,
+    Pathline,
+    Surface,
+    Vector,
+    XYPlot,
+)
+from ansys.fluent.visualization.graphics import Graphics  # noqa: F401
+from ansys.fluent.visualization.graphics.graphics_windows import (  # noqa: F401
+    GraphicsWindow,
+)
+from ansys.fluent.visualization.plotter import Plots  # noqa: F401
+from ansys.fluent.visualization.plotter.plotter_windows import PlotterWindow

{ansys_fluent_visualization-0.15.dev0 → ansys_fluent_visualization-0.16.dev0}/src/ansys/fluent/visualization/_config.py

@@ -14,7 +14,7 @@ def get_config() -> dict:
     return _global_config.copy()
 
 
-def set_config(blocking: bool = True, set_view_on_display: str = None):
+def set_config(blocking: bool = True, set_view_on_display: str = "isometric"):
     """Set visualization configuration.
 
     Parameters

ansys_fluent_visualization-0.16.dev0/src/ansys/fluent/visualization/containers.py

@@ -0,0 +1,67 @@
+"""Containers for graphics."""
+
+from ansys.fluent.visualization.graphics import Graphics
+from ansys.fluent.visualization.plotter import Plots
+
+
+class GraphicsContainer:
+    """Base class for graphics containers."""
+
+    def __getattr__(self, attr):
+        return getattr(self.obj, attr)
+
+    def __setattr__(self, attr, value):
+        setattr(self.obj, attr, value)
+
+
+class Mesh(GraphicsContainer):
+    """Mesh."""
+
+    def __init__(self, solver, **kwargs):
+        self.__dict__["obj"] = Graphics(session=solver).Meshes.create(**kwargs)
+
+
+class Surface(GraphicsContainer):
+    """Surface."""
+
+    def __init__(self, solver, **kwargs):
+        self.__dict__["obj"] = Graphics(session=solver).Surfaces.create(**kwargs)
+
+
+class Contour(GraphicsContainer):
+    """Contour."""
+
+    def __init__(self, solver, **kwargs):
+        self.__dict__["obj"] = Graphics(session=solver).Contours.create(**kwargs)
+
+
+class Vector(GraphicsContainer):
+    """Vector."""
+
+    def __init__(self, solver, **kwargs):
+        self.__dict__["obj"] = Graphics(session=solver).Vectors.create(**kwargs)
+
+
+class Pathline(GraphicsContainer):
+    """Pathline."""
+
+    def __init__(self, solver, **kwargs):
+        self.__dict__["obj"] = Graphics(session=solver).Pathlines.create(**kwargs)
+
+
+class XYPlot(GraphicsContainer):
+    """XYPlot."""
+
+    def __init__(self, solver, local_surfaces_provider=None, **kwargs):
+        self.__dict__["obj"] = Plots(
+            session=solver, local_surfaces_provider=Graphics(solver).Surfaces
+        ).XYPlots.create(**kwargs)
+
+
+class Monitor(GraphicsContainer):
+    """Monitor."""
+
+    def __init__(self, solver, local_surfaces_provider=None, **kwargs):
+        self.__dict__["obj"] = Plots(
+            session=solver, local_surfaces_provider=Graphics(solver).Surfaces
+        ).Monitors.create(**kwargs)

{ansys_fluent_visualization-0.15.dev0 → ansys_fluent_visualization-0.16.dev0}/src/ansys/fluent/visualization/contour.py

@@ -85,13 +85,13 @@ class Contour:
             if graphics_mode.__class__.__name__ == "Graphics":
                 contour = graphics_mode.Contours[contour_name]
                 contour.field = self.field
-                contour.surfaces_list = self.surfaces
+                contour.surfaces = self.surfaces
                 contour.display()
                 return contour
             elif graphics_mode.__class__.__name__ == "Solver":
                 solver.results.graphics.contour[contour_name] = {
                     "field": self.field,
-                    "surfaces_list": self.surfaces,
+                    "surfaces": self.surfaces,
                 }
                 solver.results.graphics.contour.display(object_name=contour_name)
                 return solver.results.graphics.contour[contour_name]

ansys_fluent_visualization-0.16.dev0/src/ansys/fluent/visualization/graphics/__init__.py

@@ -0,0 +1,6 @@
+"""A package that provides interfacing Fluent with graphics renderer (PyVista)."""
+
+from ansys.fluent.visualization.graphics.graphics_objects import Graphics  # noqa: F401
+from ansys.fluent.visualization.graphics.graphics_windows_manager import (  # noqa: F401
+    graphics_windows_manager,
+)

ansys_fluent_visualization-0.16.dev0/src/ansys/fluent/visualization/graphics/abstract_graphics_defns.py

@@ -0,0 +1,44 @@
+"""Abstract module providing graphics functionality."""
+
+from abc import ABC, abstractmethod
+
+
+class AbstractRenderer(ABC):
+    """Abstract class for renderer."""
+
+    @abstractmethod
+    def show(self):
+        """Show graphics."""
+        pass
+
+    @abstractmethod
+    def render(self, mesh, **kwargs):
+        """Render graphics in window."""
+        pass
+
+    @abstractmethod
+    def save_graphic(self, file_name: str):
+        """Save graphics to the specified file.
+
+        Parameters
+        ----------
+        file_name : str
+            File name to save graphic.
+        """
+        pass
+
+    @abstractmethod
+    def get_animation(self, win_id: str):
+        """Animate windows.
+
+        Parameters
+        ----------
+        win_id : str
+            ID for the window to animate.
+        """
+        pass
+
+    @abstractmethod
+    def close(self):
+        """Close graphics window."""
+        pass

ansys_fluent_visualization-0.15.dev0/src/ansys/fluent/visualization/pyvista/pyvista_objects.py → ansys_fluent_visualization-0.16.dev0/src/ansys/fluent/visualization/graphics/graphics_objects.py

@@ -16,8 +16,8 @@ from ansys.fluent.core.post_objects.post_objects_container import (
     Graphics as GraphicsContainer,
 )
 
-from ansys.fluent.visualization.pyvista.pyvista_windows_manager import (
-    pyvista_windows_manager,
+from ansys.fluent.visualization.graphics.graphics_windows_manager import (
+    graphics_windows_manager,
 )
 
 
@@ -49,12 +49,12 @@ class Mesh(MeshDefn):
 
     .. code-block:: python
 
-        from ansys.fluent.visualization.pyvista import  Graphics
+        from ansys.fluent.visualization import  Graphics
 
         graphics_session = Graphics(session)
         mesh1 = graphics_session.Meshes["mesh-1"]
         mesh1.show_edges = True
-        mesh1.surfaces_list = ['wall']
+        mesh1.surfaces = ['wall']
         mesh1.display("window-0")
     """
 
@@ -71,7 +71,7 @@ class Mesh(MeshDefn):
             Whether to overlay graphics over existing graphics.
             The default is ``False``.
         """
-        pyvista_windows_manager.plot(
+        graphics_windows_manager.plot(
             self, window_id=window_id, overlay=overlay, fetch_data=True
         )
 
@@ -81,12 +81,12 @@ class Pathlines(PathlinesDefn):
 
     .. code-block:: python
 
-        from ansys.fluent.visualization.pyvista import  Graphics
+        from ansys.fluent.visualization import  Graphics
 
         graphics_session = Graphics(session)
         pathlines1 = graphics_session.Pathlines["pathlines-1"]
         pathlines1.field = "velocity-magnitude"
-        pathlines1.surfaces_list = ['inlet']
+        pathlines1.surfaces = ['inlet']
         pathlines1.display("window-0")
     """
 
@@ -103,7 +103,7 @@ class Pathlines(PathlinesDefn):
             Whether to overlay graphics over existing graphics.
             The default is ``False``.
         """
-        pyvista_windows_manager.plot(
+        graphics_windows_manager.plot(
             self, window_id=window_id, overlay=overlay, fetch_data=True
         )
 
@@ -122,7 +122,7 @@ class Surface(SurfaceDefn):
 
     .. code-block:: python
 
-        from ansys.fluent.visualization.pyvista import Graphics
+        from ansys.fluent.visualization import Graphics
 
         graphics_session = Graphics(session)
         surface1 = graphics_session.Surfaces["surface-1"]
@@ -146,7 +146,7 @@ class Surface(SurfaceDefn):
             Whether to overlay graphics over existing graphics.
             The default is ``False``.
         """
-        pyvista_windows_manager.plot(
+        graphics_windows_manager.plot(
             self, window_id=window_id, overlay=overlay, fetch_data=True
         )
 
@@ -165,12 +165,12 @@ class Contour(ContourDefn):
 
     .. code-block:: python
 
-        from ansys.fluent.visualization.pyvista import  Graphics
+        from ansys.fluent.visualization import  Graphics
 
         graphics_session = Graphics(session)
         contour1 = graphics_session.Contours["contour-1"]
         contour1.field = "velocity-magnitude"
-        contour1.surfaces_list = ['wall']
+        contour1.surfaces = ['wall']
         contour1.display("window-0")
     """
 
@@ -187,7 +187,7 @@ class Contour(ContourDefn):
             Whether to overlay graphics over existing graphics.
             The default is ``False``.
         """
-        pyvista_windows_manager.plot(
+        graphics_windows_manager.plot(
             self, window_id=window_id, overlay=overlay, fetch_data=True
         )
 
@@ -206,11 +206,11 @@ class Vector(VectorDefn):
 
     .. code-block:: python
 
-        from ansys.fluent.visualization.pyvista import  Graphics
+        from ansys.fluent.visualization import  Graphics
 
         graphics_session = Graphics(session)
         vector1 = graphics_session.Vectors["vector-1"]
-        vector1.surfaces_list  = ['symmetry']
+        vector1.surfaces = ['symmetry']
         vector1.scale = 4.0
         vector1.skip = 4
         vector1.display("window-0")
@@ -229,6 +229,6 @@ class Vector(VectorDefn):
             Whether to overlay graphics over existing graphics.
             The default is ``False``.
         """
-        pyvista_windows_manager.plot(
+        graphics_windows_manager.plot(
             self, window_id=window_id, overlay=overlay, fetch_data=True
         )

ansys_fluent_visualization-0.16.dev0/src/ansys/fluent/visualization/graphics/graphics_windows.py

@@ -0,0 +1,129 @@
+"""A wrapper to improve the user interface of graphics."""
+
+from ansys.fluent.visualization.graphics import graphics_windows_manager
+
+
+class GraphicsWindow:
+    def __init__(self, grid: tuple = (1, 1)):
+        self._grid = grid
+        self._graphics_objs = []
+        self.window_id = None
+
+    def add_graphics(
+        self,
+        object,
+        position: tuple = (0, 0),
+        opacity: float = 1,
+    ) -> None:
+        """Add data to a plot.
+
+        Parameters
+        ----------
+        object: GraphicsDefn
+            Object to plot as a sub-plot.
+        position: tuple, optional
+            Position of the sub-plot.
+        opacity: float, optional
+            Transparency of the sub-plot.
+        """
+        self._graphics_objs.append({**locals()})
+
+    def show(self) -> None:
+        """Render the objects in window and display the same."""
+        self.window_id = graphics_windows_manager.open_window(grid=self._grid)
+        self.graphics_window = graphics_windows_manager._post_windows.get(
+            self.window_id
+        )
+        self._renderer = self.graphics_window.renderer
+        self.plotter = self.graphics_window.renderer.plotter
+        for i in range(len(self._graphics_objs)):
+            graphics_windows_manager.add_graphics(
+                object=self._graphics_objs[i]["object"].obj,
+                window_id=self.window_id,
+                fetch_data=True,
+                overlay=True,
+                position=self._graphics_objs[i]["position"],
+                opacity=self._graphics_objs[i]["opacity"],
+            )
+        graphics_windows_manager.show_graphics(self.window_id)
+
+    def save_graphic(
+        self,
+        format: str,
+    ) -> None:
+        """Save a graphics.
+
+        Parameters
+        ----------
+        format : str
+            Graphic file format. Supported formats are SVG, EPS, PS, PDF, and TEX.
+
+        Raises
+        ------
+        ValueError
+            If the window does not support the specified format.
+        """
+        if self.window_id:
+            self._renderer.save_graphic(f"{self.window_id}.{format}")
+
+    def refresh_windows(
+        self,
+        session_id: str | None = "",
+        overlay: bool | None = False,
+    ) -> None:
+        """Refresh windows.
+
+        Parameters
+        ----------
+        session_id : str, optional
+           Session ID for refreshing the windows that belong only to this
+           session. The default is ``""``, in which case the windows in all
+           sessions are refreshed.
+        overlay : bool, Optional
+            Overlay graphics over existing graphics.
+        """
+        if self.window_id:
+            graphics_windows_manager.refresh_windows(
+                windows_id=[self.window_id], session_id=session_id, overlay=overlay
+            )
+
+    def animate_windows(
+        self,
+        session_id: str | None = "",
+    ) -> None:
+        """Animate windows.
+
+        Parameters
+        ----------
+        session_id : str, optional
+           Session ID for animating the windows that belong only to this
+           session. The default is ``""``, in which case the windows in all
+           sessions are animated.
+
+        Raises
+        ------
+        NotImplementedError
+            If not implemented.
+        """
+        if self.window_id:
+            graphics_windows_manager.animate_windows(
+                windows_id=[self.window_id], session_id=session_id
+            )
+
+    def close_windows(
+        self,
+        session_id: str | None = "",
+    ) -> None:
+        """Close windows.
+
+        Parameters
+        ----------
+        session_id : str, optional
+           Session ID for closing the windows that belong only to this session.
+           The default is ``""``, in which case the windows in all sessions
+           are closed.
+        """
+        if self.window_id:
+            graphics_windows_manager.close_windows(
+                windows_id=[self.window_id], session_id=session_id
+            )