ansys-fluent-visualization 0.20.dev0__tar.gz → 0.20.dev1__tar.gz

{ansys_fluent_visualization-0.20.dev0 → ansys_fluent_visualization-0.20.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ansys-fluent-visualization
-Version: 0.20.dev0
+Version: 0.20.dev1
 Summary: A python wrapper for ansys Fluent visualization
 License: MIT
 Author: ANSYS, Inc.
@@ -16,7 +16,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: ansys-fluent-core (==0.31.dev0)
+Requires-Dist: ansys-fluent-core (>=0.31.dev0)
 Requires-Dist: imageio (>=2.36.1)
 Requires-Dist: importlib-metadata (>=4.0,<5.0) ; python_version < "3.9"
 Requires-Dist: matplotlib (>=3.6.0)

{ansys_fluent_visualization-0.20.dev0 → ansys_fluent_visualization-0.20.dev1}/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.20.dev0"
+version = "0.20.dev1"
 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.31.dev0"
+ansys-fluent-core = ">=0.31.dev0"
 pyvista = ">=0.44.0"
 matplotlib = ">=3.6.0"
 pyvistaqt = "~=0.11.1"

{ansys_fluent_visualization-0.20.dev0 → ansys_fluent_visualization-0.20.dev1}/src/ansys/fluent/visualization/__init__.py

@@ -27,7 +27,7 @@ try:
 except ModuleNotFoundError:
     import importlib_metadata
 
-_VERSION_INFO = "Build date: March 11, 2025 19:30 UTC ShaID: 89c5220"
+_VERSION_INFO = "Build date: March 21, 2025 07:32 UTC ShaID: 8cc6c7a"
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
 PLOTTER = "matplotlib"
 SINGLE_WINDOW = False
@@ -35,13 +35,15 @@ SINGLE_WINDOW = False
 
 def version_info() -> str:
     """Method returning the version of PyFluent being used.
+
     Returns
     -------
     str
         The PyFluent version being used.
+
     Notes
-    -------
-    Only available in packaged versions. Otherwise it will return __version__.
+    -----
+        Only available in packaged versions. Otherwise it will return __version__.
     """
     return _VERSION_INFO if _VERSION_INFO is not None else __version__
 

ansys_fluent_visualization-0.20.dev1/src/ansys/fluent/visualization/containers.py

@@ -0,0 +1,221 @@
+# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""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.
+
+    Examples
+    --------
+    >>> from ansys.fluent.visualization import Mesh
+
+    >>> mesh_object = Mesh(
+    >>>     solver=solver_session, show_edges=True, surfaces=["in1", "in2", "in3"]
+    >>> )
+    """
+
+    def __init__(self, solver, **kwargs):
+        """__init__ method of Mesh class."""
+        self.__dict__["obj"] = Graphics(session=solver).Meshes.create(**kwargs)
+
+
+class Surface(_GraphicsContainer):
+    """Surface.
+
+    Examples
+    --------
+    >>> from ansys.fluent.visualization import Surface
+
+    >>> # For plane-surface
+    >>> surf_xy_plane = Surface(
+    >>>     solver=solver_session,
+    >>>     type="plane-surface",
+    >>>     creation_method="xy-plane",
+    >>>     z=-0.0441921
+    >>>     )
+
+    >>> # For iso-surface
+    >>> surf_outlet_plane = Surface(solver=solver_session)
+    >>> surf_outlet_plane.type = "iso-surface"
+    >>> surf_outlet_plane.field = "y-coordinate"
+    >>> surf_outlet_plane.iso_value = -0.125017
+    """
+
+    def __init__(self, solver, **kwargs):
+        """__init__ method of Surface class."""
+        self.__dict__.update(
+            dict(
+                type=kwargs.pop("type", None),
+                creation_method=kwargs.pop("creation_method", None),
+                x=kwargs.pop("x", None),
+                y=kwargs.pop("y", None),
+                z=kwargs.pop("z", None),
+                field=kwargs.pop("field", None),
+                iso_value=kwargs.pop("iso_value", None),
+                rendering=kwargs.pop("rendering", None),
+                obj=Graphics(session=solver).Surfaces.create(**kwargs),
+            )
+        )
+        for attr in [
+            "type",
+            "creation_method",
+            "x",
+            "y",
+            "z",
+            "field",
+            "iso_value",
+            "rendering",
+        ]:
+            val = getattr(self, attr)
+            if val is not None:
+                setattr(self, attr, val)
+
+    def __setattr__(self, attr, value):
+        if attr == "type":
+            self.obj.definition.type = value
+        elif attr == "creation_method":
+            self.obj.definition.plane_surface.creation_method = value
+        elif attr == "z":
+            assert self.obj.definition.plane_surface.creation_method() == "xy-plane"
+            self.obj.definition.plane_surface.xy_plane.z = value
+        elif attr == "y":
+            assert self.obj.definition.plane_surface.creation_method() == "zx-plane"
+            self.obj.definition.plane_surface.zx_plane.y = value
+        elif attr == "x":
+            assert self.obj.definition.plane_surface.creation_method() == "yz-plane"
+            self.obj.definition.plane_surface.yz_plane.x = value
+        elif attr == "field":
+            self.obj.definition.iso_surface.field = value
+        elif attr == "iso_value":
+            self.obj.definition.iso_surface.iso_value = value
+        elif attr == "rendering":
+            self.obj.definition.iso_surface.rendering = value
+        else:
+            setattr(self.obj, attr, value)
+
+
+class Contour(_GraphicsContainer):
+    """Contour.
+
+    Examples
+    --------
+    >>> from ansys.fluent.visualization import Contour
+
+    >>> temperature_contour_object = Contour(
+    >>>     solver=solver_session, field="temperature", surfaces=["in1", "in2", "in3",]
+    >>> )
+    """
+
+    def __init__(self, solver, **kwargs):
+        """__init__ method of Contour class."""
+        self.__dict__["obj"] = Graphics(session=solver).Contours.create(**kwargs)
+
+
+class Vector(_GraphicsContainer):
+    """Vector.
+
+    Examples
+    --------
+    >>> from ansys.fluent.visualization import Vector
+
+    >>> velocity_vector_object = Vector(
+    >>>     solver=solver_session,
+    >>>     field="pressure",
+    >>>     surfaces=["solid_up:1:830"],
+    >>>     scale=2,
+    >>> )
+    """
+
+    def __init__(self, solver, **kwargs):
+        """__init__ method of Vector class."""
+        self.__dict__["obj"] = Graphics(session=solver).Vectors.create(**kwargs)
+
+
+class Pathline(_GraphicsContainer):
+    """Pathline.
+
+    Examples
+    --------
+    >>> from ansys.fluent.visualization import Pathline
+
+    >>> pathlines = Pathline(solver=solver_session)
+    >>> pathlines.field = "velocity-magnitude"
+    >>> pathlines.surfaces = ["inlet", "inlet1", "inlet2"]
+    """
+
+    def __init__(self, solver, **kwargs):
+        """__init__ method of Pathline class."""
+        self.__dict__["obj"] = Graphics(session=solver).Pathlines.create(**kwargs)
+
+
+class XYPlot(_GraphicsContainer):
+    """XYPlot.
+
+    Examples
+    --------
+    >>> from ansys.fluent.visualization import XYPlot
+
+    >>> xy_plot = XYPlot(
+    >>>     solver=solver_session,
+    >>>     surfaces=["outlet"],
+    >>>     y_axis_function="temperature",
+    >>> )
+    """
+
+    def __init__(self, solver, local_surfaces_provider=None, **kwargs):
+        """__init__ method of XYPlot class."""
+        self.__dict__["obj"] = Plots(
+            session=solver, local_surfaces_provider=Graphics(solver).Surfaces
+        ).XYPlots.create(**kwargs)
+
+
+class Monitor(_GraphicsContainer):
+    """Monitor.
+
+    Examples
+    --------
+    >>> from ansys.fluent.visualization import Monitor
+
+    >>> residual = Monitor(solver=solver_session)
+    >>> residual.monitor_set_name = "residual"
+    """
+
+    def __init__(self, solver, local_surfaces_provider=None, **kwargs):
+        """__init__ method of Monitor class."""
+        self.__dict__["obj"] = Plots(
+            session=solver, local_surfaces_provider=Graphics(solver).Surfaces
+        ).Monitors.create(**kwargs)

{ansys_fluent_visualization-0.20.dev0 → ansys_fluent_visualization-0.20.dev1}/src/ansys/fluent/visualization/graphics/graphics_windows.py

@@ -38,7 +38,31 @@ _qt_window = None
 
 
 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 GraphicsWindow
+
+    >>> 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 = GraphicsWindow(grid=(2, 2))
+    >>> 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_graphics(xy_plot, position=(1, 1))
+    >>> graphics_window.show()
+    """
+
     def __init__(self, grid: tuple = (1, 1)):
+        """__init__ method of GraphicsWindow class."""
         self._grid = grid
         self._graphics_objs = []
         self.window_id = None
@@ -155,7 +179,7 @@ class GraphicsWindow:
         if self.window_id:
             self._renderer.save_graphic(filename)
 
-    def refresh_windows(
+    def refresh(
         self,
         session_id: str | None = "",
         overlay: bool | None = False,
@@ -176,7 +200,7 @@ class GraphicsWindow:
                 windows_id=[self.window_id], session_id=session_id, overlay=overlay
             )
 
-    def animate_windows(
+    def animate(
         self,
         session_id: str | None = "",
     ) -> None:
@@ -199,7 +223,7 @@ class GraphicsWindow:
                 windows_id=[self.window_id], session_id=session_id
             )
 
-    def close_windows(
+    def close(
         self,
         session_id: str | None = "",
     ) -> None:

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

@@ -1,89 +0,0 @@
-# Copyright (C) 2022 - 2025 ANSYS, Inc. and/or its affiliates.
-# SPDX-License-Identifier: MIT
-#
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-"""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)