Add GhostCircularPlane to GhostSurfacePair (#1564)

* add GhostCircularPlane to GhostSurfacePair

* update unit test

* code style clean

* add ClassVar to GhostSurfaceType

* Removed GhostSurfaceTypes

---------

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

Author: 2 people

flow360/component/simulation/entity_info.py

@@ -45,18 +45,18 @@
     pd.Field(discriminator="private_attribute_entity_type_name"),
 ]
 
-GhostSurfaceTypes = Annotated[
-    Union[GhostSphere, GhostCircularPlane],
-    pd.Field(discriminator="private_attribute_entity_type_name"),
-]
-
 
 class EntityInfoModel(Flow360BaseModel, metaclass=ABCMeta):
     """Base model for asset entity info JSON"""
 
     # entities that appear in simulation JSON but did not appear in EntityInfo)
     draft_entities: List[DraftEntityTypes] = pd.Field([])
-    ghost_entities: List[GhostSurfaceTypes] = pd.Field([])
+    ghost_entities: List[
+        Annotated[
+            Union[GhostSphere, GhostCircularPlane],
+            pd.Field(discriminator="private_attribute_entity_type_name"),
+        ]
+    ] = pd.Field([])
 
     @abstractmethod
     def get_boundaries(self, attribute_name: str = None) -> list[Surface]:

flow360/component/simulation/primitives.py

@@ -747,10 +747,17 @@ class GhostSurfacePair(SurfacePairBase):
     Represents a pair of ghost surfaces.
 
     Attributes:
-        pair (Tuple[GhostSurface, GhostSurface]): A tuple containing two GhostSurface objects representing the pair.
+        pair (Tuple[GhostSurfaceType, GhostSurfaceType]):
+            A tuple containing two GhostSurfaceType objects representing the pair.
+            GhostSurface is for Python API, GhostCircularPlane is for Web UI.
     """
 
-    pair: Tuple[GhostSurface, GhostSurface]
+    GhostSurfaceType: ClassVar[type] = Annotated[
+        Union[GhostSurface, GhostCircularPlane],
+        pd.Field(discriminator="private_attribute_entity_type_name"),
+    ]
+
+    pair: Tuple[GhostSurfaceType, GhostSurfaceType]
 
 
 @final

tests/simulation/params/test_validators_params.py

@@ -92,7 +92,6 @@
     GhostCircularPlane,
     GhostSphere,
     GhostSurface,
-    GhostSurfacePair,
     Surface,
     SurfacePrivateAttributes,
 )
@@ -2255,7 +2254,7 @@ def test_check_custom_volume_in_volume_zones():
 
 
 def test_ghost_surface_pair_requires_quasi_3d_periodic_farfield():
-    # Create two dummy ghost surfaces
+    # Create two dummy ghost surfaces (Python workflow)
     periodic_1 = GhostSurface(name="periodic_1")
     periodic_2 = GhostSurface(name="periodic_2")
 
@@ -2268,3 +2267,17 @@ def test_ghost_surface_pair_requires_quasi_3d_periodic_farfield():
     # Case 2: Farfield method IS "quasi-3d-periodic" → should pass
     with SI_unit_system, ValidationContext(CASE, quasi_3d_periodic_farfield_context):
         Periodic(surface_pairs=(periodic_1, periodic_2), spec=Translational())
+
+    # Create two dummy ghost circular plane (Web UI workflow)
+    periodic_1 = GhostCircularPlane(name="periodic_1")
+    periodic_2 = GhostCircularPlane(name="periodic_2")
+
+    # Case 3: Farfield method NOT "quasi-3d-periodic" → should raise ValueError
+    with SI_unit_system, ValidationContext(CASE, quasi_3d_farfield_context), pytest.raises(
+        ValueError, match="Farfield type must be 'quasi-3d-periodic' when using GhostSurfacePair."
+    ):
+        Periodic(surface_pairs=(periodic_1, periodic_2), spec=Translational())
+
+    # Case 4: Farfield method IS "quasi-3d-periodic" → should pass
+    with SI_unit_system, ValidationContext(CASE, quasi_3d_periodic_farfield_context):
+        Periodic(surface_pairs=(periodic_1, periodic_2), spec=Translational())