[Tracking] Simulation Interface

flow360/component/flow360_params/params_base.py

@@ -32,8 +32,6 @@
 from ..types import COMMENTS, TYPE_TAG_STR
 from .conversions import need_conversion, require, unit_converter
 
-SUPPORTED_SOLVER_VERSION = "release-23.3.2.0"
-
 
 def json_dumps(value, *args, **kwargs):
     """custom json dump with sort_keys=True"""

flow360/component/simulation/conversion.py

@@ -316,7 +316,7 @@ def get_base_thermal_conductivity():
     elif dimension == u.dimensions.angle:
 
         # pylint: disable=no-member
-        flow360_conversion_unit_system.base_angle = 1 * u.rad
+        flow360_conversion_unit_system.base_angle = 1
 
     elif dimension == u.dimensions.pressure:
         base_force = get_base_force()

flow360/component/simulation/framework/base_model.py

@@ -25,7 +25,7 @@
 from flow360.log import log
 
 
-def custom_to_camel(string: str) -> str:
+def snake_to_camel(string: str) -> str:
     """
     Convert a snake_case string to camelCase.
 
@@ -40,7 +40,7 @@ def custom_to_camel(string: str) -> str:
     str: The converted string in camelCase format.
 
     Example:
-    >>> custom_to_camel("example_snake_case")
+    >>> snake_to_camel("example_snake_case")
     'exampleSnakeCase'
     """
     components = string.split("_")
@@ -116,7 +116,7 @@ def __pydantic_init_subclass__(cls, **kwargs) -> None:
         include_hash=False,
         include_defaults_in_schema=True,
         alias_generator=pd.AliasGenerator(
-            serialization_alias=custom_to_camel,
+            serialization_alias=snake_to_camel,
         ),
     )
 

flow360/component/simulation/framework/entity_registry.py

@@ -112,19 +112,20 @@ def find_by_name(self, name: str):
             raise ValueError(f"Multiple entities found in registry with given name: '{name}'.")
         return entities[0]
 
-    def show(self):
+    def __str__(self):
         """
-        Prints a list of all registered entities, grouped by type.
+        Returns a string representation of all registered entities, grouped by type.
         """
         index = 0
-        print("---- Content of the registry ----")
+        result = "---- Content of the registry ----\n"
         # pylint: disable=no-member
         for entity_bucket, entities in self.internal_registry.items():
-            print(f"    Entities of type '{entity_bucket}':")
+            result += f"    Entities of type '{entity_bucket}':\n"
             for entity in entities:
-                print(f"    - [{index:03d}]\n{entity}")
+                result += f"    - [{index:03d}]\n{entity}\n"
                 index += 1
-        print("---- End of content ----")
+        result += "---- End of content ----"
+        return result
 
     def clear(self):
         """

flow360/component/simulation/operating_condition.py

@@ -72,14 +72,34 @@ def from_standard_atmosphere(
         altitude: LengthType.Positive = 0 * u.m,
         temperature_offset: TemperatureType = 0 * u.K,
     ):
-        """Constructs a thermal state from the standard atmosphere model."""
-        # pylint: disable=fixme
-        # TODO: add standard atmosphere implementation
-        density = 1.225 * u.kg / u.m**3
-        temperature = 288.15 * u.K
+        """Constructs a thermal state from the standard atmosphere model.
 
