Merge branch 'develop' into release-23.3.2

Author: awkrupka

flow360/__init__.py

@@ -31,6 +31,7 @@
     SubsonicOutflowPressure,
     WallFunction,
 )
+from .component.flow360_params.flow360_output import Slice, Slices
 from .component.flow360_params.flow360_params import (
     ActuatorDisk,
     AeroacousticOutput,
@@ -57,7 +58,6 @@
     PorousMedium,
     ProbeMonitor,
     SliceOutput,
-    Slices,
     SlidingInterface,
     SpalartAllmaras,
     SurfaceIntegralMonitor,
@@ -73,6 +73,7 @@
 )
 from .component.flow360_params.solvers import (
     IncompressibleNavierStokesSolver,
+    LinearSolver,
     NavierStokesSolver,
 )
 from .component.flow360_params.time_stepping import (

flow360/component/flow360_params/boundaries.py

@@ -1,7 +1,6 @@
 """
 Boundaries parameters
 """
-import os
 from abc import ABCMeta
 from typing import Literal, Optional, Tuple, Union
 

flow360/component/flow360_params/flow360_output.py

@@ -3,7 +3,6 @@
 """
 from __future__ import annotations
 
-import os
 from abc import ABCMeta
 from typing import List, Literal, Optional, Union, get_args
 

flow360/component/flow360_params/flow360_params.py

@@ -5,6 +5,7 @@
 # pylint: disable=unused-import
 from __future__ import annotations
 
+import json
 import math
 import os
 from abc import ABCMeta, abstractmethod
@@ -66,7 +67,6 @@
     ProbeMonitor,
     SliceOutput,
     SliceOutputLegacy,
-    Slices,
     SurfaceIntegralMonitor,
     SurfaceOutput,
     SurfaceOutputLegacy,
@@ -485,7 +485,7 @@ class Geometry(Flow360BaseModel):
     :class: Geometry component
     """
 
-    ref_area: Optional[AreaType.Positive] = pd.Field(alias="refArea")
+    ref_area: Optional[AreaType.Positive] = pd.Field(alias="refArea", displayed="Reference area")
     moment_center: Optional[LengthType.Point] = pd.Field(alias="momentCenter")
     moment_length: Optional[LengthType.Moment] = pd.Field(alias="momentLength")
     mesh_unit: Optional[LengthType] = pd.Field(alias="meshUnit")
@@ -508,8 +508,8 @@ class FreestreamBase(Flow360BaseModel, metaclass=ABCMeta):
     """
 
     model_type: str
-    alpha: Optional[float] = pd.Field(alias="alphaAngle", default=0)
-    beta: Optional[float] = pd.Field(alias="betaAngle", default=0)
+    alpha: Optional[float] = pd.Field(alias="alphaAngle", default=0, displayed="Alpha angle [deg]")
+    beta: Optional[float] = pd.Field(alias="betaAngle", default=0, displayed="Beta angle [deg]")
     turbulent_viscosity_ratio: Optional[NonNegativeFloat] = pd.Field(
         alias="turbulentViscosityRatio"
     )
@@ -532,10 +532,10 @@ class FreestreamFromMach(FreestreamBase):
     """
 
     model_type: Literal["FromMach"] = pd.Field("FromMach", alias="modelType", const=True)
-    Mach: PositiveFloat = pd.Field()
-    Mach_ref: Optional[PositiveFloat] = pd.Field(alias="MachRef")
-    mu_ref: PositiveFloat = pd.Field(alias="muRef")
-    temperature: PositiveFloat = pd.Field(alias="Temperature")
+    Mach: PositiveFloat = pd.Field(displayed="Mach number")
+    Mach_ref: Optional[PositiveFloat] = pd.Field(alias="MachRef", displayed="Reference Mach number")
+    mu_ref: PositiveFloat = pd.Field(alias="muRef", displayed="Dynamic viscosity [non-dim]")
+    temperature: PositiveFloat = pd.Field(alias="Temperature", displayed="Temperature [K]")
 
     # pylint: disable=arguments-differ, unused-argument
     def to_solver(self, params: Flow360Params, **kwargs) -> FreestreamFromMach:
@@ -553,10 +553,10 @@ class FreestreamFromMachReynolds(FreestreamBase):
     model_type: Literal["FromMachReynolds"] = pd.Field(
         "FromMachReynolds", alias="modelType", const=True
     )
-    Mach: PositiveFloat = pd.Field()
-    Mach_ref: Optional[PositiveFloat] = pd.Field(alias="MachRef")
-    Reynolds: PositiveFloat = pd.Field()
-    temperature: PositiveFloat = pd.Field(alias="Temperature")
+    Mach: PositiveFloat = pd.Field(displayed="Mach number")
+    Mach_ref: Optional[PositiveFloat] = pd.Field(alias="MachRef", displayed="Reference Mach number")
+    Reynolds: PositiveFloat = pd.Field(displayed="Reynolds number")
+    temperature: PositiveFloat = pd.Field(alias="Temperature", displayed="Temperature [K]")
 
     # pylint: disable=arguments-differ, unused-argument
     def to_solver(self, params: Flow360Params, **kwargs) -> FreestreamFromMach:
@@ -572,10 +572,10 @@ class ZeroFreestream(FreestreamBase):
     """
 
     model_type: Literal["ZeroMach"] = pd.Field("ZeroMach", alias="modelType", const=True)
-    Mach: Literal[0] = pd.Field(0, const=True)
-    Mach_ref: pd.confloat(gt=1.0e-12) = pd.Field(alias="MachRef")
-    mu_ref: PositiveFloat = pd.Field(alias="muRef")
-    temperature: PositiveFloat = pd.Field(alias="Temperature")
+    Mach: Literal[0] = pd.Field(0, const=True, displayed="Mach number")
+    Mach_ref: pd.confloat(gt=1.0e-12) = pd.Field(alias="MachRef", displayed="Reference Mach number")
+    mu_ref: PositiveFloat = pd.Field(alias="muRef", displayed="Dynamic viscosity [non-dim]")
+    temperature: PositiveFloat = pd.Field(alias="Temperature", displayed="Temperature [K]")
 
     # pylint: disable=arguments-differ, unused-argument
     def to_solver(self, params: Flow360Params, **kwargs) -> ZeroFreestream:
@@ -592,7 +592,9 @@ class FreestreamFromVelocity(FreestreamBase):
 
     model_type: Literal["FromVelocity"] = pd.Field("FromVelocity", alias="modelType", const=True)
     velocity: VelocityType.Positive = pd.Field()
-    velocity_ref: Optional[VelocityType.Positive] = pd.Field(alias="velocityRef")
+    velocity_ref: Optional[VelocityType.Positive] = pd.Field(
+        alias="velocityRef", displayed="Reference velocity"
+    )
 
     # pylint: disable=arguments-differ
     def to_solver(self, params: Flow360Params, **kwargs) -> FreestreamFromMach:
@@ -637,7 +639,9 @@ class ZeroFreestreamFromVelocity(FreestreamBase):
 
     model_type: Literal["ZeroVelocity"] = pd.Field("ZeroVelocity", alias="modelType", const=True)
     velocity: Literal[0] = pd.Field(0, const=True)
-    velocity_ref: VelocityType.Positive = pd.Field(alias="velocityRef")
+    velocity_ref: VelocityType.Positive = pd.Field(
+        alias="velocityRef", displayed="Reference velocity"
+    )
 
     # pylint: disable=arguments-differ
     def to_solver(self, params: Flow360Params, **kwargs) -> ZeroFreestream:
@@ -721,7 +725,7 @@ class AirPressureTemperature(Flow360BaseModel):
 
     """
 
-    model_type: str = pd.Field("AirPressure", alias="modelType", const=True)
+    model_type: Literal["AirPressure"] = pd.Field("AirPressure", alias="modelType", const=True)
     pressure: PressureType = pd.Field()
     temperature: TemperatureType = pd.Field()
 
@@ -754,7 +758,7 @@ class AirDensityTemperature(Flow360BaseModel):
 
     """
 
-    model_type: str = pd.Field("AirDensity", alias="modelType", const=True)
+    model_type: Literal["AirDensity"] = pd.Field("AirDensity", alias="modelType", const=True)
     temperature: TemperatureType = pd.Field()
     density: DensityType = pd.Field()
 
@@ -949,7 +953,9 @@ class Flow360Params(Flow360BaseModel):
     version: str = pd.Field(__version__, mutable=False)
 
     geometry: Optional[Geometry] = pd.Field()
-    fluid_properties: Optional[FluidPropertyTypes] = pd.Field(alias="fluidProperties")
+    fluid_properties: Optional[FluidPropertyTypes] = pd.Field(
+        alias="fluidProperties", discriminator="model_type"
+    )
     boundaries: Boundaries = pd.Field()
     initial_condition: Optional[InitialConditions] = pd.Field(
         alias="initialCondition", discriminator="type"
@@ -1065,7 +1071,7 @@ def to_solver(self) -> Flow360Params:
                 return super().to_solver(self, exclude=["fluid_properties"])
         return super().to_solver(self, exclude=["fluid_properties"])
 
-    def to_flow360_json(self) -> dict:
+    def to_flow360_json(self) -> str:
         """Generate a JSON representation of the model, as required by Flow360
 
         Returns
@@ -1083,6 +1089,22 @@ def to_flow360_json(self) -> dict:
         solver_params_json = solver_params.json(encoder=flow360_json_encoder)
         return solver_params_json
 
+    def to_flow360_dict(self) -> dict:
+        """Generate a dict representation of the model, as required by Flow360
+
+        Returns
+        -------
+        dict
+            Returns dict representation of the model.
+
+        Example
+        -------
+        >>> params.to_flow360_dict() # doctest: +SKIP
+        """
+
+        flow360_dict = json.loads(self.to_flow360_json())
+        return flow360_dict
+
     def append(self, params: Flow360Params, overwrite: bool = False):
         if not isinstance(params, Flow360Params):
             raise ValueError("params must be type of Flow360Params")

flow360/component/flow360_params/initial_condition.py

@@ -27,11 +27,11 @@ class ExpressionInitialCondition(InitialCondition):
     """:class:`ExpressionInitialCondition` class"""
 
     type: Literal["expression"] = pd.Field("expression", const=True)
-    rho: str = pd.Field()
-    u: str = pd.Field()
-    v: str = pd.Field()
-    w: str = pd.Field()
-    p: str = pd.Field()
+    rho: str = pd.Field(displayed="rho [non-dim]")
+    u: str = pd.Field(displayed="u [non-dim]")
+    v: str = pd.Field(displayed="v [non-dim]")
+    w: str = pd.Field(displayed="w [non-dim]")
+    p: str = pd.Field(displayed="p [non-dim]")
 
 
 InitialConditions = Union[FreestreamInitialCondition, ExpressionInitialCondition]

flow360/component/flow360_params/solvers.py

@@ -121,9 +121,6 @@ class NavierStokesSolver(GenericFlowSolverSettings):
         order upwind scheme and is the most stable. A value of 0.33 leads to a blended upwind/central scheme and is
         recommended for low subsonic flows leading to reduced dissipation
 
-    linear_iterations :
-        Number of linear solver iterations
-
     update_jacobian_frequency :
         Frequency at which the jacobian is updated.
 
@@ -146,6 +143,9 @@ class NavierStokesSolver(GenericFlowSolverSettings):
         A factor in the range [0.01, 1.0] which exponentially reduces the dissipation of the numerical flux.
         The recommended starting value for most low-dissipation runs is 0.2
 
+    linear_solver:
+        Linear solver settings
+
     Returns
     -------
     :class:`NavierStokesSolver`
@@ -159,7 +159,6 @@ class NavierStokesSolver(GenericFlowSolverSettings):
     CFL_multiplier: Optional[PositiveFloat] = pd.Field(
         1.0, alias="CFLMultiplier", displayed="CFL Multiplier"
     )
-    linear_iterations: Optional[PositiveInt] = pd.Field(alias="linearIterations")
     kappa_MUSCL: Optional[pd.confloat(ge=-1, le=1)] = pd.Field(
         -1, alias="kappaMUSCL", displayed="Kappa MUSCL"
     )
@@ -175,7 +174,7 @@ class NavierStokesSolver(GenericFlowSolverSettings):
         1, alias="numericalDissipationFactor"
     )
     linear_solver: Optional[LinearSolver] = pd.Field(
-        LinearSolver(max_iterations=30), alias="linearSolver"
+        LinearSolver(max_iterations=30), alias="linearSolver", displayed="Linear solver config"
     )
     limit_velocity: Optional[bool] = pd.Field(False, alias="limitVelocity")
     limit_pressure_density: Optional[bool] = pd.Field(False, alias="limitPressureDensity")
