fix: solver session settings access in tests and examples #4512

Gobot1234 · 2025-10-02T14:37:00Z

Definitely needs testing cause it was a big find and replace job

tests/test_settings_api.py

tests/test_search.py

tests/test_flobject.py

src/ansys/fluent/core/search.py

examples/00-fluent/DOE_ML.py

examples/00-fluent/ahmed_body_workflow.py

doc/source/user_guide/usability.rst

examples/00-fluent/brake.py

Gobot1234 · 2025-10-06T13:20:24Z

examples/00-fluent/exhaust_system_settings_api.py

+###############################################################################
+# Confirm and update boundaries
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Confirm and update the boundaries.
+
+meshing_session.workflow.TaskObject["Update Boundaries"].Execute()
+


Suggested change

###############################################################################

# Confirm and update boundaries

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

# Confirm and update the boundaries.

meshing_session.workflow.TaskObject["Update Boundaries"].Execute()

Gobot1234 · 2025-10-06T13:20:45Z

examples/00-fluent/exhaust_system_settings_api.py

-# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Confirm and update the boundaries.
-
-meshing_session.workflow.TaskObject["Update Boundaries"].Execute()


This looked sus (moving the code around)

Suggested change

meshing_session.workflow.TaskObject["Update Boundaries"].Execute()

###############################################################################

# Confirm and update boundaries

# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

# Confirm and update the boundaries.

meshing_session.workflow.TaskObject["Update Boundaries"].Execute()

src/ansys/fluent/core/search.py

Gobot1234 · 2025-10-06T13:30:07Z

tests/test_search.py


    pyfluent.config.print_search_results = False
-    results = pyfluent.search("local*", api_path="<solver_session>.setup")
+    results = pyfluent.search("local*", api_path="<solver_session>.setup.")


Suggested change

results = pyfluent.search("local*", api_path="<solver_session>.setup.")

results = pyfluent.search("local*", api_path="<solver_session>.setup")

examples/00-fluent/exhaust_system_settings_api.py

Copilot

Pull Request Overview

This PR fixes access to solver session settings throughout the test suite and examples. The changes update all references from direct access patterns (e.g., solver.setup.models) to the correct settings-based access pattern (e.g., solver.settings.setup.models). This is a comprehensive update ensuring consistent API usage across the entire codebase.

Updates solver session settings access pattern in tests and examples
Adds missing .settings prefix to all solver session attribute access
Minor formatting improvements and code cleanup

Reviewed Changes

Copilot reviewed 69 out of 70 changed files in this pull request and generated 6 comments.

