fix: Implement migration adapter check for textual settings parameters. (#4515)

This change updates the type-checking logic to correctly handle cases
where a migration adapter is present.

**Previous Behavior**

When setting a textual attribute through PyFluent, type checking was
performed before delegating to the underlying Settings API.
If the provided value did not strictly match the expected type, PyFluent
raised a TypeError, even in cases where a migration adapter existed to
handle type conversion.

For example:
```python
>>> solver.settings.setup.models.discrete_phase.general_settings.unsteady_tracking.create_particles_at = False
```
Here, the property accepts a string value, but a migration adapter is
available that correctly converts a boolean (False) into the appropriate
string value.
Previously, PyFluent would still raise a TypeError before this
conversion could occur.

**Current Behavior**

If a migration adapter exists for a setting, PyFluent now bypasses type
checking and directly forwards the input to the Settings API.
This allows the migration adapter to handle type conversions or other
logic as intended.

Please refer to the test to see the detailed usage.

The change aligns PyFluent behavior with the Fluent-side fix (ref. bug
1293534).

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Sean Pearson <[email protected]>

Author: 3 people

doc/changelog.d/4515.fixed.md

@@ -0,0 +1 @@
+Implement migration adapter check for textual settings parameters.

src/ansys/fluent/core/solver/flobject.py

@@ -686,9 +686,11 @@ def set_state(self, state: StateT | None = None, **kwargs):
         allowed_types = (str, VariableDescriptor)
 
         if not isinstance(state, allowed_types):
-            expected = " or ".join(t.__name__ for t in allowed_types)
+            if self._has_migration_adapter:
+                return self.base_set_state(state=state, **kwargs)
             raise TypeError(
-                f"Expected state to be {expected}, got {type(state).__name__}."
+                f"Expected state to be {' or '.join(t.__name__ for t in allowed_types)}, "
+                f"got {type(state).__name__}."
             )
         return self.base_set_state(state=_to_field_name_str(state), **kwargs)
 

tests/test_settings_api.py

@@ -793,3 +793,39 @@ def test_setting_string_constants(mixing_elbow_settings_session):
 
     with pytest.raises(ValueError):
         viscous.k_epsilon_model = viscous.k_epsilon_model.EASM
+
+
+@pytest.mark.fluent_version(">=26.1")
+def test_migration_adapter_for_strings(mixing_elbow_settings_session):
+    solver = mixing_elbow_settings_session
+    solver.settings.setup.general.solver.time = "unsteady-2nd-order"
+    solver.settings.setup.models.discrete_phase.general_settings.interaction.enabled = (
+        True
+    )
+
+    solver.settings.setup.models.discrete_phase.general_settings.unsteady_tracking.enabled = (
+        True
+    )
+    solver.settings.setup.models.discrete_phase.general_settings.unsteady_tracking.option = (
+        "particle-time-step"
+    )
+    solver.settings.setup.models.discrete_phase.general_settings.unsteady_tracking.dpm_time_step_size = (
+        0.0002
+    )
+
+    # Migration adapter is set on the 'create_particles_at' to accept boolean values as well besides string
+    solver.settings.setup.models.discrete_phase.general_settings.unsteady_tracking.create_particles_at = (
+        False
+    )
+    assert (
+        solver.settings.setup.models.discrete_phase.general_settings.unsteady_tracking.create_particles_at()
+        == "fluid-flow-time-step"
+    )
+
+    solver.settings.setup.models.discrete_phase.general_settings.unsteady_tracking.create_particles_at = (
+        True
+    )
+    assert (
+        solver.settings.setup.models.discrete_phase.general_settings.unsteady_tracking.create_particles_at()
+        == "particle-time-step"
+    )