feat(): Added bodies_face_edge_ids and also property functions to replace existing face/edge/body_ids (#1671)

Author: benflexcompute

.pre-commit-config.yaml

@@ -479,10 +479,10 @@ def _get_used_tags(model: Flow360BaseModel, target_entity_type, used_tags: set):
         (Surface, "face_group_tag"),
     ]
 
-    if entity_info.edge_ids:
+    if entity_info.all_edge_ids:
         entity_types.append((Edge, "edge_group_tag"))
 
-    if entity_info.body_ids:
+    if entity_info.all_body_ids:
         entity_types.append((GeometryBodyGroup, "body_group_tag"))
 
     for entity_type, entity_grouping_tags in entity_types:

flow360/component/project_utils.py

@@ -2,7 +2,7 @@
 
 from abc import ABCMeta, abstractmethod
 from collections import defaultdict
-from typing import Annotated, List, Literal, Optional, Union
+from typing import Annotated, Dict, List, Literal, Optional, Union
 
 import pydantic as pd
 
@@ -84,11 +84,31 @@ def get_persistent_entity_registry(self, internal_registry, **kwargs):
         """
 
 
+class BodyComponentInfo(Flow360BaseModel):
+    """Data model for body component info."""
+
+    face_ids: list[str] = pd.Field(
+        description="A full list of face IDs that appear in the body.",
+    )
+    edge_ids: Optional[list[str]] = pd.Field(
+        None,
+        description="A full list of edge IDs that appear in the body. Optional for surface mesh geometry.",
+    )
+
+
 class GeometryEntityInfo(EntityInfoModel):
     """Data model for geometry entityInfo.json"""
 
     type_name: Literal["GeometryEntityInfo"] = pd.Field("GeometryEntityInfo", frozen=True)
 
+    bodies_face_edge_ids: Optional[Dict[str, BodyComponentInfo]] = pd.Field(
+        None,
+        description="Mapping from body ID to the face and edge IDs of the body.",
+    )
+    # bodies_face_edge_ids: Mostly just used by front end. On python side this
+    # is less useful as users do not operate on face/body/edge IDs directly.
+    # But at least this can replace `face_ids`, `body_ids`, and `edge_ids` since these contains less info.
+
     body_ids: list[str] = pd.Field(
         [],
         description="A full list of body IDs that appear in the geometry.",
@@ -155,6 +175,45 @@ class GeometryEntityInfo(EntityInfoModel):
         description="The default value based on uploaded geometry for geometry_accuracy.",
     )
 
+    @property
+    def all_face_ids(self) -> list[str]:
+        """
+        Returns a full list of face IDs that appear in the geometry.
+        Use `bodies_face_edge_ids` if available, otherwise fall back to use `face_ids`.
+        """
+        if self.bodies_face_edge_ids is not None:
+            return [
+                face_id
+                for body_component_info in self.bodies_face_edge_ids.values()
+                for face_id in body_component_info.face_ids
+            ]
+        return self.face_ids
+
+    @property
+    def all_edge_ids(self) -> list[str]:
+        """
+        Returns a full list of edge IDs that appear in the geometry.
+        Use `bodies_face_edge_ids` if available, otherwise fall back to use `edge_ids`.
+        """
+        if self.bodies_face_edge_ids is not None:
+            return [
+                edge_id
+                for body_component_info in self.bodies_face_edge_ids.values()
+                # edge_ids can be None for surface-only geometry; treat it as an empty list.
+                for edge_id in (body_component_info.edge_ids or [])
+            ]
+        return self.edge_ids
+
+    @property
+    def all_body_ids(self) -> list[str]:
+        """
+        Returns a full list of body IDs that appear in the geometry.
+        Use `bodies_face_edge_ids` if available, otherwise fall back to use `body_ids`.
+        """
+        if self.bodies_face_edge_ids is not None:
+            return list(self.bodies_face_edge_ids.keys())
+        return self.body_ids
+
     def group_in_registry(
         self,
         entity_type_name: Literal["face", "edge", "body", "snappy_body"],
@@ -420,7 +479,7 @@ def get_persistent_entity_registry(self, internal_registry, **_) -> EntityRegist
                 "face", face_group_tag, registry=internal_registry
             )
 
-            if len(self.edge_ids) > 0:
+            if len(self.all_edge_ids) > 0:
                 if self.edge_group_tag is None:
                     edge_group_tag = self._get_default_grouping_tag("edge")
                     log.info(f"Using `{edge_group_tag}` as default grouping for edges.")
@@ -467,7 +526,7 @@ def create_group_to_sub_component_mapping(group):
             # This likely means the geometry asset is pre-25.5.
             raise ValueError(
                 "Geometry cloud resource is too old."
-                " Please consider re-uploading the geometry with newer solver version."
+                " Please consider re-uploading the geometry with newer solver version (>25.5)."
             )
 
         face_group_by_body_id_to_face = create_group_to_sub_component_mapping(

flow360/component/simulation/entity_info.py

@@ -292,7 +292,7 @@ def snappy_mesher_json(input_params: SimulationParams):
 
     # extract geometry information in body: {patch0, ...} format
     bodies = {}
-    for face_id in input_params.private_attribute_asset_cache.project_entity_info.face_ids:
+    for face_id in input_params.private_attribute_asset_cache.project_entity_info.all_face_ids:
         solid = face_id.split("::")
         if solid[0] not in bodies:
             bodies[solid[0]] = set()
@@ -549,7 +549,7 @@ def legacy_mesher_json(input_params: SimulationParams):
         input_params.private_attribute_asset_cache.project_entity_info, GeometryEntityInfo
     )
 
-    for face_id in input_params.private_attribute_asset_cache.project_entity_info.face_ids:
+    for face_id in input_params.private_attribute_asset_cache.project_entity_info.all_face_ids:
         if face_id not in face_config:
             face_config[face_id] = {"maxEdgeLength": default_max_edge_length}
 

flow360/component/simulation/translator/surface_meshing_translator.py

@@ -2,5 +2,5 @@
 version
 """
 
-__version__ = "25.8.1b1"
+__version__ = "25.8.2b1"
 __solver_version__ = "release-25.8"

flow360/version.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "flow360"
-version = "v25.8.1b1"
+version = "v25.8.2b1"
 description = "Flow360 Python Client"
 authors = ["Flexcompute <[email protected]>"]
 

pyproject.toml

@@ -1,5 +1,5 @@
 {
-    "version": "25.8.1b1",
+    "version": "25.8.2b1",
     "unit_system": {
         "name": "SI"
     },

tests/ref/simulation/service_init_geometry.json

@@ -1,5 +1,5 @@
 {
-    "version": "25.8.1b1",
+    "version": "25.8.2b1",
     "unit_system": {
         "name": "SI"
     },

tests/ref/simulation/service_init_surface_mesh.json

@@ -1,5 +1,5 @@
 {
-    "version": "25.8.1b1",
+    "version": "25.8.2b1",
     "unit_system": {
         "name": "SI"
     },

tests/ref/simulation/service_init_volume_mesh.json

@@ -1,5 +1,5 @@
 {
-    "version": "25.8.1b1",
+    "version": "25.8.2b1",
     "unit_system": {
         "name": "SI"
     },