-        state = cls(density=density, temperature=temperature, material=Air())
+        Parameters:
+        altitude (LengthType.Positive): The altitude at which the state is calculated.
+        temperature_offset (TemperatureType): The offset to be applied to the standard temperature.
+
+        Returns:
+        ThermalState: The thermal state at the given altitude.
+        """
+        # Standard atmosphere constants
+        t0 = 288.15 * u.K  # Sea level standard temperature
+        p0 = 101325 * u.Pa  # Sea level standard pressure
+        lapse_rate = 0.0065 * u.K / u.m  # Temperature lapse rate
+        r = Air().gas_constant  # Specific gas constant for dry air
+        g0 = 9.80665 * u.m / u.s**2  # Standard gravity
+
+        # Calculate temperature at the given altitude
+        temperature = t0 - lapse_rate * altitude
+        temperature += temperature_offset
 
+        # Calculate pressure at the given altitude
+        pressure = p0 * (1 - (lapse_rate * altitude / t0)) ** (g0 / (r * lapse_rate))
+
+        # Calculate density at the given altitude
+        density = pressure / (r * temperature)
+
+        # Construct and return the thermal state
+        state = cls(density=density, temperature=temperature, material=Air())
         return state
 
     @property
@@ -113,7 +133,7 @@ def dynamic_viscosity(self) -> ViscosityType.Positive:
 
     # TODO: should we make this private_attribute?
     @pd.validate_call
-    def mu_ref(self, mesh_unit: LengthType.Positive) -> pd.PositiveFloat:
+    def _mu_ref(self, mesh_unit: LengthType.Positive) -> pd.PositiveFloat:
         """Computes nondimensional dynamic viscosity."""
         # TODO: use unit system for nondimensionalization
         return (self.dynamic_viscosity / (self.speed_of_sound * self.density * mesh_unit)).v.item()

flow360/component/simulation/services.py

@@ -230,8 +230,7 @@ def _translate_simulation_json(
 
     if translated_dict == {}:
         raise ValueError(f"No {target_name} parameters found in given SimulationParams.")
-    # pylint: disable=fixme
-    # TODO: Implement proper hashing. Currently floating point creates headache for reproducible hashing.
+
     # pylint: disable=protected-access
     hash_value = SimulationParams._calculate_hash(translated_dict)
     return translated_dict, hash_value

flow360/component/simulation/simulation_params.py

@@ -42,9 +42,7 @@
 from flow360.exceptions import Flow360ConfigurationError, Flow360RuntimeError
 from flow360.version import __version__
 
-AllowedModelTypes = Annotated[
-    Union[VolumeModelTypes, SurfaceModelTypes], pd.Field(discriminator="type")
-]
+ModelTypes = Annotated[Union[VolumeModelTypes, SurfaceModelTypes], pd.Field(discriminator="type")]
 
 
 class _ParamModelBase(Flow360BaseModel):
@@ -165,7 +163,7 @@ class SimulationParams(_ParamModelBase):
     3. by_name(pattern:str) to use regexpr/glob to select all zones/surfaces with matched name
     3. by_type(pattern:str) to use regexpr/glob to select all zones/surfaces with matched type
     """
-    models: Optional[List[AllowedModelTypes]] = pd.Field(None)
+    models: Optional[List[ModelTypes]] = pd.Field(None)
     """
     Below can be mostly reused with existing models 
     """

flow360/component/simulation/translator/solver_translator.py

@@ -651,7 +651,8 @@ def get_solver_json(
             if isinstance(op.thermal_state.material.dynamic_viscosity, Sutherland)
             else -1
         ),
-        "muRef": op.thermal_state.mu_ref(mesh_unit),
+        # pylint: disable=protected-access
+        "muRef": op.thermal_state._mu_ref(mesh_unit),
     }
     if "reference_velocity_magnitude" in op.model_fields.keys() and op.reference_velocity_magnitude:
         translated["freestream"]["MachRef"] = op.reference_velocity_magnitude.v.item()

flow360/component/simulation/translator/utils.py

@@ -122,9 +122,17 @@ def remove_units_in_dict(input_dict):
         new_dict = {}
         if input_dict.keys() == unit_keys:
             new_dict = input_dict["value"]
+            if input_dict["units"].startswith("flow360_") is False:
+                raise ValueError(
+                    f"[Internal Error] Unit {new_dict['units']} is not non-dimensionalized."
+                )
             return new_dict
         for key, value in input_dict.items():
             if isinstance(value, dict) and value.keys() == unit_keys:
+                if value["units"].startswith("flow360_") is False:
+                    raise ValueError(
+                        f"[Internal Error] Unit {new_dict['units']} is not non-dimensionalized."
+                    )
                 new_dict[key] = value["value"]
             else:
                 new_dict[key] = remove_units_in_dict(value)