[Tracking] Simulation Interface

.github/workflows/codestyle.yml

@@ -40,6 +40,8 @@ jobs:
           cache: 'poetry'
       - name: Install isort
         run: poetry install --only=dev
+      - name: Check isort version
+        run: poetry run isort --version 
       - name: Run isort
         run: poetry run isort . --check-only
 
@@ -56,4 +58,4 @@ jobs:
       - name: Install dependencies
         run: poetry install
       - name: Run pylint
-        run: poetry run pylint flow360 --rcfile .pylintrc
+        run: poetry run pylint $(git ls-files "flow360/*.py") --rcfile .pylintrc

.github/workflows/test.yml

@@ -41,6 +41,9 @@ jobs:
         poetry cache clear --all pypi
         Remove-Item -Recurse -Force $env:USERPROFILE\AppData\Local\pypoetry\Cache\virtualenvs
     - name: Install dependencies
-      run: poetry install
-    - name: Run tests
-      run: poetry run pytest -rA
+      run: |
+        poetry install
+    - name: Run simulation_params tests
+      run: poetry run pytest -rA tests/simulation
+    - name: Run flow360_params tests
+      run: poetry run pytest -rA --ignore tests/simulation

.gitignore

@@ -325,4 +325,7 @@ $RECYCLE.BIN/
 
 tmp/
 
-/.vscode
+/.vscode
+
+# test residual
+flow360/examples/cylinder2D/flow360mesh.json

.pylintrc

@@ -46,7 +46,7 @@ ignore=tests, flow360/examples
 
 # Add files or directories matching the regex patterns to the ignore-list. The
 # regex matches against paths and can be in Posix or Windows format.
-ignore-paths=tests
+ignore-paths=tests, flow360/examples, flow360/component/simulation/user_story_examples, flow360/component/results
 
 # Files or directories matching the regex patterns are skipped. The regex
 # matches against base names, not paths. The default value ignores Emacs file
@@ -82,7 +82,7 @@ persistent=yes
 
 # Minimum Python version to use for version dependent checks. Will default to
 # the version used to run pylint.
-py-version=3.7
+py-version=3.9
 
 # Discover python modules and packages in the file system subtree.
 recursive=no

README.md

@@ -61,7 +61,7 @@ Environment ``FLOW360_APIKEY`` variable takes precedence before Flow360 configur
 1. ``poetry run pytest -rA``
 2. ``black .`` - performs auto-formatting
 3. ``isort .`` - sorts imports
-4. ``pylint flow360 --rcfile .pylintrc`` - checks code style
+4. ``poetry run pylint $(git ls-files "flow360/*.py") --rcfile .pylintrc`` - checks code style
 5. ``pytest tests --cov-report=html --cov=flow360 && open htmlcov/index.html`` - see test coverage report
 
 ## Documentation Requirements

examples/case_from_multiple_files/main.py

@@ -1,7 +1,7 @@
 import os
 
 import flow360 as fl
-import flow360.units as u
+import flow360.component.flow360_params.units as u
 from flow360.examples import OM6wing
 
 here = os.path.dirname(os.path.abspath(__file__))

examples/case_params_with_units.py

@@ -4,7 +4,7 @@
 import flow360 as fl
 from flow360 import log
 from flow360 import units as u
-from flow360.services import validate_flow360_params_model
+from flow360.component.flow360_params.services import validate_model
 
 log.set_logging_level("DEBUG")
 
@@ -53,7 +53,7 @@
 
 del params_as_dict["fluid_properties"]
 
-errors, warnings = validate_flow360_params_model(params_as_dict, "SI")
+errors, warnings = validate_model(params_as_dict, "SI")
 pprint(errors)
 
 params_as_json = params.json(indent=4)
@@ -72,5 +72,5 @@
 
 # Class name removal from loc
 params_as_dict["freestream"]["foo"] = "bar"
-errors, warnings = validate_flow360_params_model(params_as_dict, "SI")
+errors, warnings = validate_model(params_as_dict, "SI")
 pprint(errors)

examples/data/airplane_simple/airplane_simple.mapbc

@@ -0,0 +1,4 @@
+3
+1 4000 leftWing
+2 4000 fuselage
+3 4000 rightWing

examples/dev/dev_serializing_unyt.py

