ansys-fluent-core 0.27.dev1__py3-none-any.whl → 0.28.dev0__py3-none-any.whl

ansys/fluent/tests/test_settings_api.py

@@ -12,7 +12,9 @@ from ansys.fluent.core.solver.flobject import (
     _OutputFile,
     to_python_name,
 )
+from ansys.fluent.core.utils.execution import timeout_loop
 from ansys.fluent.core.utils.fluent_version import FluentVersion
+from ansys.fluent.core.warnings import PyFluentUserWarning
 
 
 @pytest.mark.nightly
@@ -23,8 +25,6 @@ def test_setup_models_viscous_model_settings(new_solver_session) -> None:
     solver_session.file.read(
         file_name=case_path, file_type="case", lightweight_setup=True
     )
-    # NOTE: Not sure why initialization is necessary here
-    # solver_session.solution.initialization.hybrid_initialize()
 
     viscous_model = solver_session.setup.models.viscous
 
@@ -213,24 +213,26 @@ def test_api_upgrade(new_solver_session, capsys):
     solver = new_solver_session
     case_path = download_file("Static_Mixer_main.cas.h5", "pyfluent/static_mixer")
     solver.tui.file.read_case(case_path)
-    "<solver_session>.file.read_case" in capsys.readouterr().out
+    timeout_loop(
+        lambda: "<solver_session>.settings.file.read_case" in capsys.readouterr().out,
+        timeout=5,
+    )
 
 
-@pytest.mark.fluent_version(">=24.2")
+# Custom aliases are not tested with 25.1 or later due to conflicts with the actual aliases
+# defined in the settings API
+@pytest.mark.fluent_version("==24.2")
 def test_deprecated_settings_with_custom_aliases(new_solver_session):
     solver = new_solver_session
-    if solver.get_fluent_version() >= FluentVersion.v251:
-        # https://github.com/ansys/pyfluent/issues/3134
-        return
     case_path = download_file("mixing_elbow.cas.h5", "pyfluent/mixing_elbow")
     download_file("mixing_elbow.dat.h5", "pyfluent/mixing_elbow")
-    solver.file._setattr("_child_aliases", {"rcd": "read_case_data"})
+    solver.file._setattr("_child_aliases", {"rcd": ("read_case_data", "rcd")})
     with pytest.warns(DeprecatedSettingWarning):
         solver.file.rcd(file_name=case_path)
 
     solver.setup.boundary_conditions.velocity_inlet.child_object_type._child_aliases[
         "mom"
-    ] = "momentum"
+    ] = ("momentum", "mom")
     with pytest.warns(DeprecatedSettingWarning):
         solver.setup.boundary_conditions.velocity_inlet["hot-inlet"].mom.velocity = 20
     assert (
@@ -259,12 +261,9 @@ def test_deprecated_settings_with_custom_aliases(new_solver_session):
         )
         > 0
     )
-    assert (
-        solver.setup.boundary_conditions.wall[
-            "wall-inlet"
-        ].thermal.temperature._child_aliases["constant"]
-        == "value"
-    )
+    assert solver.setup.boundary_conditions.wall[
+        "wall-inlet"
+    ].thermal.temperature._child_aliases["constant"] == ("value", "constant")
     with pytest.warns(DeprecatedSettingWarning):
         solver.setup.boundary_conditions.wall[
             "wall-inlet"
@@ -296,7 +295,7 @@ def test_deprecated_settings_with_custom_aliases(new_solver_session):
         == 410
     )
 
-    solver.setup.boundary_conditions._setattr("_child_aliases", {"w": "wall"})
+    solver.setup.boundary_conditions._setattr("_child_aliases", {"w": ("wall", "w")})
     with pytest.warns(DeprecatedSettingWarning):
         solver.setup.boundary_conditions.w["wall-inlet"].thermal.temperature.value = 420
 
@@ -305,7 +304,7 @@ def test_deprecated_settings_with_custom_aliases(new_solver_session):
         == 420
     )
 
-    solver.setup._setattr("_child_aliases", {"bc": "boundary_conditions"})
+    solver.setup._setattr("_child_aliases", {"bc": ("boundary_conditions", "bc")})
     with pytest.warns(DeprecatedSettingWarning):
         solver.setup.bc.wall["wall-inlet"].thermal.temperature.value = 430
 
@@ -324,7 +323,7 @@ def test_deprecated_settings_with_custom_aliases(new_solver_session):
         == 400
     )
 
-    solver.results._setattr("_child_aliases", {"gr": "graphics"})
+    solver.results._setattr("_child_aliases", {"gr": ("graphics", "gr")})
     with pytest.warns(DeprecatedSettingWarning):
         solver.results.gr.contour.create("c1")
 