@@ -330,17 +329,22 @@ class TurbulenceModelSolver(GenericFlowSolverSettings, metaclass=ABCMeta):
     quadratic_constitutive_relation: Optional[bool] = pd.Field(
         False, alias="quadraticConstitutiveRelation"
     )
-    reconstruction_gradient_limiter: Optional[pd.confloat(ge=0, le=2)] = pd.Field(
-        1.0, alias="reconstructionGradientLimiter"
+    reconstruction_gradient_limiter: Optional[float] = pd.Field(
+        alias="reconstructionGradientLimiter"
+    )
+    model_constants: Optional[TurbulenceModelConstants] = pd.Field(
+        alias="modelConstants", discriminator="model_type"
     )
-    model_constants: Optional[TurbulenceModelConstants] = pd.Field(alias="modelConstants")
 
 
 class KOmegaSST(TurbulenceModelSolver):
     """:class:`KOmegaSST` class"""
 
     model_type: Literal["kOmegaSST"] = pd.Field("kOmegaSST", alias="modelType", const=True)
     model_constants: Optional[TurbulenceModelConstantsSST] = pd.Field(alias="modelConstants")
+    reconstruction_gradient_limiter: Optional[pd.confloat(ge=0, le=2)] = pd.Field(
+        1.0, alias="reconstructionGradientLimiter"
+    )
 
 
 class SpalartAllmaras(TurbulenceModelSolver):
@@ -351,6 +355,9 @@ class SpalartAllmaras(TurbulenceModelSolver):
     )
     rotation_correction: Optional[bool] = pd.Field(False, alias="rotationCorrection")
     model_constants: Optional[TurbulenceModelConstantsSA] = pd.Field(alias="modelConstants")
