refactor(): Replaced EntityList child class with per-entity-type validations (#1693)

Author: benflexcompute

flow360/component/simulation/draft_context/coordinate_system_manager.py

@@ -436,7 +436,7 @@ def _from_status(
                 key = (entity.entity_type, entity.entity_id)
                 # Sanitize invalid assignments due to entity not being in scope anymore.
                 if (
-                    entity_registry  # entity_registry None indicates that no validation is needed
+                    entity_registry  # Fast lane: entity_registry None indicates that no validation is needed
                     and (
                         entity_registry.find_by_type_name_and_id(
                             entity_type=entity.entity_type, entity_id=entity.entity_id

flow360/component/simulation/framework/entity_base.py

@@ -152,6 +152,17 @@ def id(self) -> str:
         """Returns private_attribute_id of the entity."""
         return self.private_attribute_id
 
+    def _manual_assignment_validation(self, _: ParamsValidationInfo) -> EntityBase:
+        """
+        Pre-expansion contextual validation for the entity.
+        This handles validation for the entity manually assigned.
+        """
+        return self
+
+    def _per_entity_type_validation(self, _: ParamsValidationInfo) -> EntityBase:
+        """Contextual validation with validation logic bond with the specific entity type."""
+        return self
+
 
 class _CombinedMeta(type(Flow360BaseModel), type):
     pass
@@ -265,18 +276,42 @@ def _ensure_entities_after_expansion(self, param_info: ParamsValidationInfo):
         With delayed selector expansion, stored_entities may be empty if only selectors
         are defined.
         """
-        # If stored_entities already has entities, validation passes
-        if self.stored_entities:
-            return self
+        is_empty = True
+        # If stored_entities already has entities (user manual assignment), validation passes
+        manual_assignments: List[EntityBase] = self.stored_entities
+        # pylint: disable=protected-access
+        if manual_assignments:
+            filtered_assignments = [
+                item
+                for item in manual_assignments
+                if item._manual_assignment_validation(param_info) is not None
+            ]
+            # Use object.__setattr__ to bypass validate_on_assignment and avoid recursion
+            object.__setattr__(
+                self,
+                "stored_entities",
+                filtered_assignments,
+            )
+
+            for item in filtered_assignments:
+                item._per_entity_type_validation(param_info)
+
+            if filtered_assignments:
+                is_empty = False
 
         # No stored_entities - check if selectors will produce any entities
         if self.selectors:
-            expanded = param_info.expand_entity_list(self)
+            expanded: List[EntityBase] = param_info.expand_entity_list(self)
             if expanded:
+                for item in expanded:
+                    item._per_entity_type_validation(param_info)
+                # Known non-empty
                 return self
 
         # Neither stored_entities nor selectors produced any entities
-        raise ValueError("No entities were selected.")
+        if is_empty:
+            raise ValueError("No entities were selected.")
+        return self
 
     @classmethod
     def _get_valid_entity_types(cls):
@@ -311,17 +346,17 @@ def _get_valid_entity_types(cls):
         raise TypeError("Cannot extract valid entity types.")
 
     @classmethod
-    def _process_selector(cls, selector: EntitySelector, valid_type_names: List[str]) -> dict:
+    def _validate_selector(cls, selector: EntitySelector, valid_type_names: List[str]) -> dict:
         """Process and validate an EntitySelector object."""
         if selector.target_class not in valid_type_names:
             raise ValueError(
                 f"Selector target_class ({selector.target_class}) is incompatible "
                 f"with EntityList types {valid_type_names}."
             )
-        return selector.model_dump()
+        return selector
 
     @classmethod
-    def _process_entity(cls, entity: Union[EntityBase, Any]) -> EntityBase:
+    def _validate_entity(cls, entity: Union[EntityBase, Any]) -> EntityBase:
         """Process and validate an entity object."""
         if isinstance(entity, EntityBase):
             return entity
@@ -333,12 +368,12 @@ def _process_entity(cls, entity: Union[EntityBase, Any]) -> EntityBase:
 
     @classmethod
     def _build_result(
-        cls, entities_to_store: List[EntityBase], entity_patterns_to_store: List[dict]
+        cls, entities_to_store: List[EntityBase], entity_selectors_to_store: List[dict]
     ) -> dict:
         """Build the final result dictionary."""
         return {
             "stored_entities": entities_to_store,
-            "selectors": entity_patterns_to_store if entity_patterns_to_store else None,
+            "selectors": entity_selectors_to_store if entity_selectors_to_store else None,
         }
 
     @classmethod
@@ -348,13 +383,13 @@ def _process_single_item(
         item: Union[EntityBase, EntitySelector],
         valid_type_names: List[str],
         entities_to_store: List[EntityBase],
-        entity_patterns_to_store: List[dict],
+        entity_selectors_to_store: List[dict],
     ) -> None:
         """Process a single item (entity or selector) and add to appropriate storage lists."""
         if isinstance(item, EntitySelector):
-            entity_patterns_to_store.append(cls._process_selector(item, valid_type_names))
+            entity_selectors_to_store.append(cls._validate_selector(item, valid_type_names))
         else:
-            processed_entity = cls._process_entity(item)
+            processed_entity = cls._validate_entity(item)
             entities_to_store.append(processed_entity)
 
     @pd.model_validator(mode="before")
@@ -367,7 +402,7 @@ def deserializer(cls, input_data: Union[dict, list, EntityBase, EntitySelector])
         field validator, which runs after deserialization but before discriminator validation.
         """
         entities_to_store = []
-        entity_patterns_to_store = []
+        entity_selectors_to_store = []
         valid_types = tuple(cls._get_valid_entity_types())
         valid_type_names = [t.__name__ for t in valid_types]
 
@@ -379,15 +414,15 @@ def deserializer(cls, input_data: Union[dict, list, EntityBase, EntitySelector])
             for item in input_data:
                 if isinstance(item, list):  # Nested list comes from assets __getitem__
                     # Process all entities without filtering
-                    processed_entities = [cls._process_entity(individual) for individual in item]
+                    processed_entities = [cls._validate_entity(individual) for individual in item]
                     entities_to_store.extend(processed_entities)
                 else:
                     # Single entity or selector
                     cls._process_single_item(
                         item,
                         valid_type_names,
                         entities_to_store,
-                        entity_patterns_to_store,
+                        entity_selectors_to_store,
                     )
         elif isinstance(input_data, dict):  # Deserialization
             # With delayed selector expansion, stored_entities may be absent if only selectors are defined.
@@ -403,13 +438,13 @@ def deserializer(cls, input_data: Union[dict, list, EntityBase, EntitySelector])
                 input_data,
                 valid_type_names,
                 entities_to_store,
-                entity_patterns_to_store,
+                entity_selectors_to_store,
             )
 
-        if not entities_to_store and not entity_patterns_to_store:
+        if not entities_to_store and not entity_selectors_to_store:
             raise ValueError(
                 f"Can not find any valid entity of type {[valid_type.__name__ for valid_type in valid_types]}"
                 f" from the input."
             )
 
-        return cls._build_result(entities_to_store, entity_patterns_to_store)
+        return cls._build_result(entities_to_store, entity_selectors_to_store)

flow360/component/simulation/meshing_param/face_params.py

@@ -6,7 +6,6 @@
 
 from flow360.component.simulation.framework.base_model import Flow360BaseModel
 from flow360.component.simulation.framework.entity_base import EntityList
-from flow360.component.simulation.models.surface_models import EntityListAllowingGhost
 from flow360.component.simulation.primitives import (
     GhostCircularPlane,
     GhostSurface,
@@ -44,7 +43,7 @@ class SurfaceRefinement(Flow360BaseModel):
 
     name: Optional[str] = pd.Field("Surface refinement")
     refinement_type: Literal["SurfaceRefinement"] = pd.Field("SurfaceRefinement", frozen=True)
-    entities: EntityListAllowingGhost[
+    entities: EntityList[
         Surface, MirroredSurface, WindTunnelGhostSurface, GhostSurface, GhostCircularPlane
     ] = pd.Field(alias="faces")
     # pylint: disable=no-member
@@ -183,7 +182,7 @@ class PassiveSpacing(Flow360BaseModel):
         """
     )
     refinement_type: Literal["PassiveSpacing"] = pd.Field("PassiveSpacing", frozen=True)
-    entities: EntityListAllowingGhost[
+    entities: EntityList[
         Surface, MirroredSurface, WindTunnelGhostSurface, GhostSurface, GhostCircularPlane
     ] = pd.Field(alias="faces")
 

flow360/component/simulation/models/solver_numerics.py

@@ -22,12 +22,7 @@
     Flow360BaseModel,
 )
 from flow360.component.simulation.framework.entity_base import EntityList
-from flow360.component.simulation.primitives import (
-    Box,
-    CustomVolume,
-    EntityListWithCustomVolume,
-    GenericVolume,
-)
+from flow360.component.simulation.primitives import Box, CustomVolume, GenericVolume
 
 # from .time_stepping import UnsteadyTimeStepping
 
@@ -250,7 +245,7 @@ class TurbulenceModelControls(Flow360BaseModel):
         None, description="Force RANS or LES mode in a specific control region."
     )
 
-    entities: EntityListWithCustomVolume[GenericVolume, CustomVolume, Box] = pd.Field(
+    entities: EntityList[GenericVolume, CustomVolume, Box] = pd.Field(
         alias="volumes",
         description="The entity in which to apply the `TurbulenceMOdelControls``. "
         + "The entity should be defined by :class:`Box` or zones from the geometry/volume mesh."

flow360/component/simulation/models/surface_models.py

@@ -45,12 +45,9 @@
 from flow360.component.simulation.validation.validation_context import (
     ParamsValidationInfo,
     contextual_field_validator,
-    contextual_model_validator,
 )
 from flow360.component.simulation.validation.validation_utils import (
     check_deleted_surface_pair,
-    check_symmetric_boundary_existence,
-    check_user_defined_farfield_symmetry_existence,
     validate_entity_list_surface_existence,
 )
 
@@ -59,18 +56,6 @@
 from flow360.component.types import Axis
 
 
-class EntityListAllowingGhost(EntityList):
-    """Entity list with customized validators for ghost entities"""
-
-    @contextual_model_validator(mode="after")
-    def ghost_entity_validator(self, param_info: ParamsValidationInfo):
-        """Run all validators"""
-        expanded = param_info.expand_entity_list(self)
-        check_user_defined_farfield_symmetry_existence(expanded, param_info)
-        check_symmetric_boundary_existence(expanded, param_info)
-        return self
-
-
 class BoundaryBase(Flow360BaseModel, metaclass=ABCMeta):
     """Boundary base"""
 
@@ -489,7 +474,7 @@ class Freestream(BoundaryBaseWithTurbulenceQuantities):
         + ":py:attr:`AerospaceCondition.alpha` and :py:attr:`AerospaceCondition.beta` angles. "
         + "Optionally, an expression for each of the velocity components can be specified.",
     )
-    entities: EntityListAllowingGhost[
+    entities: EntityList[
         Surface,
         MirroredSurface,
         GhostSurface,
@@ -659,7 +644,7 @@ class SlipWall(BoundaryBase):
         "Slip wall", description="Name of the `SlipWall` boundary condition."
     )
     type: Literal["SlipWall"] = pd.Field("SlipWall", frozen=True)
-    entities: EntityListAllowingGhost[
+    entities: EntityList[
         Surface, MirroredSurface, GhostSurface, WindTunnelGhostSurface, GhostCircularPlane
     ] = pd.Field(
         alias="surfaces",
@@ -692,9 +677,7 @@ class SymmetryPlane(BoundaryBase):
         "Symmetry", description="Name of the `SymmetryPlane` boundary condition."
     )
     type: Literal["SymmetryPlane"] = pd.Field("SymmetryPlane", frozen=True)
-    entities: EntityListAllowingGhost[
-        Surface, MirroredSurface, GhostSurface, GhostCircularPlane
-    ] = pd.Field(
+    entities: EntityList[Surface, MirroredSurface, GhostSurface, GhostCircularPlane] = pd.Field(
         alias="surfaces",
         description="List of boundaries with the `SymmetryPlane` boundary condition imposed.",
     )

flow360/component/simulation/models/volume_models.py

@@ -57,7 +57,6 @@
     Box,
     CustomVolume,
     Cylinder,
-    EntityListWithCustomVolume,
     GenericVolume,
     SeedpointVolume,
 )
@@ -367,7 +366,7 @@ class Solid(PDEModelBase):
 
     name: Optional[str] = pd.Field(None, description="Name of the `Solid` model.")
     type: Literal["Solid"] = pd.Field("Solid", frozen=True)
-    entities: EntityListWithCustomVolume[GenericVolume, CustomVolume] = pd.Field(
+    entities: EntityList[GenericVolume, CustomVolume] = pd.Field(
         alias="volumes",
         description="The list of :class:`GenericVolume` or :class:`CustomVolume` "
         + "entities on which the heat transfer equation is solved. "
@@ -1244,7 +1243,7 @@ class Rotation(Flow360BaseModel):
 
     name: Optional[str] = pd.Field("Rotation", description="Name of the `Rotation` model.")
     type: Literal["Rotation"] = pd.Field("Rotation", frozen=True)
-    entities: EntityListWithCustomVolume[
+    entities: EntityList[
         GenericVolume, Cylinder, CustomVolume, SeedpointVolume, AxisymmetricBody
     ] = pd.Field(
         alias="volumes",
@@ -1357,15 +1356,13 @@ class PorousMedium(Flow360BaseModel):
 
     name: Optional[str] = pd.Field("Porous medium", description="Name of the `PorousMedium` model.")
     type: Literal["PorousMedium"] = pd.Field("PorousMedium", frozen=True)
-    entities: EntityListWithCustomVolume[GenericVolume, Box, CustomVolume, SeedpointVolume] = (
-        pd.Field(
-            alias="volumes",
-            description="The entity list for the `PorousMedium` model. "
-            + "The entity should be defined by :class:`Box`, zones from the geometry/volume mesh or"
-            + "by :class:`SeedpointVolume` when using snappyHexMeshing."
-            + "The axes of entity must be specified to serve as the the principle axes of the "
-            + "porous medium material model.",
-        )
+    entities: EntityList[GenericVolume, Box, CustomVolume, SeedpointVolume] = pd.Field(
+        alias="volumes",
+        description="The entity list for the `PorousMedium` model. "
+        + "The entity should be defined by :class:`Box`, zones from the geometry/volume mesh or"
+        + "by :class:`SeedpointVolume` when using snappyHexMeshing."
+        + "The axes of entity must be specified to serve as the the principle axes of the "
+        + "porous medium material model.",
     )
 
     darcy_coefficient: InverseAreaType.Point = pd.Field(

flow360/component/simulation/outputs/outputs.py

@@ -17,10 +17,7 @@
 from flow360.component.simulation.framework.expressions import StringExpression
 from flow360.component.simulation.framework.param_utils import serialize_model_obj_to_id
 from flow360.component.simulation.framework.unique_list import UniqueItemList
-from flow360.component.simulation.models.surface_models import (
-    EntityListAllowingGhost,
-    Wall,
-)
+from flow360.component.simulation.models.surface_models import Wall
 from flow360.component.simulation.models.volume_models import (
     ActuatorDisk,
     BETDisk,
@@ -339,7 +336,7 @@ class SurfaceOutput(_AnimationAndFileFormatSettings, _OutputBase):
     # TODO: entities is None --> use all surfaces. This is not implemented yet.
 
     name: Optional[str] = pd.Field("Surface output", description="Name of the `SurfaceOutput`.")
-    entities: EntityListAllowingGhost[  # pylint: disable=duplicate-code
+    entities: EntityList[  # pylint: disable=duplicate-code
         Surface,
         MirroredSurface,
         GhostSurface,
@@ -681,7 +678,7 @@ class SurfaceIntegralOutput(_OutputBase):
     """
 
     name: str = pd.Field("Surface integral output", description="Name of integral.")
-    entities: EntityListAllowingGhost[  # pylint: disable=duplicate-code
+    entities: EntityList[  # pylint: disable=duplicate-code
         Surface,
         MirroredSurface,
         GhostSurface,
@@ -1336,9 +1333,7 @@ class AeroAcousticOutput(Flow360BaseModel):
         + "input.",
     )
     permeable_surfaces: Optional[
-        EntityListAllowingGhost[
-            Surface, GhostSurface, GhostCircularPlane, GhostSphere, WindTunnelGhostSurface
-        ]
+        EntityList[Surface, GhostSurface, GhostCircularPlane, GhostSphere, WindTunnelGhostSurface]
     ] = pd.Field(
         None, description="List of permeable surfaces. Left empty if `patch_type` is solid"
     )