Add updater for two new validations

Author: angranl-flex

flow360/component/simulation/framework/updater.py

@@ -386,6 +386,68 @@ def _to_25_7_6(params_as_dict):
     return remove_entity_bucket_field(params_as_dict=params_as_dict)
 
 
+def _to_25_7_7(params_as_dict):
+    """
+    1. Reset frequency and frequency_offset to defaults for steady simulations
+    2. Remove invalid output fields based on transition model
+    """
+
+    # 1. Handle frequency settings in steady simulations
+    if params_as_dict.get("time_stepping", {}).get("type_name") == "Steady":
+        outputs = params_as_dict.get("outputs") or []
+        for output in outputs:
+            # Output types that have frequency/frequency_offset settings
+            if output.get("output_type") in [
+                "VolumeOutput",
+                "TimeAverageVolumeOutput",
+                "SurfaceOutput",
+                "TimeAverageSurfaceOutput",
+                "SliceOutput",
+                "TimeAverageSliceOutput",
+                "IsosurfaceOutput",
+                "TimeAverageIsosurfaceOutput",
+                "SurfaceSliceOutput",
+            ]:
+                # Reset to defaults: frequency=-1, frequency_offset=0
+                if "frequency" in output:
+                    output["frequency"] = -1
+                if "frequency_offset" in output:
+                    output["frequency_offset"] = 0
+
+    # 2. Remove invalid output fields based on transition model
+    # Get transition model type from models
+    transition_model_type = "None"
+    models = params_as_dict.get("models") or []
+    for model in models:
+        if model.get("type") == "Fluid":
+            transition_solver = model.get("transition_model_solver") or {}
+            transition_model_type = transition_solver.get("type_name")
+            break
+
+    # If transition model is None or not found, remove transition-specific fields
+    if transition_model_type == "None":
+        transition_output_fields = [
+            "residualTransition",
+            "solutionTransition",
+            "linearResidualTransition",
+        ]
+
+        outputs = params_as_dict.get("outputs") or []
+        for output in outputs:
+            if output.get("output_type") in ["AeroAcousticOutput", "StreamlineOutput"]:
+                continue
+            if "output_fields" in output:
+                output_fields = output["output_fields"]
+                if isinstance(output_fields, dict) and "items" in output_fields:
+                    items = output_fields["items"]
+                    # Remove invalid fields
+                    output_fields["items"] = [
+                        field for field in items if field not in transition_output_fields
+                    ]
+
+    return params_as_dict
+
+
 VERSION_MILESTONES = [
     (Flow360Version("24.11.1"), _to_24_11_1),
     (Flow360Version("24.11.7"), _to_24_11_7),
@@ -400,6 +462,7 @@ def _to_25_7_6(params_as_dict):
     (Flow360Version("25.6.6"), _to_25_6_6),
     (Flow360Version("25.7.2"), _to_25_7_2),
     (Flow360Version("25.7.6"), _to_25_7_6),
+    (Flow360Version("25.7.7"), _to_25_7_7),
 ]  # A list of the Python API version tuple with there corresponding updaters.
 
 

tests/simulation/test_updater.py

@@ -877,3 +877,246 @@ def test_updater_to_25_7_6_rename_rotation_cylinder():
 
     assert params_new["version"] == "25.7.6"
     assert params_new["meshing"]["volume_zones"][0]["type"] == "RotationVolume"