@@ -340,7 +339,10 @@ def test_deprecated_settings_with_custom_aliases(new_solver_session):
 
     solver.setup.boundary_conditions.velocity_inlet[
         "hot-inlet"
-    ].momentum.velocity._child_aliases["hd"] = "../../turbulence/hydraulic_diameter"
+    ].momentum.velocity._child_aliases["hd"] = (
+        "../../turbulence/hydraulic_diameter",
+        "hd",
+    )
     with pytest.warns(DeprecatedSettingWarning):
         solver.setup.boundary_conditions.velocity_inlet[
             "hot-inlet"
@@ -360,11 +362,8 @@ def test_deprecated_settings_with_custom_aliases(new_solver_session):
 
 
 @pytest.mark.fluent_version(">=25.1")
-def test_deprecated_settings_with_settings_api_aliases(new_solver_session):
-    solver = new_solver_session
-    case_path = download_file("mixing_elbow.cas.h5", "pyfluent/mixing_elbow")
-    download_file("mixing_elbow.dat.h5", "pyfluent/mixing_elbow")
-    solver.settings.file.read_case_data(file_name=case_path)
+def test_deprecated_settings_with_settings_api_aliases(mixing_elbow_case_data_session):
+    solver = mixing_elbow_case_data_session
     solver.settings.results.surfaces.iso_clip["clip-1"] = {}
     assert solver.settings.results.surfaces.iso_clip["clip-1"].range() == {
         "minimum": 0,
@@ -378,6 +377,44 @@ def test_deprecated_settings_with_settings_api_aliases(new_solver_session):
         "minimum": -0.0001,
         "maximum": 0.0001,
     }
+    solver.settings.results.graphics.contour["temperature"] = {}
+    solver.settings.results.graphics.contour["temperature"] = {
+        "field": "temperature",
+        "surfaces_list": "wall*",
+        "color_map": {
+            "visible": True,
+            "size": 100,
+            "color": "field-velocity",
+            "log_scale": False,
+            "format": "%0.1f",
+            "user_skip": 9,
+            "show_all": True,
+            "position": 1,
+            "font_name": "Helvetica",
+            "font_automatic": True,
+            "font_size": 0.032,
+            "length": 0.54,
+            "width": 6,
+            "bground_transparent": True,
+            "bground_color": "#CCD3E2",
+            "title_elements": "Variable and Object Name",
+        },
+        "range_option": {
+            "option": "auto-range-off",
+            "auto_range_off": {
+                "maximum": 400.0,
+                "minimum": 300,
+                "clip_to_range": False,
+            },
+        },
+    }
+    assert solver.settings.results.graphics.contour["temperature"].range_options() == {
+        "global_range": True,
+        "auto_range": False,
+        "clip_to_range": False,
+        "minimum": 300,
+        "maximum": 400.0,
+    }
 
 
 @pytest.mark.fluent_version(">=23.1")
@@ -482,7 +519,10 @@ def test_child_alias_with_parent_path(mixing_elbow_settings_session):
     solver.settings.solution.initialization.hybrid_initialize()
     assert (
         solver.settings.setup.models.discrete_phase.numerics.node_based_averaging.kernel._child_aliases
-        == {"gaussian_factor": "../gaussian_factor", "option": "../kernel_type"}
+        == {
+            "gaussian_factor": ("../gaussian_factor", "gaussian-factor"),
+            "option": ("../kernel_type", "option"),
+        }
     )
     solver.settings.setup.models.discrete_phase.numerics.node_based_averaging.enabled = (
         True
@@ -512,10 +552,34 @@ def test_child_alias_with_parent_path(mixing_elbow_settings_session):
 
 
 @pytest.mark.fluent_version(">=25.1")
-def test_exit_not_in_settings(new_solver_session):
+def test_commands_not_in_settings(new_solver_session):
     solver = new_solver_session
 
-    assert "exit" not in dir(solver.settings)
+    for command in ["exit", "switch_to_meshing_mode"]:
+        assert command not in dir(solver.settings)
+        with pytest.raises(AttributeError):
+            getattr(solver.settings, command)
 
-    with pytest.raises(AttributeError):
-        solver.settings.exit()
+
+@pytest.mark.fluent_version(">=25.1")
+def test_deprecated_command_arguments(mixing_elbow_case_data_session):
+    solver = mixing_elbow_case_data_session
+    with pytest.warns() as record:
+        # all_boundary_zones is an unknown/unsupported keyword
+        solver.settings.results.report.fluxes.mass_flow(
+            all_boundary_zones=False, zones=["cold-inlet", "hot-inlet", "outlet"]
+        )
+    assert len(record) == 1
+    assert record[0].category == PyFluentUserWarning
+    assert "all_boundary_zones" in str(record[0].message)
+
+    solver.settings.results.graphics.mesh.create("m1")
+    solver.settings.results.graphics.mesh.make_a_copy(from_="m1", to="m2")
+    solver.settings.results.graphics.mesh.copy(
+        from_name="m1", new_name="m3"
+    )  # deprecated
+    assert set(solver.settings.results.graphics.mesh.get_object_names()) == {
+        "m1",
+        "m2",
+        "m3",
+    }

ansys/fluent/tests/test_settings_reader.py

@@ -57,7 +57,7 @@ def test_settings_reader_static_mixer_h5():
 
 def test_meshing_unavailable():
     reader = SettingsReader(settings_file_name=static_mixer_settings_file())
-    with pytest.raises(AttributeError) as msg:
+    with pytest.raises(AttributeError):
         reader.get_mesh()
 
 

ansys/fluent/tests/test_solver_monitors.py

@@ -74,7 +74,7 @@ def test_solver_monitors(new_solver_session):
     # n.b. there is no checking of the callback signature at registration. Instead
     # we would get a TypeError at callback time if the signature is wrong. The correct
     # signature is undocumented.
-    register_id = solver.monitors.register_callback(monitor_callback)
+    solver.monitors.register_callback(monitor_callback)
 
     # trigger callback by running the solver
     assert not monitor_callback.called

ansys/fluent/tests/test_solvermode/test_calculationactivities.py

@@ -7,14 +7,14 @@ from ansys.fluent.core.utils.fluent_version import FluentVersion
 def test_solver_calculation(static_mixer_case_session):
     solver_session = static_mixer_case_session
     scheme_eval = solver_session.scheme_eval.scheme_eval
-    assert scheme_eval("(client-get-var 'residuals/plot?)") == True
+    assert scheme_eval("(client-get-var 'residuals/plot?)") is True
     # TODO: Remove the if condition after a stable version of 23.1 is available and update the commands as required.
     if solver_session.get_fluent_version() < FluentVersion.v231:
         solver_session.tui.solve.monitors.residual.plot("no")
-        assert scheme_eval("(client-get-var 'residuals/plot?)") == False
-    assert scheme_eval("(data-valid?)") == False
+        assert scheme_eval("(client-get-var 'residuals/plot?)") is False
+    assert scheme_eval("(data-valid?)") is False
     solver_session.solution.initialization.hybrid_initialize()
-    assert scheme_eval("(data-valid?)") == True
+    assert scheme_eval("(data-valid?)") is True
     # solver_session.solution.run_calculation.iterate.get_attr("arguments")
     # solver_session.solution.run_calculation.number_of_iterations = 5
     # assert solver_session.solution.run_calculation.number_of_iterations == 5

ansys/fluent/tests/test_solvermode/test_controls.py

@@ -43,8 +43,8 @@ def test_controls(mixing_elbow_settings_session):
     )
     assert param_coarsening.max_coarse_levels() == 48
     assert param_coarsening.coarsen_by_interval() == 9
-    assert param_coarsening.conservative_coarsening() == True
-    assert param_coarsening.aggressive_coarsening() == True
+    assert param_coarsening.conservative_coarsening() is True
+    assert param_coarsening.aggressive_coarsening() is True
 
     param_fixed_cycle = (
         solver.solution.controls.advanced.multi_grid.amg_controls.scalar_parameters.fixed_cycle_parameters
@@ -66,7 +66,7 @@ def test_controls(mixing_elbow_settings_session):
     solver.solution.methods.p_v_coupling.flow_scheme = "Coupled"
     assert solver.solution.methods.p_v_coupling.flow_scheme() == "Coupled"
     solver.solution.methods.p_v_coupling.coupled_form = True
-    assert solver.solution.methods.p_v_coupling.coupled_form() == True
+    assert solver.solution.methods.p_v_coupling.coupled_form() is True
     solver.solution.controls.advanced.multi_grid.amg_controls.scalar_parameters.smoother_type = (
         "Gauss-Seidel"
     )

ansys/fluent/tests/test_solvermode/test_methods.py

@@ -57,7 +57,7 @@ def test_methods(mixing_elbow_settings_session):
         "first_to_second_order_blending": 1.0,
     }
     solver.solution.methods.expert.numerics_pbns.presto_pressure_scheme = True
-    assert solver.solution.methods.expert.numerics_pbns.presto_pressure_scheme() == True
+    assert solver.solution.methods.expert.numerics_pbns.presto_pressure_scheme() is True
     solver.solution.methods.gradient_scheme = "green-gauss-node-based"
     assert solver.solution.methods.gradient_scheme() == "green-gauss-node-based"
     solver.solution.methods.warped_face_gradient_correction(

ansys/fluent/tests/test_solvermode/test_models.py

@@ -82,16 +82,16 @@ def test_disk_2d_models(disk_settings_session):
     ]
     k_omega_options = models.viscous.k_omega_options
     k_omega_options.kw_low_re_correction = True
-    assert k_omega_options.kw_low_re_correction() == True
+    assert k_omega_options.kw_low_re_correction() is True
 
     turb_options = models.viscous.options
     turb_options.production_kato_launder_enabled = True
-    assert turb_options.production_kato_launder_enabled() == True
+    assert turb_options.production_kato_launder_enabled() is True
     turb_options.production_limiter.clip_factor = 9
     assert turb_options.production_limiter.clip_factor() == 9
     turb_expert = models.viscous.turbulence_expert
     turb_expert.turb_non_newtonian = True
-    assert turb_expert.turb_non_newtonian() == True
+    assert turb_expert.turb_non_newtonian() is True
 
     models.viscous.model = "laminar"
     assert models.viscous.model() == "laminar"

ansys/fluent/tests/test_systemcoupling.py

@@ -1,9 +1,25 @@
 import pytest
 
 
-@pytest.mark.fluent_version(">=24.1")
-def test_systemcoupling_mixing_elbow_settings(mixing_elbow_case_data_session):
-    """Very superficial test of System Coupling related settings."""
+@pytest.mark.fluent_version(">=25.1")
+def test_systemcoupling_mixing_elbow_settings_apis(mixing_elbow_case_data_session):
+    """Test System Coupling related settings APIs"""
+    solver = mixing_elbow_case_data_session
+    # enable the feature flag to be able to make the queries
+    solver.scheme_eval.scheme_eval("(enable-feature 'sc/participant-info)")
+    elbow_fluid = "elbow-fluid"
+    region_names = solver.settings.setup.models.system_coupling.get_all_regions()
+    assert elbow_fluid in region_names
+    # elbow fluid must be a volume
+    assert (
+        solver.settings.setup.models.system_coupling.get_topology(
+            region_name=elbow_fluid
+        )
+        == "Volume"
+    )
+
+
+def _test_systemcoupling_mixing_elbow_settings_common(mixing_elbow_case_data_session):
     solver = mixing_elbow_case_data_session
     # check participant type, analysis type, regions, and variables
     assert solver.system_coupling.participant_type == "FLUENT"
@@ -12,5 +28,17 @@ def test_systemcoupling_mixing_elbow_settings(mixing_elbow_case_data_session):
     variables = solver.system_coupling.get_variables()
     # [wall-inlet, wall-elbow, elbow-fluid, hot-inlet, cold-inlet, outlet]
     assert len(regions) >= 6
-    # [force, dsip, temp, htc, hflow, nwt, hrate, cond, lorentz-force]
-    assert len(variables) >= 9
+    # [force, temp, htc, hflow, nwt, hrate, e-cond, lorentz-force]
+    assert len(variables) >= 8
+
+
+@pytest.mark.fluent_version(">=25.1")
+def test_systemcoupling_mixing_elbow_settings(mixing_elbow_case_data_session):
+    """Very superficial test of System Coupling related settings."""
+    _test_systemcoupling_mixing_elbow_settings_common(mixing_elbow_case_data_session)
+
+
+@pytest.mark.fluent_version(">=24.1,<25.1")
+def test_systemcoupling_mixing_elbow_settings_legacy(mixing_elbow_case_data_session):
+    """Test legacy implementation of getting System Coupling related settings."""
+    _test_systemcoupling_mixing_elbow_settings_common(mixing_elbow_case_data_session)

ansys/fluent/tests/test_topy.py

@@ -110,7 +110,7 @@ def test_2_jou():
         + "_"
         + Path(file_name_2).stem.split(".")[0]
         + ".py"
-    )  # noqa: E501
+    )
     gen_file_name = os.path.join(os.getcwd(), gen_file_name)
 
     with open(gen_file_name) as file:
@@ -162,7 +162,7 @@ def test_2_scm():
         + "_"
         + Path(file_name_2).stem.split(".")[0]
         + ".py"
-    )  # noqa: E501
+    )
     gen_file_name = os.path.join(os.getcwd(), gen_file_name)
 
     with open(gen_file_name) as file:

ansys/fluent/tests/test_tui_api.py

@@ -61,10 +61,10 @@ def test_exit_not_in_meshing_tui(new_meshing_session):
         meshing.tui.exit()
 
 
-def test_exit_not_in_solver_tui(new_solver_session):
+def test_commands_not_in_solver_tui(new_solver_session):
     solver = new_solver_session
 
-    assert "exit" not in dir(solver.tui)
-
-    with pytest.raises(AttributeError):
-        solver.tui.exit()
+    for command in ["exit", "switch_to_meshing_mode"]:
+        assert command not in dir(solver.tui)
+        with pytest.raises(AttributeError):
+            getattr(solver.tui, command)

ansys/fluent/tests/test_utils.py

@@ -54,7 +54,7 @@ def test_timeout_loop():
     ret = timeout_loop(waiter, timeout=0.2, expected="truthy", idle_period=0.1)
     assert ret is False
 
-    with pytest.raises(InvalidArgument) as msg:
+    with pytest.raises(InvalidArgument):
         timeout_loop(waiter, timeout=0.2, expected=True, idle_period=0.1)
 
 