File	Description
tests/*.py	Updated solver session settings access to use `.settings` prefix
examples/*.py	Updated solver session settings access pattern in all examples
src/ansys/fluent/core/*.py	Updated settings access in core modules
doc/source/*.rst	Updated documentation examples to use correct settings API

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-09T09:53:30Z

tests/test_reduction.py

        solver.fields.reduction.area(
-            locations=[solver.setup.boundary_conditions.velocity_inlet]
+            locations=[
+                solver.settings.setup.gs.setup.boundary_conditions.velocity_inlet


There's an incorrect duplicate 'setup' path segment in this line. Should be solver.settings.setup.boundary_conditions.velocity_inlet instead of solver.settings.setup.gs.setup.boundary_conditions.velocity_inlet.

Suggested change

solver.settings.setup.gs.setup.boundary_conditions.velocity_inlet

solver.settings.setup.boundary_conditions.velocity_inlet

Copilot · 2025-10-09T09:53:30Z

tests/parametric/test_parametric_workflow.py

 def test_parameters_list_function(static_mixer_settings_session):
    solver = static_mixer_settings_session
-    solver.tui.define.parameters.enable_in_TUI("yes")
+    solver.tui.define.settings.parameters.enable_in_TUI("yes")


The TUI path is incorrect. It should be solver.tui.define.parameters.enable_in_TUI("yes") without the .settings segment, as TUI commands don't use the settings API.

Suggested change

solver.tui.define.settings.parameters.enable_in_TUI("yes")

solver.tui.define.parameters.enable_in_TUI("yes")

Copilot · 2025-10-09T09:53:31Z

tests/parametric/test_parametric_workflow.py

    outlet_vel_avg.surface_names = ["outlet"]

-    create_output_param = solver.tui.define.parameters.output_parameters.create
+    create_output_param = solver.tui.define.settings.parameters.output_parameters.create


The TUI path is incorrect. It should be solver.tui.define.parameters.output_parameters.create without the .settings segment, as TUI commands don't use the settings API.

Suggested change

create_output_param = solver.tui.define.settings.parameters.output_parameters.create

create_output_param = solver.tui.define.parameters.output_parameters.create

Copilot · 2025-10-09T09:53:31Z

tests/parametric/test_parametric_workflow.py

 def test_parameters_list_function(static_mixer_settings_session):
    solver = static_mixer_settings_session
-    solver.tui.define.parameters.enable_in_TUI("yes")
+    solver.tui.define.settings.parameters.enable_in_TUI("yes")


The TUI path is incorrect. It should be solver.tui.define.parameters.enable_in_TUI("yes") without the .settings segment, as TUI commands don't use the settings API.

Suggested change

solver.tui.define.settings.parameters.enable_in_TUI("yes")

solver.tui.define.parameters.enable_in_TUI("yes")

Copilot · 2025-10-09T09:53:31Z

tests/parametric/test_parametric_workflow.py

    outlet_vel_avg.surface_names = ["outlet"]

-    create_output_param = solver.tui.define.parameters.output_parameters.create
+    create_output_param = solver.tui.define.settings.parameters.output_parameters.create


The TUI path is incorrect. It should be solver.tui.define.parameters.output_parameters.create without the .settings segment, as TUI commands don't use the settings API.

Suggested change

create_output_param = solver.tui.define.settings.parameters.output_parameters.create

create_output_param = solver.tui.define.parameters.output_parameters.create

examples/00-fluent/tyler_sofrin_modes.py

Copilot

Pull Request Overview

Copilot reviewed 68 out of 69 changed files in this pull request and generated 6 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-09T16:15:40Z

tests/test_reduction.py

-    solver.solution.initialization.hybrid_initialize()
-    # After reading the static-mixer case in Fluent, case-modified? flag is somehow True
+    solver.settings.solution.initialization.hybrid_initialize()
+    # After reading the static-mixer case in Fluent, case-modifed? flag is somehow True


Corrected spelling of 'modifed' to 'modified'.

Suggested change

# After reading the static-mixer case in Fluent, case-modifed? flag is somehow True

# After reading the static-mixer case in Fluent, case-modified? flag is somehow True

Copilot · 2025-10-09T16:15:41Z

examples/00-fluent/modeling_ablation.py

 solver_session = pyfluent.launch_fluent(
-    dimension=3,
    precision="double",
    processor_count=4,


The removed dimension=3 parameter should be restored as it explicitly specifies the 3D solver mode for this ablation modeling example.

Suggested change

processor_count=4,

processor_count=4,

dimension=3,

Copilot · 2025-10-09T16:15:41Z

examples/00-fluent/brake.py

 # ---------------------------------------------------------------

-session = pyfluent.launch_fluent(precision="double", processor_count=2, version="3d")
+session = pyfluent.launch_fluent(precision="double", processor_count=2, dimension=3)


The parameter name has been changed from 'version' to 'dimension', but the comment on line 74 still mentions 'version'. Consider updating the comment to reflect the correct parameter name.

Copilot · 2025-10-09T16:15:42Z

examples/00-fluent/conjugate_heat_transfer.py

    mode="meshing",
-    dimension=3,
    precision="double",
    processor_count=4,


The removed dimension=3 parameter should be restored as it's needed to specify 3D meshing mode for this conjugate heat transfer example.

Suggested change

processor_count=4,

processor_count=4,

dimension=3,

Copilot · 2025-10-09T16:15:42Z

examples/00-fluent/external_compressible_flow.py

 )

-meshing_session.upload(wing_intermediary_file)
 geo_import.Execute()


The removed line 'meshing_session.upload(wing_intermediary_file)' should be restored as it's needed to upload the geometry file before executing the import operation.

Copilot · 2025-10-09T16:15:42Z

examples/00-fluent/exhaust_system_settings_api.py

 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Import the CAD geometry file (``exhaust_system.fmd``) and selectively manage some
 # parts.



The removed line 'meshing_session.upload(import_file_name)' should be restored as it's needed to upload the CAD file before calling InputFileChanged.

Suggested change

meshing_session.upload(import_file_name)

Gobot1234 requested review from mkundu1, seanpearsonuk, prmukherj, hpohekar and mayankansys as code owners October 2, 2025 14:37