Add private attr dictionary for solver (#630)

* Add private attr dictionary

* Address comments

Author: angranl-flex

flow360/component/simulation/models/solver_numerics.py

@@ -10,7 +10,7 @@
 from __future__ import annotations
 
 from abc import ABCMeta
-from typing import Annotated, Literal, Optional, Union
+from typing import Annotated, Dict, Literal, Optional, Union
 
 import numpy as np
 import pydantic as pd
@@ -23,7 +23,6 @@
 )
 from flow360.component.simulation.framework.entity_base import EntityList
 from flow360.component.simulation.primitives import Box
-from flow360.component.types import Coordinate
 
 # from .time_stepping import UnsteadyTimeStepping
 
@@ -78,6 +77,7 @@ class GenericSolverSettings(Flow360BaseModel, metaclass=ABCMeta):
         1, description="Frequency at which to solve the equation."
     )
     linear_solver: LinearSolver = pd.Field(LinearSolver())
+    private_attribute_dict: Optional[Dict] = pd.Field(None)
 
 
 class NavierStokesSolver(GenericSolverSettings):
@@ -144,26 +144,6 @@ class NavierStokesSolver(GenericSolverSettings):
         + "updated every pseudo step.",
     )
 
-    private_attribute_debug_type: Optional[
-        Literal[
-            "minDensity",
-            "minPressure",
-            "maxVelocity",
-            "maxResCont",
-            "maxResMomX",
-            "maxResMomY",
-            "maxResMomZ",
-            "maxResEnergy",
-        ]
-    ] = pd.Field(None)
-    private_attribute_debug_point: Optional[Coordinate] = pd.Field(None)
-
-    model_config = pd.ConfigDict(
-        conflicting_fields=[
-            Conflicts(field1="private_attribute_debug_type", field2="private_attribute_debug_point")
-        ]
-    )
-
 
 class SpalartAllmarasModelConstants(Flow360BaseModel):
     """

flow360/component/simulation/translator/solver_translator.py

@@ -73,7 +73,11 @@
 
 def dump_dict(input_params):
     """Dumping param/model to dictionary."""
-    return input_params.model_dump(by_alias=True, exclude_none=True)
+
+    result = input_params.model_dump(by_alias=True, exclude_none=True)
+    if result.pop("privateAttributeDict", None) is not None:
+        result.update(input_params.private_attribute_dict)
+    return result
 
 
 def init_non_average_output(
@@ -899,16 +903,6 @@ def get_solver_json(
                         input_params.operating_condition.mach
                     )
             translated["navierStokesSolver"] = dump_dict(model.navier_stokes_solver)
-            if model.navier_stokes_solver.private_attribute_debug_type is not None:
-                replace_dict_key(
-                    translated["navierStokesSolver"], "privateAttributeDebugType", "debugType"
-                )
-            if model.navier_stokes_solver.private_attribute_debug_point is not None:
-                replace_dict_key(
-                    translated["navierStokesSolver"], "privateAttributeDebugPoint", "debugPoint"
-                )
-                dp = translated["navierStokesSolver"]["debugPoint"]
-                translated["navierStokesSolver"]["debugPoint"] = list(dp)
             replace_dict_key(translated["navierStokesSolver"], "typeName", "modelType")
             replace_dict_key(
                 translated["navierStokesSolver"],

tests/simulation/translator/test_solver_translator.py

@@ -196,15 +196,14 @@ def test_om6wing_tutorial(get_om6Wing_tutorial_param):
 
 def test_om6wing_debug(get_om6Wing_tutorial_param):
     params = get_om6Wing_tutorial_param
-    params.models[0].navier_stokes_solver.private_attribute_debug_type = "minDensity"
+    params.models[0].navier_stokes_solver.private_attribute_dict = {"debugType": "minDensity"}
     translate_and_compare(
         get_om6Wing_tutorial_param,
         mesh_unit=0.8059 * u.m,
         ref_json_file="Flow360_om6Wing_debug_type.json",
     )
 
-    params.models[0].navier_stokes_solver.private_attribute_debug_type = None
-    params.models[0].navier_stokes_solver.private_attribute_debug_point = (1.0, 2.0, 3.0)
+    params.models[0].navier_stokes_solver.private_attribute_dict = {"debugPoint": [1.0, 2.0, 3.0]}
     translate_and_compare(
         get_om6Wing_tutorial_param,
         mesh_unit=0.8059 * u.m,