@@ -0,0 +1,125 @@
+from __future__ import annotations
+
+from typing import Annotated, List, Literal
+
+import pydantic as pd
+import unyt as u
+from pydantic import PlainSerializer, PlainValidator
+from pydantic_core import core_schema
+
+
+def _has_dimensions(quant, dim):
+    try:
+        arg_dim = quant.units.dimensions
+    except AttributeError:
+        arg_dim = u.dimensionless
+    return arg_dim == dim
+
+
+def _unit_object_parser(value, unyt_types: List[type]):
+    if isinstance(value, dict) and "units" in value:
+        if "value" in value:
+            for unyt_type in unyt_types:
+                try:
+                    return unyt_type(value["value"], value["units"])
+                except u.exceptions.UnitParseError:
+                    pass
+        else:
+            raise TypeError(
+                f"Dimensioned type instance {value} expects a 'value' field which was not given"
+            )
+    return value
+
+
+def _is_unit_validator(value):
+    if isinstance(value, str):
+        try:
+            value = u.Unit(value)
+        except u.exceptions.UnitParseError as err:
+            raise TypeError(str(err)) from err
+    return value
+
+
+def _unit_array_validator(value, dim):
+    if not _has_dimensions(value, dim):
+        if any(_has_dimensions(item, dim) for item in value):
+            raise TypeError(
+                f"arg '{value}' has unit provided per component, "
+                "instead provide dimension for entire array."
+            )
+    return value
+
+
+def validate(value):
+    """
+    Validator for unyt value
+    """
+
+    value = _unit_object_parser(value, [u.unyt_quantity])
+    value = _is_unit_validator(value)
+
+    if isinstance(value, u.Unit):
+        return 1.0 * value
+
+    return value
+
+
+def serialize(value):
+    """
+    Serializer for unyt value
+    """
+
+    return {"value": str(value["data"].value), "units": str(value["data"].units)}
+
+
+class _DimensionedField(pd.BaseModel):
+    data: u.unyt_quantity = pd.Field()
+    dim_type: Literal["length"] = pd.Field()
+
+    @classmethod
+    def validate(cls, value):
+        """
+        Validator for value
+        """
+
+        try:
+            value = _unit_object_parser(value, [u.unyt_quantity])
+        except TypeError as err:
+            raise pd.ValidationError.from_exception_data("validation error", [])
+
+        if isinstance(value, u.Unit):
+            return {"data": 1.0 * value}
+
+        return {"data": value}
+
+    @classmethod
+    def __get_pydantic_core_schema__(cls, *args, **kwargs) -> pd.CoreSchema:
+        return core_schema.no_info_plain_validator_function(cls.validate)
+
+
+DimensionedField = Annotated[
+    _DimensionedField,
+    PlainSerializer(serialize),
+]
+
+
+class _OtherField(_DimensionedField):
+    dim_type: Literal["time"] = pd.Field()
+
+
+OtherField = Annotated[
+    _OtherField,
+    PlainSerializer(serialize),
+]
+
+
+class DataModel(pd.BaseModel):
+    dimensioned_field: OtherField = pd.Field()
+
+
+data = DataModel(dimensioned_field=1 * u.m)
+
+
+data_json = data.model_dump_json(indent=2)
+
+print(data_json)

examples/dev/dev_webservice_usage.py

@@ -2,7 +2,7 @@
 import os
 import re
 
-from flow360.services import get_default_fork
+from flow360.component.flow360_params.services import get_default_fork
 
 # Webservice examples
 

examples/geometry_id_surface_volume_case_airplane_v1_from_csm.py

@@ -0,0 +1,56 @@
+import os
+
+import flow360 as fl
+
+fl.Env.preprod.active()
+
+from flow360.component.geometry_v1 import Geometry
+from flow360.component.meshing.params import Farfield, Volume, VolumeMeshingParams
+from flow360.examples import Airplane
+
+# geometry
+geometry_draft = Geometry.from_file(Airplane.geometry, name="testing-airplane-csm-geometry")
+geometry = geometry_draft.submit()
+print(geometry)
+
+# surface mesh
+params = fl.SurfaceMeshingParams(max_edge_length=0.16)
+
+surface_mesh_draft = fl.SurfaceMesh.create(
+    geometry_id=geometry.id,
+    params=params,
+    name="airplane-surface-mesh-from-geometry-id-v1",
+    solver_version="mesher-24.2.2",
+)
+surface_mesh = surface_mesh_draft.submit()
+
+print(surface_mesh)
+
+# volume mesh
+params = fl.VolumeMeshingParams(
+    volume=Volume(
+        first_layer_thickness=1e-5,
+        growth_rate=1.2,
+    ),
+    farfield=Farfield(type="auto"),
+)
+
+volume_mesh_draft = fl.VolumeMesh.create(
+    surface_mesh_id=surface_mesh.id,
+    name="airplane-volume-mesh-from-geometry-id-v1",
+    params=params,
+    solver_version="mesher-24.2.2",
+)
+volume_mesh = volume_mesh_draft.submit()
+print(volume_mesh)
+
+# case
+params = fl.Flow360Params(Airplane.case_json)
+params.boundaries = {
+    "fluid/farfield": fl.FreestreamBoundary(),
+    "fluid/fuselage": fl.NoSlipWall(),
+    "fluid/leftWing": fl.NoSlipWall(),
+    "fluid/rightWing": fl.NoSlipWall(),
+}
+case_draft = volume_mesh.create_case("airplane-case-from-csm-geometry-id-v1", params)
+case = case_draft.submit()