{ansys_fluent_core-0.27.dev1.dist-info → ansys_fluent_core-0.28.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ansys-fluent-core
-Version: 0.27.dev1
+Version: 0.28.dev0
 Summary: PyFluent provides Pythonic access to Ansys Fluent
 Home-page: https://github.com/ansys/pyfluent
 License: MIT
@@ -16,32 +16,21 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Provides-Extra: examples
 Provides-Extra: reader
 Provides-Extra: tests
-Requires-Dist: alive-progress (>=3.1.5)
-Requires-Dist: ansys-api-fluent (>=0.3.27,<0.4.0)
+Requires-Dist: ansys-api-fluent (>=0.3.28,<0.4.0)
 Requires-Dist: ansys-platform-instancemanagement (>=1.0,<2.0)
 Requires-Dist: ansys-tools-filetransfer (>=0.1,<0.3)
-Requires-Dist: ansys-units (>=0.3.2,<0.4.0)
-Requires-Dist: beartype (>=0.17)
+Requires-Dist: ansys-units (>=0.3.3,<0.4.0)
 Requires-Dist: docker (>=7.1.0)
 Requires-Dist: grpcio (>=1.30.0,<2.0.0)
 Requires-Dist: grpcio-health-checking (>=1.30.0,<2.0.0)
 Requires-Dist: h5py (==3.12.1) ; extra == "reader"
 Requires-Dist: lxml (>=4.9.2)
 Requires-Dist: nltk (>=3.9.1)
-Requires-Dist: numpy (>=1.14.0,<2.0.0)
-Requires-Dist: openpyxl (>=3.1.5) ; extra == "examples"
+Requires-Dist: numpy (>=1.14.0,<3.0.0)
 Requires-Dist: pandas (>=1.1.0,<2.3)
-Requires-Dist: platformdirs (>=3.6.0)
-Requires-Dist: plotly (>=5.22.0) ; extra == "examples"
-Requires-Dist: psutil (>=5.9.5)
-Requires-Dist: python-pptx (>=0.6.23) ; extra == "examples"
 Requires-Dist: pyyaml (>=6.0)
-Requires-Dist: requests (>=2.32.3)
-Requires-Dist: seaborn (>=0.13.2) ; extra == "examples"
-Requires-Dist: tensorflow (>=2.17.0) ; extra == "examples"
 Project-URL: Documentation, https://fluent.docs.pyansys.com/
 Project-URL: Repository, https://github.com/ansys/pyfluent
 Project-URL: Source, https://github.com/ansys/pyfluent
@@ -117,7 +106,7 @@ To reach the project support team, email `pyansys.core@ansys.com <pyansys.core@a
 Installation
 ------------
 The ``ansys-fluent-core`` package supports Python 3.9 through Python
-3.12 on Windows and Linux.
+3.13 on Windows and Linux.
 
 Install the latest release from `PyPI
 <https://pypi.org/project/ansys-fluent-core/>`_ with:
@@ -149,7 +138,7 @@ example, the installer automatically sets the ``AWP_ROOT232`` environment variab
 to ``C:\Program Files\ANSYS Inc\v232``.
 
 On Linux, the required environment variable is not set automatically, and can be set for the
-current user in the current shell session, using Fluent 2023 R1 in the default installation
+current user in the current shell session, using Fluent 2023 R2 in the default installation
 directory as an example, before running PyFluent, with:
 
 .. code:: console