+    reconstruction_gradient_limiter: Optional[pd.confloat(ge=0, le=2)] = pd.Field(
+        0.5, alias="reconstructionGradientLimiter"
+    )
 
 
 class NoneSolver(Flow360BaseModel):
@@ -495,6 +502,7 @@ class NavierStokesSolverLegacy(NavierStokesSolver, LegacyModel):
     linear_solver: Optional[LinearSolverLegacy] = pd.Field(
         alias="linearSolver", default=LinearSolverLegacy()
     )
+    linear_iterations: Optional[PositiveInt] = pd.Field(alias="linearIterations")
 
     def update_model(self):
         model = {

tests/params/test_solvers.py

@@ -48,7 +48,6 @@ def test_navier_stokes():
         kappa_MUSCL=-1,
         relative_tolerance=0,
         CFL_multiplier=1,
-        linear_iterations=30,
         update_jacobian_frequency=4,
         equation_eval_frequency=1,
         max_force_jac_update_physical_steps=1,

tests/ref/case_params/params.json

@@ -42,9 +42,9 @@
         "timeStepSize": "inf"
     },
     "navierStokesSolver": {
+        "absoluteTolerance": 1.0e-10,
         "relativeTolerance": 0.0,
         "CFLMultiplier": 1.0,
-        "linearIterations": 10,
         "kappaMUSCL": -1.0,
         "updateJacobianFrequency": 4,
         "equationEvalFrequency": 1,
@@ -130,5 +130,5 @@
             }
         }
     },