examples/geometry_id_surface_volume_case_airplane_v1_from_egads.py

@@ -0,0 +1,56 @@
+import os
+
+import flow360 as fl
+
+fl.Env.preprod.active()
+
+from flow360.component.geometry_v1 import Geometry
+from flow360.component.meshing.params import Farfield, Volume, VolumeMeshingParams
+from flow360.examples import Airplane
+
+# geometry
+geometry_draft = Geometry.from_file(
+    "data/airplane_geometry.egads", name="testing-airplane-egads-geometry"
+)
+geometry = geometry_draft.submit()
+print(geometry)
+
+# surface mesh
+params = fl.SurfaceMeshingParams(max_edge_length=0.16)
+
+surface_mesh_draft = fl.SurfaceMesh.create(
+    geometry_id=geometry.id,
+    params=params,
+    name="airplane-surface-mesh-from-geometry-id-v1",
+)
+surface_mesh = surface_mesh_draft.submit()
+
+print(surface_mesh)
+
+# volume mesh
+params = fl.VolumeMeshingParams(
+    volume=Volume(
+        first_layer_thickness=1e-5,
+        growth_rate=1.2,
+    ),
+    farfield=Farfield(type="auto"),
+)
+
+volume_mesh_draft = fl.VolumeMesh.create(
+    surface_mesh_id=surface_mesh.id,
+    name="airplane-volume-mesh-from-geometry-id-v1",
+    params=params,
+)
+volume_mesh = volume_mesh_draft.submit()
+print(volume_mesh)
+
+# case
+params = fl.Flow360Params(Airplane.case_json)
+params.boundaries = {
+    "fluid/farfield": fl.FreestreamBoundary(),
+    "fluid/fuselage": fl.NoSlipWall(),
+    "fluid/leftWing": fl.NoSlipWall(),
+    "fluid/rightWing": fl.NoSlipWall(),
+}
+case_draft = volume_mesh.create_case("airplane-case-from-egads-geometry-id-v1", params)
+case = case_draft.submit()

examples/geometry_to_surface_mesh_V2.py

@@ -0,0 +1,32 @@
+import flow360 as fl
+from flow360.component.geometry import Geometry
+from flow360.component.simulation import cloud
+from flow360.component.simulation.meshing_param.face_params import (
+    BoundaryLayer,
+    SurfaceRefinement,
+)
+from flow360.component.simulation.meshing_param.params import MeshingParams
+from flow360.component.simulation.meshing_param.volume_params import AutomatedFarfield
+from flow360.component.simulation.simulation_params import SimulationParams
+from flow360.component.simulation.unit_system import SI_unit_system
+from flow360.examples import Airplane
+
+fl.Env.dev.active()
+
+geometry_draft = Geometry.from_file(
+    Airplane.geometry, name="testing-airplane-csm-geometry", solver_version="workbench-24.7"
+)
+geometry = geometry_draft.submit()
+with SI_unit_system:
+    params = SimulationParams(
+        meshing=MeshingParams(
+            refinements=[
+                SurfaceRefinement(max_edge_length=0.8),
+                BoundaryLayer(first_layer_thickness=0.8),
+            ],
+            volume_zones=[AutomatedFarfield()],
+        ),
+    )
+cloud.generate_surface_mesh(geometry, params=params, async_mode=True)
+# geometry.generate_volume_mesh(params=params, async_mode=False)
+print(geometry._meta_class)

examples/retrieve_results/bet_disk.py

@@ -1,7 +1,7 @@
 import os
 
 import flow360 as fl
-import flow360.units as u
+import flow360.component.flow360_params.units as u
 from flow360.examples import BETDisk
 
 BETDisk.get_files()