Renamed type_name to wall_function_type in WallFunction (#1899)

Co-authored-by: benflexcompute <ben@flexcompute.com>
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: 3 people

flow360/component/simulation/framework/updater.py

@@ -778,6 +778,17 @@ def _rename_in_entity(entity):
     return params_as_dict
 
 
+def _to_25_9_3(params_as_dict):
+    """Rename ``type_name`` to ``wall_function_type`` in ``use_wall_function`` dicts."""
+    for model in params_as_dict.get("models", []):
+        if model.get("type") != "Wall":
+            continue
+        wall_fn = model.get("use_wall_function")
+        if isinstance(wall_fn, dict) and "type_name" in wall_fn:
+            wall_fn["wall_function_type"] = wall_fn.pop("type_name")
+    return params_as_dict
+
+
 VERSION_MILESTONES = [
     (Flow360Version("24.11.1"), _to_24_11_1),
     (Flow360Version("24.11.7"), _to_24_11_7),
@@ -800,6 +811,7 @@ def _rename_in_entity(entity):
     (Flow360Version("25.9.0"), _to_25_9_0),
     (Flow360Version("25.9.1"), _to_25_9_1),
     (Flow360Version("25.9.2"), _to_25_9_2),
+    (Flow360Version("25.9.3"), _to_25_9_3),
 ]  # A list of the Python API version tuple with their corresponding updaters.
 
 

flow360/component/simulation/models/surface_models.py

@@ -341,13 +341,13 @@ class WallFunction(Flow360BaseModel):
 
       >>> fl.Wall(
       ...     entities=volume_mesh["fluid/wall"],
-      ...     use_wall_function=fl.WallFunction(type_name="InnerLayer"),
+      ...     use_wall_function=fl.WallFunction(wall_function_type="InnerLayer"),
       ... )
 
     ====
     """
 
-    type_name: Literal["BoundaryLayer", "InnerLayer"] = pd.Field(
+    wall_function_type: Literal["BoundaryLayer", "InnerLayer"] = pd.Field(
         "BoundaryLayer",
         description="Type of wall function model. "
         + "'BoundaryLayer' uses integral flat plate boundary layer theory to predict wall shear stress. "
@@ -377,7 +377,7 @@ class Wall(BoundaryBase):
 
       >>> fl.Wall(
       ...     entities=volume_mesh["8"],
-      ...     use_wall_function=fl.WallFunction(type_name="InnerLayer"),
+      ...     use_wall_function=fl.WallFunction(wall_function_type="InnerLayer"),
       ... )
 
     - :code:`Wall` with wall function and wall rotation:

flow360/component/simulation/translator/solver_translator.py

@@ -1590,7 +1590,7 @@ def boundary_spec_translator(model: SurfaceModelTypes, op_acoustic_to_static_pre
     if isinstance(model, Wall):
         if model.use_wall_function is not None:
             boundary["type"] = "WallFunction"
-            boundary["wallModelType"] = model.use_wall_function.type_name
+            boundary["wallModelType"] = model.use_wall_function.wall_function_type
         else:
             boundary["type"] = "NoSlipWall"
         if model.velocity is not None:

flow360/version.py

@@ -2,5 +2,5 @@
 version
 """
 
-__version__ = "25.9.2b1"
+__version__ = "25.9.3b1"
 __solver_version__ = "release-25.8"

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "flow360"
-version = "v25.9.2b1"
+version = "v25.9.3b1"
 description = "Flow360 Python Client"
 authors = ["Flexcompute <support@flexcompute.com>"]
 

tests/simulation/params/test_validators_params.py

@@ -298,7 +298,7 @@ def test_wall_function_type_interface():
     # True is converted to WallFunction() with default BoundaryLayer and logs deprecation warning
     wall = Wall(surfaces=[surface], use_wall_function=True)
     assert wall.use_wall_function == WallFunction()
-    assert wall.use_wall_function.type_name == "BoundaryLayer"
+    assert wall.use_wall_function.wall_function_type == "BoundaryLayer"
 
     # False is converted to None and logs deprecation warning
     wall = Wall(surfaces=[surface], use_wall_function=False)
@@ -308,26 +308,26 @@ def test_wall_function_type_interface():
     wall = Wall(surfaces=[surface])
     assert wall.use_wall_function is None
 
-    # WallFunction with default type_name
+    # WallFunction with default wall_function_type
     wall = Wall(surfaces=[surface], use_wall_function=WallFunction())
-    assert wall.use_wall_function.type_name == "BoundaryLayer"
+    assert wall.use_wall_function.wall_function_type == "BoundaryLayer"
 
     # WallFunction with InnerLayer
-    wall = Wall(surfaces=[surface], use_wall_function=WallFunction(type_name="InnerLayer"))
-    assert wall.use_wall_function.type_name == "InnerLayer"
+    wall = Wall(surfaces=[surface], use_wall_function=WallFunction(wall_function_type="InnerLayer"))
+    assert wall.use_wall_function.wall_function_type == "InnerLayer"
 
     # SlaterPorousBleed conflict applies to all wall function types
     message = "Using `SlaterPorousBleed` with wall function is not supported currently."
     with SI_unit_system, pytest.raises(ValueError, match=re.escape(message)):
         Wall(
             velocity=SlaterPorousBleed(porosity=0.2, static_pressure=1e5 * u.Pa),
             surfaces=[surface],
-            use_wall_function=WallFunction(type_name="InnerLayer"),
+            use_wall_function=WallFunction(wall_function_type="InnerLayer"),
         )
 
-    # Invalid type_name should be rejected by pydantic
+    # Invalid wall_function_type should be rejected by pydantic
     with pytest.raises(pd.ValidationError):
-        Wall(surfaces=[surface], use_wall_function=WallFunction(type_name="InvalidType"))
+        Wall(surfaces=[surface], use_wall_function=WallFunction(wall_function_type="InvalidType"))
 
 
 def test_low_mach_preconditioner_validator(

tests/simulation/test_updater.py

@@ -2109,3 +2109,28 @@ def test_updater_to_25_9_2_custom_volume_boundaries_via_updater():
 
     assert "boundaries" not in cv
     assert "bounding_entities" in cv
+
+
+def test_updater_to_25_9_3_rename_wall_function_type_name():
+    """Test 25.9.3 updater renames type_name to wall_function_type in use_wall_function."""
+
+    params_as_dict = {
+        "version": "25.9.2",
+        "unit_system": {"name": "SI"},
+        "models": [
+            {"type": "Wall", "use_wall_function": {"type_name": "BoundaryLayer"}, "name": "w1"},
+            {"type": "Wall", "use_wall_function": {"type_name": "InnerLayer"}, "name": "w2"},
+            {"type": "Wall", "use_wall_function": None, "name": "w3"},
+            {"type": "Wall", "name": "w4"},
+            {"type": "Freestream"},
+        ],
+    }
+
+    params_new = updater("25.9.2", "25.9.3", params_as_dict)
+    models = params_new["models"]
+
+    assert models[0]["use_wall_function"] == {"wall_function_type": "BoundaryLayer"}
+    assert models[1]["use_wall_function"] == {"wall_function_type": "InnerLayer"}
+    assert models[2]["use_wall_function"] is None
+    assert "use_wall_function" not in models[3]
+    assert models[4].get("type") == "Freestream"

tests/simulation/translator/test_solver_translator.py

@@ -665,7 +665,10 @@ def test_wall_model_type_translation():
             operating_condition=AerospaceCondition.from_mach(mach=0.84),
             models=[
                 Fluid(),
-                Wall(surfaces=[my_wall], use_wall_function=WallFunction(type_name="InnerLayer")),
+                Wall(
+                    surfaces=[my_wall],
+                    use_wall_function=WallFunction(wall_function_type="InnerLayer"),
+                ),
                 Freestream(entities=[my_freestream]),
             ],
             time_stepping=Steady(CFL=RampCFL(initial=5, final=200, ramp_steps=40)),
@@ -681,7 +684,7 @@ def test_wall_model_type_translation():
                 Fluid(),
                 Wall(
                     surfaces=[my_wall],
-                    use_wall_function=WallFunction(type_name="BoundaryLayer"),
+                    use_wall_function=WallFunction(wall_function_type="BoundaryLayer"),
                 ),
                 Freestream(entities=[my_freestream]),
             ],

tests/test_current_flow360_version.py

@@ -2,4 +2,4 @@
 
 
 def test_version():
-    assert __version__ == "25.9.2b1"
+    assert __version__ == "25.9.3b1"