-    "hash": "4aa5efab272a24cb4b2540c6f3ddb1357a4a405a2c8ebda6393ea3affb496b03"
+    "hash": "8f6a65d066ce8a92d34e973a7b357429d6cd6071b8ec27080bcbc3be2e810b84"
 }

tests/ref/case_params/params.yaml

@@ -28,14 +28,14 @@ geometry:
     refArea:
         units: m**2
         value: 1.15315084119231
-hash: 4aa5efab272a24cb4b2540c6f3ddb1357a4a405a2c8ebda6393ea3affb496b03
+hash: 8f6a65d066ce8a92d34e973a7b357429d6cd6071b8ec27080bcbc3be2e810b84
 navierStokesSolver:
     CFLMultiplier: 1.0
+    absoluteTolerance: 1.0e-10
     equationEvalFrequency: 1
     kappaMUSCL: -1.0
     limitPressureDensity: false
     limitVelocity: false
-    linearIterations: 10
     linearSolver:
         absoluteTolerance: 1.0e-10
         maxIterations: 30

tests/test_flow360_params.py

@@ -201,7 +201,7 @@ def test_update_from_multiple_files():
             geometry=fl.Geometry("data/case_params/geometry.yaml"),
             boundaries=fl.Boundaries("data/case_params/boundaries.yaml"),
             freestream=fl.FreestreamFromVelocity(velocity=286, alpha=3.06),
-            navier_stokes_solver=fl.NavierStokesSolver(linear_iterations=10),
+            navier_stokes_solver=fl.NavierStokesSolver(absolute_tolerance=1e-10),
         )
 
     outputs = fl.Flow360Params.construct("data/case_params/outputs.yaml")
@@ -221,7 +221,7 @@ def test_update_from_multiple_files_dont_overwrite():
             geometry=fl.Geometry("data/case_params/geometry.yaml"),
             boundaries=fl.Boundaries("data/case_params/boundaries.yaml"),
             freestream=fl.FreestreamFromVelocity(velocity=286, alpha=3.06),
-            navier_stokes_solver=fl.NavierStokesSolver(linear_iterations=10),
+            navier_stokes_solver=fl.NavierStokesSolver(absolute_tolerance=1e-10),
         )
 
     outputs = fl.Flow360Params.construct("data/case_params/outputs.yaml")
@@ -236,7 +236,7 @@ def test_update_from_multiple_files_overwrite():
             geometry=fl.Geometry("data/case_params/geometry.yaml"),
             boundaries=fl.Boundaries("data/case_params/boundaries.yaml"),
             freestream=fl.FreestreamFromVelocity(velocity=286, alpha=3.06),
-            navier_stokes_solver=fl.NavierStokesSolver(linear_iterations=10),
+            navier_stokes_solver=fl.NavierStokesSolver(absolute_tolerance=1e-10),
         )
 
     outputs = fl.Flow360Params.construct("data/case_params/outputs.yaml")