[FXC-4322] feat: wind tunnel farfield Python interface (#1582)

* initial progress (flow360)

* progress

* json parsing mostly done, w/ test

* changes in pipeline to allow wind tunnel farfield

* formatted

* fix linting

* black issue caused by merge conflict

* added floor type defaults, pd.Field descriptions

* addressed some comments, validation wip

* ghost surfaces

* parameter validation testcases

* is -> isinstance bug fix

* added valid test case

* updated pipeline to support wind tunnel compatibility with solver (one check temp disabled)

* switched schema to tuple

* worked WindTunnelGhostSurface into pipeline

* formatting

* fix test break

* added translation tests

* formatting

* minor changes; unifying allowed surfaces list next

* made get_valid_ghost_surfaces consistent with @propertys

* added staticmethod for getting boundaries w/o validation

* checked left, right, symmetric plane for half body wind tunnel

* Fixed linting

* minor fixes

* pylint duplicate code

* addressed feedback

---------

Co-authored-by: Ben <106089368+benflexcompute@users.noreply.github.com>
Co-authored-by: benflexcompute <ben@flexcompute.com>

Author: alexxu-flex

flow360/__init__.py

@@ -38,13 +38,18 @@
 from flow360.component.simulation.meshing_param.volume_params import (
     AutomatedFarfield,
     AxisymmetricRefinement,
+    CentralBelt,
     CustomZones,
+    FullyMovingFloor,
     MeshSliceOutput,
     RotationCylinder,
     RotationVolume,
+    StaticFloor,
     StructuredBoxRefinement,
     UniformRefinement,
     UserDefinedFarfield,
+    WheelBelts,
+    WindTunnelFarfield,
 )
 from flow360.component.simulation.models.material import (
     Air,
@@ -337,6 +342,11 @@
     "ImportedSurface",
     "OctreeSpacing",
     "RunControl",
+    "WindTunnelFarfield",
+    "StaticFloor",
+    "FullyMovingFloor",
+    "CentralBelt",
+    "WheelBelts",
 ]
 
 _warn_prerelease()

flow360/component/simulation/entity_info.py

@@ -29,6 +29,7 @@
     GhostSphere,
     SnappyBody,
     Surface,
+    WindTunnelGhostSurface,
 )
 from flow360.component.simulation.unit_system import LengthType
 from flow360.component.simulation.utils import BoundingBoxType, model_attribute_unlock
@@ -53,11 +54,11 @@
 class EntityInfoModel(Flow360BaseModel, metaclass=ABCMeta):
     """Base model for asset entity info JSON"""
 
-    # entities that appear in simulation JSON but did not appear in EntityInfo)
+    # entities that appear in simulation JSON but did not appear in EntityInfo
     draft_entities: List[DraftEntityTypes] = pd.Field([])
     ghost_entities: List[
         Annotated[
-            Union[GhostSphere, GhostCircularPlane],
+            Union[GhostSphere, GhostCircularPlane, WindTunnelGhostSurface],
             pd.Field(discriminator="private_attribute_entity_type_name"),
         ]
     ] = pd.Field([])

flow360/component/simulation/meshing_param/params.py

@@ -30,6 +30,7 @@
     StructuredBoxRefinement,
     UniformRefinement,
     UserDefinedFarfield,
+    WindTunnelFarfield,
 )
 from flow360.component.simulation.primitives import SeedpointVolume
 from flow360.component.simulation.validation.validation_context import (
@@ -60,6 +61,7 @@
         AutomatedFarfield,
         UserDefinedFarfield,
         CustomZones,
+        WindTunnelFarfield,
     ],
     pd.Field(discriminator="type"),
 ]
@@ -162,13 +164,14 @@ class MeshingParams(Flow360BaseModel):
 
     @pd.field_validator("volume_zones", mode="after")
     @classmethod
-    def _check_volume_zones_has_farfied(cls, v):
+    def _check_volume_zones_has_farfield(cls, v):
         if v is None:
             # User did not put anything in volume_zones so may not want to use volume meshing
             return v
 
         total_farfield = sum(
-            isinstance(volume_zone, (AutomatedFarfield, UserDefinedFarfield)) for volume_zone in v
+            isinstance(volume_zone, (AutomatedFarfield, WindTunnelFarfield, UserDefinedFarfield))
+            for volume_zone in v
         )
         if total_farfield == 0:
             raise ValueError("Farfield zone is required in `volume_zones`.")
@@ -275,11 +278,13 @@ def _check_no_reused_volume_entities(self) -> Self:
 
     @property
     def farfield_method(self):
-        """Returns the  farfield method used."""
+        """Returns the farfield method used."""
         if self.volume_zones:
             for zone in self.volume_zones:  # pylint: disable=not-an-iterable
                 if isinstance(zone, AutomatedFarfield):
                     return zone.method
+                if isinstance(zone, WindTunnelFarfield):
+                    return "wind-tunnel"
                 if isinstance(zone, UserDefinedFarfield):
                     return "user-defined"
         return None