[SCFD-2695] Reworked the manipulate restart mechanism (#575)

* Reworked the manipulate restart mechanisim

* Fix format

flow360/component/simulation/models/volume_models.py

@@ -85,7 +85,7 @@ class ExpressionInitialConditionBase(Flow360BaseModel):
     :paramref:`Fluid.initial_condition`.
     """
 
-    type: Literal["expression"] = pd.Field("expression", frozen=True)
+    type_name: Literal["expression"] = pd.Field("expression", frozen=True)
     constants: Optional[Dict[str, StringExpression]] = pd.Field(
         None, description="The expression for the initial condition."
     )
@@ -96,21 +96,29 @@ class NavierStokesInitialCondition(ExpressionInitialConditionBase):
     """
     :class:`NavierStokesInitialCondition` class for specifying the
     :paramref:`Fluid.initial_condition`.
-
+    By default
     """
 
-    rho: StringExpression = pd.Field(description="Density")
-    u: StringExpression = pd.Field(description="X-direction velocity")
-    v: StringExpression = pd.Field(description="Y-direction velocity")
-    w: StringExpression = pd.Field(description="Z-direction velocity")
-    p: StringExpression = pd.Field(description="Pressure")
+    type_name: Literal["NavierStokesInitialCondition"] = pd.Field(
+        "NavierStokesInitialCondition", frozen=True
+    )
+    rho: StringExpression = pd.Field("rho", description="Density")
+    u: StringExpression = pd.Field("u", description="X-direction velocity")
+    v: StringExpression = pd.Field("v", description="Y-direction velocity")
+    w: StringExpression = pd.Field("w", description="Z-direction velocity")
+    p: StringExpression = pd.Field("p", description="Pressure")
 
 
 class NavierStokesModifiedRestartSolution(NavierStokesInitialCondition):
-    type: Literal["restartManipulation"] = pd.Field("restartManipulation", frozen=True)
+    type_name: Literal["NavierStokesModifiedRestartSolution"] = pd.Field(
+        "NavierStokesModifiedRestartSolution", frozen=True
+    )
 
 
 class HeatEquationInitialCondition(ExpressionInitialConditionBase):
+    type_name: Literal["HeatEquationInitialCondition"] = pd.Field(
+        "HeatEquationInitialCondition", frozen=True
+    )
     temperature: StringExpression = pd.Field()
 
 
@@ -149,10 +157,12 @@ class Fluid(PDEModelBase):
 
     material: FluidMaterialTypes = pd.Field(Air(), description="The material propetry of fluid.")
 
-    initial_condition: Optional[
-        Union[NavierStokesModifiedRestartSolution, NavierStokesInitialCondition]
-    ] = pd.Field(
-        None, discriminator="type", description="The initial condition of the fluid solver."
+    initial_condition: Union[NavierStokesModifiedRestartSolution, NavierStokesInitialCondition] = (
+        pd.Field(
+            NavierStokesInitialCondition(),
+            discriminator="type_name",
+            description="The initial condition of the fluid solver.",
+        )
     )
 
     # pylint: disable=fixme

flow360/component/simulation/translator/solver_translator.py

@@ -27,6 +27,8 @@
     ActuatorDisk,
     BETDisk,
     Fluid,
+    NavierStokesInitialCondition,
+    NavierStokesModifiedRestartSolution,
     PorousMedium,
     Rotation,
     Solid,
@@ -65,6 +67,7 @@
     update_dict_recursively,
 )
 from flow360.component.simulation.unit_system import LengthType
+from flow360.component.simulation.utils import is_exact_instance
 from flow360.exceptions import Flow360TranslationError
 
 
@@ -771,6 +774,32 @@ def boundary_spec_translator(model: SurfaceModelTypes, op_acousitc_to_static_pre
     return boundary
 
 
+def get_navier_stokes_initial_condition(
+    initial_condition: Union[NavierStokesInitialCondition, NavierStokesModifiedRestartSolution]
+):
+    """Translate the initial condition for NavierStokes"""
+    if is_exact_instance(initial_condition, NavierStokesInitialCondition):
+        initial_condition_dict = {
+            "type": "initialCondition",
+        }
+    elif is_exact_instance(initial_condition, NavierStokesModifiedRestartSolution):
+        initial_condition_dict = {
+            "type": "restartManipulation",
+        }
+    else:
+        raise Flow360TranslationError(
+            f"Invalid NavierStokes initial condition type: {type(initial_condition)}",
+            input_value=initial_condition,
+            location=["models"],
+        )
+    raw_dict = dump_dict(initial_condition)
+    for key in ["rho", "u", "v", "w", "p", "constants"]:
+        if key not in raw_dict:  # not set
+            continue
+        initial_condition_dict[key] = raw_dict[key]
+    return initial_condition_dict
+
+
 # pylint: disable=too-many-statements
 # pylint: disable=too-many-branches
 # pylint: disable=too-many-locals
@@ -923,8 +952,9 @@ def get_solver_json(
                             }
                         )
 
-            if model.initial_condition:
-                translated["initialCondition"] = dump_dict(model.initial_condition)
+            translated["initialCondition"] = get_navier_stokes_initial_condition(
+                model.initial_condition
+            )
 
     ##:: Step 7: Get BET and AD lists
     if has_instance_in_list(input_params.models, BETDisk):

flow360/component/simulation/validation/validation_simulation_params.py

@@ -6,12 +6,7 @@
 
 from flow360.component.simulation.models.solver_numerics import NoneSolver
 from flow360.component.simulation.models.surface_models import SurfaceModelTypes, Wall
-from flow360.component.simulation.models.volume_models import (
-    Fluid,
-    NavierStokesInitialCondition,
-    Rotation,
-    Solid,
-)
+from flow360.component.simulation.models.volume_models import Fluid, Rotation, Solid
 from flow360.component.simulation.outputs.outputs import (
     IsosurfaceOutput,
     ProbeOutput,
@@ -260,18 +255,6 @@ def _validate_cht_has_heat_transfer(params):
                         "In `Solid` model, the initial condition needs to be specified "
                         "for unsteady simulations."
                     )
-
-    for model in params.models:
-        if isinstance(model, Fluid) and isinstance(
-            model.initial_condition, NavierStokesInitialCondition
-        ):
-            for model_solid in params.models:
-                if isinstance(model_solid, Solid) and model_solid.initial_condition is None:
-                    raise ValueError(
-                        "In `Solid` model, the initial condition needs to be specified "
-                        "when the `Fluid` model uses expression as initial condition."
-                    )
-
     return params
 
 

tests/ref/simulation/service_init_geometry.json

@@ -138,6 +138,14 @@
       }
     },
     "type": "Fluid",
+    "initial_condition": {
+      "type_name": "NavierStokesInitialCondition",
+      "rho": "rho",
+      "u": "u",
+      "v": "v",
+      "w": "w",
+      "p": "p"
+    },
     "navier_stokes_solver": {
       "absolute_tolerance": 1e-10,
       "relative_tolerance": 0.0,

tests/ref/simulation/service_init_volume_mesh.json

@@ -73,15 +73,15 @@
         {
             "type": "Wall",
             "entities": {
-              "stored_entities": []
+                "stored_entities": []
             },
             "name": "Wall",
             "use_wall_function": false
         },
         {
             "type": "Freestream",
             "entities": {
-              "stored_entities": []
+                "stored_entities": []
             },
             "name": "Freestream"
         },
@@ -104,6 +104,14 @@
                     }
                 }
             },
+            "initial_condition": {
+                "type_name": "NavierStokesInitialCondition",
+                "rho": "rho",
+                "u": "u",
+                "v": "v",
+                "w": "w",
+                "p": "p"
+            },
             "type": "Fluid",
             "navier_stokes_solver": {
                 "absolute_tolerance": 1e-10,
@@ -156,7 +164,7 @@
                 "rotation_correction": false
             },
             "transition_model_solver": {
-              "type_name": "None"
+                "type_name": "None"
             }
         }
     ],
@@ -193,8 +201,7 @@
                         "private_attribute_registry_bucket_name": "SurfaceEntityType",
                         "private_attribute_entity_type_name": "Surface",
                         "name": "*",
-                        "private_attribute_sub_components": [
-                        ]
+                        "private_attribute_sub_components": []
                     }
                 ]
             },
@@ -208,4 +215,4 @@
             "units": "m"
         }
     }
-}
+}

tests/simulation/params/test_validators_params.py

@@ -314,17 +314,6 @@ def test_cht_solver_settings_validator(
             outputs=[surface_output_with_residual_heat_solver],
         )
 
-    message = "In `Solid` model, the initial condition needs to be specified "
-    "when the `Fluid` model uses expression as initial condition."
-
-    # Invalid simulation params
-    with SI_unit_system, pytest.raises(ValueError, match=re.escape(message)):
-        _ = SimulationParams(
-            models=[fluid_model_with_initial_condition, solid_model_without_initial_condition],
-            time_stepping=Steady(),
-            outputs=[surface_output_with_residual_heat_solver],
-        )
-
 
 def test_transition_model_solver_settings_validator():
     transition_model_solver = TransitionModelSolver()

tests/simulation/translator/ref/Flow360_CHT_three_cylinders.json

@@ -170,5 +170,13 @@
             "thermalConductivity": 0.0239367,
             "volumetricHeatSource": 0.001
         }
+    },
+    "initialCondition": {
+        "p": "p",
+        "rho": "rho",
+        "type": "initialCondition",
+        "u": "u",
+        "v": "v",
+        "w": "w"
     }
 }

tests/simulation/translator/ref/Flow360_NestedCylindersSRF.json

@@ -116,5 +116,13 @@
         "animationFrequencyTimeAverage": -1,
         "animationFrequencyTimeAverageOffset": 0,
         "startAverageIntegrationStep": -1
+    },
+    "initialCondition": {
+        "p": "p",
+        "rho": "rho",
+        "type": "initialCondition",
+        "u": "u",
+        "v": "v",
+        "w": "w"
     }
 }

tests/simulation/translator/ref/Flow360_TurbFlatPlate137x97_BoxTrip.json

@@ -169,5 +169,13 @@
         ],
         "outputFormat": "paraview",
         "startAverageIntegrationStep": -1
+    },
+    "initialCondition": {
+        "p": "p",
+        "rho": "rho",
+        "type": "initialCondition",
+        "u": "u",
+        "v": "v",
+        "w": "w"
     }
 }

tests/simulation/translator/ref/Flow360_XV15HoverMRF.json

@@ -130,5 +130,13 @@
         "animationFrequencyTimeAverage": -1,
         "animationFrequencyTimeAverageOffset": 0,
         "startAverageIntegrationStep": -1
+    },
+    "initialCondition": {
+        "p": "p",
+        "rho": "rho",
+        "type": "initialCondition",
+        "u": "u",
+        "v": "v",
+        "w": "w"
     }
 }

tests/simulation/translator/ref/Flow360_actuator_disk.json

@@ -85,5 +85,13 @@
                 "circumferential":[-0.0001, -0.003, 0]
             }
         }
-    ]
+    ],
+    "initialCondition": {
+        "p": "p",
+        "rho": "rho",
+        "type": "initialCondition",
+        "u": "u",
+        "v": "v",
+        "w": "w"
+    }
 }

tests/simulation/translator/ref/Flow360_heatFluxCylinder.json

@@ -110,5 +110,13 @@
         "animationFrequencyTimeAverage": -1,
         "animationFrequencyTimeAverageOffset": 0,
         "startAverageIntegrationStep": -1
+    },
+    "initialCondition": {
+        "p": "p",
+        "rho": "rho",
+        "type": "initialCondition",
+        "u": "u",
+        "v": "v",
+        "w": "w"
     }
 }