+
+
+def test_updater_to_25_7_7():
+    """Test updater for version 25.7.7 which handles:
+    1. Resetting frequency/frequency_offset to defaults for steady simulations
+    2. Removing transition-specific output fields when transition model is None
+    """
+
+    # Construct test params with:
+    # - Steady simulation with non-default frequency settings
+    # - Transition model set to None with transition-specific output fields
+    params_as_dict = {
+        "version": "25.7.6",
+        "time_stepping": {
+            "type_name": "Steady",
+            "max_steps": 1000,
+        },
+        "models": [
+            {
+                "type": "Fluid",
+                "transition_model_solver": {
+                    "type_name": "None",
+                },
+                "turbulence_model_solver": {
+                    "type_name": "SpalartAllmaras",
+                },
+            }
+        ],
+        "outputs": [
+            {
+                "output_type": "VolumeOutput",
+                "name": "Volume output",
+                "frequency": 10,
+                "frequency_offset": 5,
+                "output_format": "paraview",
+                "output_fields": {
+                    "items": [
+                        "primitiveVars",
+                        "residualNavierStokes",
+                        "residualTransition",
+                        "Mach",
+                    ]
+                },
+            },
+            {
+                "output_type": "SurfaceOutput",
+                "name": "Surface output",
+                "frequency": 20,
+                "frequency_offset": 10,
+                "output_format": "paraview",
+                "entities": {"stored_entities": []},
+                "output_fields": {
+                    "items": [
+                        "Cp",
+                        "Cf",
+                        "solutionTransition",
+                    ]
+                },
+            },
+            {
+                "output_type": "SliceOutput",
+                "name": "Slice output",
+                "frequency": 15,
+                "frequency_offset": 2,
+                "output_format": "paraview",
+                "entities": {"stored_entities": []},
+                "output_fields": {
+                    "items": [
+                        "vorticity",
+                        "linearResidualTransition",
+                    ]
+                },
+            },
+            {
+                "output_type": "ProbeOutput",
+                "name": "Probe output",
+                "entities": {"stored_entities": []},
+                "output_fields": {
+                    "items": [
+                        "primitiveVars",
+                        "residualTransition",
+                    ]
+                },
+            },
+            {
+                "output_type": "AeroAcousticOutput",
+                "name": "Aeroacoustic output",
+                "observers": [],
+            },
+        ],
+    }
+
+    params_new = updater(
+        version_from="25.7.6",
+        version_to="25.7.7",
+        params_as_dict=params_as_dict,
+    )
+
+    # Test 1: Verify frequency settings were reset to defaults for steady simulation
+    assert (
+        params_new["outputs"][0]["frequency"] == -1
+    ), "VolumeOutput frequency should be reset to -1"
+    assert (
+        params_new["outputs"][0]["frequency_offset"] == 0
+    ), "VolumeOutput frequency_offset should be reset to 0"
+
+    assert (
+        params_new["outputs"][1]["frequency"] == -1
+    ), "SurfaceOutput frequency should be reset to -1"
+    assert (
+        params_new["outputs"][1]["frequency_offset"] == 0
+    ), "SurfaceOutput frequency_offset should be reset to 0"
+
+    assert (
+        params_new["outputs"][2]["frequency"] == -1
+    ), "SliceOutput frequency should be reset to -1"
+    assert (
+        params_new["outputs"][2]["frequency_offset"] == 0
+    ), "SliceOutput frequency_offset should be reset to 0"
+
+    # Test 2: Verify transition-specific output fields were removed
+    volume_output_fields = params_new["outputs"][0]["output_fields"]["items"]
+    assert "residualTransition" not in volume_output_fields, "residualTransition should be removed"
+    assert "primitiveVars" in volume_output_fields, "primitiveVars should remain"
+    assert "residualNavierStokes" in volume_output_fields, "residualNavierStokes should remain"
+    assert "Mach" in volume_output_fields, "Mach should remain"
+
+    surface_output_fields = params_new["outputs"][1]["output_fields"]["items"]
+    assert "solutionTransition" not in surface_output_fields, "solutionTransition should be removed"
+    assert "Cp" in surface_output_fields, "Cp should remain"
+    assert "Cf" in surface_output_fields, "Cf should remain"
+
+    slice_output_fields = params_new["outputs"][2]["output_fields"]["items"]
+    assert (
+        "linearResidualTransition" not in slice_output_fields
+    ), "linearResidualTransition should be removed"
+    assert "vorticity" in slice_output_fields, "vorticity should remain"
+
+    probe_output_fields = params_new["outputs"][3]["output_fields"]["items"]
+    assert (
+        "residualTransition" not in probe_output_fields
+    ), "residualTransition should be removed from ProbeOutput"
+    assert "primitiveVars" in probe_output_fields, "primitiveVars should remain"
+
+    # Test 3: Verify version was updated
+    assert params_new["version"] == "25.7.7"
+
+
+def test_updater_to_25_7_7_unsteady_no_frequency_change():
+    """Test that frequency settings are NOT changed for unsteady simulations"""
+
+    params_as_dict = {
+        "version": "25.7.6",
+        "time_stepping": {
+            "type_name": "Unsteady",
+            "max_steps": 1000,
+        },
+        "models": [
+            {
+                "type": "Fluid",
+                "transition_model_solver": {
+                    "type_name": "None",
+                },
+            }
+        ],
+        "outputs": [
+            {
+                "output_type": "VolumeOutput",
+                "name": "Volume output",
+                "frequency": 10,
+                "frequency_offset": 5,
+                "output_format": "paraview",
+                "output_fields": {"items": ["primitiveVars", "Mach"]},
+            },
+        ],
+    }
+
+    params_new = updater(
+        version_from="25.7.6",
+        version_to="25.7.7",
+        params_as_dict=params_as_dict,
+    )
+
+    assert params_new["outputs"][0]["frequency"] == 10, "Unsteady frequency should not be changed"
+    assert (
+        params_new["outputs"][0]["frequency_offset"] == 5
+    ), "Unsteady frequency_offset should not be changed"
+
+
+def test_updater_to_25_7_7_with_transition_model():
+    """Test that transition output fields are NOT removed when transition model is enabled"""
+
+    params_as_dict = {
+        "version": "25.7.6",
+        "time_stepping": {
+            "type_name": "Steady",
+            "max_steps": 1000,
+        },
+        "models": [
+            {
+                "type": "Fluid",
+                "transition_model_solver": {
+                    "type_name": "AmplificationFactorTransport",
+                },
+            }
+        ],
+        "outputs": [
+            {
+                "output_type": "VolumeOutput",
+                "name": "Volume output",
+                "frequency": 10,
+                "frequency_offset": 5,
+                "output_format": "paraview",
+                "output_fields": {
+                    "items": [
+                        "primitiveVars",
+                        "residualTransition",
+                        "solutionTransition",
+                    ]
+                },
+            },
+        ],
+    }
+
+    params_new = updater(
+        version_from="25.7.6",
+        version_to="25.7.7",
+        params_as_dict=params_as_dict,
+    )
+
+    # Frequency settings should still be reset for steady simulation
+    assert params_new["outputs"][0]["frequency"] == -1
+    assert params_new["outputs"][0]["frequency_offset"] == 0
+
+    # Transition output fields should NOT be removed when transition model is enabled
+    volume_output_fields = params_new["outputs"][0]["output_fields"]["items"]
+    assert (
+        "residualTransition" in volume_output_fields
+    ), "residualTransition should remain with AmplificationFactorTransport"
+    assert (
+        "solutionTransition" in volume_output_fields
+    ), "solutionTransition should remain with AmplificationFactorTransport"
+    assert "primitiveVars" in volume_output_fields, "primitiveVars should remain"