[FXC-4006][FXC-4053][25.7] Add validation for transition model output fields and output frequency settings (#1587)

* Add validation for transition model solver

* Add validation for output frequency settings

* Add updater for two new validations

* bump version to 25.7.7

---------

Co-authored-by: Ben <106089368+benflexcompute@users.noreply.github.com>

Author: 2 people

flow360/component/simulation/framework/updater.py

@@ -373,6 +373,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),
@@ -386,7 +448,12 @@ def _to_25_7_6(params_as_dict):
     (Flow360Version("25.6.5"), _to_25_6_5),
     (Flow360Version("25.6.6"), _to_25_6_6),
     (Flow360Version("25.7.2"), _to_25_7_2),
+<<<<<<< HEAD
     (Flow360Version("25.8.0b4"), _to_25_7_6),
+=======
+    (Flow360Version("25.7.6"), _to_25_7_6),
+    (Flow360Version("25.7.7"), _to_25_7_7),
+>>>>>>> 72c81eec ([FXC-4006][FXC-4053][25.7] Add validation for transition model output fields and output frequency settings (#1587))
 ]  # A list of the Python API version tuple with there corresponding updaters.
 
 

flow360/component/simulation/outputs/outputs.py

@@ -245,6 +245,20 @@ class _AnimationSettings(_OutputBase):
         + " 0 is at beginning of simulation.",
     )
 
+    @pd.field_validator("frequency", "frequency_offset", mode="after")
+    @classmethod
+    def disable_frequency_settings_in_steady_simulation(cls, value, info: pd.ValidationInfo):
+        """Disable frequency settings in a steady simulation"""
+        validation_info = get_validation_info()
+        if validation_info is None or validation_info.time_stepping != TimeSteppingType.STEADY:
+            return value
+        # pylint: disable=unsubscriptable-object
+        if value != cls.model_fields[info.field_name].default:
+            raise ValueError(
+                f"Output {info.field_name} cannot be specified in a steady simulation."
+            )
+        return value
+
 
 class _AnimationAndFileFormatSettings(_AnimationSettings):
     """

flow360/component/simulation/simulation_params.py

@@ -86,6 +86,7 @@
 from flow360.component.simulation.validation.validation_output import (
     _check_aero_acoustics_observer_time_step_size,
     _check_output_fields,
+    _check_output_fields_valid_given_transition_model,
     _check_output_fields_valid_given_turbulence_model,
     _check_unique_surface_volume_probe_entity_names,
     _check_unique_surface_volume_probe_names,
@@ -559,6 +560,11 @@ def check_output_fields_valid_given_turbulence_model(params):
         """Check output fields are valid given the turbulence model"""
         return _check_output_fields_valid_given_turbulence_model(params)
 
+    @pd.model_validator(mode="after")
+    def check_output_fields_valid_given_transition_model(params):
+        """Check output fields are valid given the transition model"""
+        return _check_output_fields_valid_given_transition_model(params)
+
     @pd.model_validator(mode="after")
     def check_and_add_rotating_reference_frame_model_flag_in_volumezones(params):
         """Ensure that all volume zones have the rotating_reference_frame_model flag with correct values"""

flow360/component/simulation/validation/validation_output.py

@@ -133,6 +133,39 @@ def _check_output_fields_valid_given_turbulence_model(params):
     return params
 
 
+def _check_output_fields_valid_given_transition_model(params):
+    """Ensure that the output fields are consistent with the transition model used."""
+
+    if not params.models or not params.outputs:
+        return params
+
+    transition_model = "None"
+    for model in params.models:
+        if isinstance(model, Fluid):
+            transition_model = model.transition_model_solver.type_name
+            break
+
+    if transition_model != "None":
+        return params
+
+    transition_output_fields = [
+        "residualTransition",
+        "solutionTransition",
+        "linearResidualTransition",
+    ]
+
+    for output_index, output in enumerate(params.outputs):
+        if output.output_type in ("AeroAcousticOutput", "StreamlineOutput"):
+            continue
+        for item in output.output_fields.items:
+            if isinstance(item, str) and item in transition_output_fields:
+                raise ValueError(
+                    f"In `outputs`[{output_index}] {output.output_type}:, {item} is not a valid"
+                    f" output field when transition model is not used."
+                )
+    return params
+
+
 def _check_unsteadiness_to_use_aero_acoustics(params):
 
     if not params.outputs:

flow360/version.py

@@ -2,5 +2,10 @@
 version
 """
 
+<<<<<<< HEAD
 __version__ = "25.8.0b4"
 __solver_version__ = "release-25.8"
+=======
+__version__ = "25.7.7"
+__solver_version__ = "release-25.7"
+>>>>>>> 72c81eec ([FXC-4006][FXC-4053][25.7] Add validation for transition model output fields and output frequency settings (#1587))

pyproject.toml

@@ -1,6 +1,10 @@
 [tool.poetry]
 name = "flow360"
+<<<<<<< HEAD
 version = "v25.8.0b4"
+=======
+version = "v25.7.7"
+>>>>>>> 72c81eec ([FXC-4006][FXC-4053][25.7] Add validation for transition model output fields and output frequency settings (#1587))
 description = "Flow360 Python Client"
 authors = ["Flexcompute <support@flexcompute.com>"]
 

tests/ref/simulation/service_init_geometry.json

@@ -1,5 +1,9 @@
 {
+<<<<<<< HEAD
     "version": "25.8.0b4",
+=======
+    "version": "25.7.7",
+>>>>>>> 72c81eec ([FXC-4006][FXC-4053][25.7] Add validation for transition model output fields and output frequency settings (#1587))
     "unit_system": {
         "name": "SI"
     },

tests/ref/simulation/service_init_surface_mesh.json

@@ -1,5 +1,9 @@
 {
+<<<<<<< HEAD
     "version": "25.8.0b4",
+=======
+    "version": "25.7.7",
+>>>>>>> 72c81eec ([FXC-4006][FXC-4053][25.7] Add validation for transition model output fields and output frequency settings (#1587))
     "unit_system": {
         "name": "SI"
     },

tests/ref/simulation/service_init_volume_mesh.json

@@ -1,5 +1,9 @@
 {
+<<<<<<< HEAD
     "version": "25.8.0b4",
+=======
+    "version": "25.7.7",
+>>>>>>> 72c81eec ([FXC-4006][FXC-4053][25.7] Add validation for transition model output fields and output frequency settings (#1587))
     "unit_system": {
         "name": "SI"
     },

tests/simulation/converter/ref/ref_monitor.json

@@ -1,5 +1,9 @@
 {
+<<<<<<< HEAD
     "version": "25.8.0b4",
+=======
+    "version": "25.7.7",
+>>>>>>> 72c81eec ([FXC-4006][FXC-4053][25.7] Add validation for transition model output fields and output frequency settings (#1587))
     "unit_system": {
         "name": "SI"
     },