Merge branch 'main' into develop

Author: benflexcompute

flow360/__init__.py

@@ -135,7 +135,12 @@
     UserDefinedField,
     VolumeOutput,
 )
-from flow360.component.simulation.primitives import Box, Cylinder, ReferenceGeometry
+from flow360.component.simulation.primitives import (
+    Box,
+    CustomVolume,
+    Cylinder,
+    ReferenceGeometry,
+)
 from flow360.component.simulation.simulation_params import SimulationParams
 from flow360.component.simulation.time_stepping.time_stepping import (
     AdaptiveCFL,
@@ -169,6 +174,7 @@
     "GeometryRefinement",
     "Env",
     "Case",
+    "CustomVolume",
     "AngleBasedRefinement",
     "AspectRatioBasedRefinement",
     "ProjectAnisoSpacing",

flow360/component/project_utils.py

@@ -22,6 +22,7 @@
 )
 from flow360.component.simulation.primitives import (
     Box,
+    CustomVolume,
     Cylinder,
     Edge,
     GeometryBodyGroup,
@@ -223,7 +224,7 @@ def _set_up_params_non_persistent_entity_info(entity_info, params: SimulationPar
 
     entity_registry = params.used_entity_registry
     # Creating draft entities
-    for draft_type in [Box, Cylinder, Point, PointArray, PointArray2D, Slice]:
+    for draft_type in [Box, Cylinder, Point, PointArray, PointArray2D, Slice, CustomVolume]:
         draft_entities = entity_registry.find_by_type(draft_type)
         for draft_entity in draft_entities:
             if draft_entity not in entity_info.draft_entities:

flow360/component/simulation/meshing_param/params.py

@@ -22,6 +22,7 @@
     UniformRefinement,
     UserDefinedFarfield,
 )
+from flow360.component.simulation.primitives import CustomVolume
 from flow360.component.simulation.unit_system import AngleType, LengthType
 from flow360.component.simulation.validation.validation_context import (
     SURFACE_MESH,
@@ -46,7 +47,8 @@
 ]
 
 VolumeZonesTypes = Annotated[
-    Union[RotationCylinder, AutomatedFarfield, UserDefinedFarfield], pd.Field(discriminator="type")
+    Union[RotationCylinder, AutomatedFarfield, UserDefinedFarfield, CustomVolume],
+    pd.Field(discriminator="type"),
 ]
 
 
@@ -317,6 +319,25 @@ def _check_volume_zones_has_farfied(cls, v):
 
         return v
 
+    @pd.field_validator("volume_zones", mode="after")
+    @classmethod
+    def _check_volume_zones_have_unique_names(cls, v):
+        """Ensure there won't be duplicated volume zone names."""
+
+        if v is None:
+            return v
+        to_be_generated_volume_zone_names = set()
+        for volume_zone in v:
+            if not isinstance(volume_zone, CustomVolume):
+                continue
+            if volume_zone.name in to_be_generated_volume_zone_names:
+                raise ValueError(
+                    f"Multiple CustomVolume with the same name `{volume_zone.name}` are not allowed."
+                )
+            to_be_generated_volume_zone_names.add(volume_zone.name)
+
+        return v
+
     @pd.model_validator(mode="after")
     def _check_no_reused_volume_entities(self) -> Self:
         """

flow360/component/simulation/primitives.py

@@ -18,14 +18,21 @@
     rotation_matrix_from_axis_and_angle,
 )
 from flow360.component.simulation.framework.base_model import Flow360BaseModel
-from flow360.component.simulation.framework.entity_base import EntityBase, generate_uuid
+from flow360.component.simulation.framework.entity_base import (
+    EntityBase,
+    EntityList,
+    generate_uuid,
+)
 from flow360.component.simulation.framework.multi_constructor_model_base import (
     MultiConstructorBaseModel,
 )
 from flow360.component.simulation.framework.unique_list import UniqueStringList
 from flow360.component.simulation.unit_system import AngleType, AreaType, LengthType
 from flow360.component.simulation.user_code.core.types import ValueOrExpression
 from flow360.component.simulation.utils import BoundingBoxType, model_attribute_unlock
+from flow360.component.simulation.validation.validation_context import (
+    get_validation_info,
+)
 from flow360.component.types import Axis
 from flow360.exceptions import Flow360BoundaryMissingError
 
@@ -467,7 +474,7 @@ def _will_be_deleted_by_mesher(
         # pylint: disable=too-many-arguments, too-many-return-statements
         self,
         at_least_one_body_transformed: bool,
-        farfield_method: Optional[Literal["auto", "quasi-3d"]],
+        farfield_method: Optional[Literal["auto", "quasi-3d", "user-defined"]],
         global_bounding_box: Optional[BoundingBoxType],
         planar_face_tolerance: Optional[float],
         half_model_symmetry_plane_center_y: Optional[float],
@@ -486,6 +493,10 @@ def _will_be_deleted_by_mesher(
             # VolumeMesh or Geometry/SurfaceMesh with legacy schema.
             return False
 
+        if farfield_method == "user-defined":
+            # Not applicable to user defined farfield
+            return False
+
         length_tolerance = global_bounding_box.largest_dimension * planar_face_tolerance
 
         if farfield_method == "auto":
@@ -635,4 +646,38 @@ def __str__(self):
         return ",".join(sorted([self.pair[0].name, self.pair[1].name]))
 
 
-VolumeEntityTypes = Union[GenericVolume, Cylinder, Box, str]
+@final
+class CustomVolume(_VolumeEntityBase):
+    """
+    CustomVolume is a volume zone defined by its surrounding surfaces.
+    It will be generated by the volume mesher.
+    """
+
+    private_attribute_entity_type_name: Literal["CustomVolume"] = pd.Field(
+        "CustomVolume", frozen=True
+    )
+    type: Literal["CustomVolume"] = pd.Field("CustomVolume", frozen=True)
+    boundaries: EntityList[Surface] = pd.Field(
+        description="The surfaces that define the boundaries of the custom volume."
+    )
+    private_attribute_id: str = pd.Field(default_factory=generate_uuid, frozen=True)
+
+    @pd.field_validator("boundaries", mode="after")
+    @classmethod
+    def ensure_unique_boundary_names(cls, v):
+        """Check if the boundaries have different names within a CustomVolume."""
+        if len(v.stored_entities) != len({boundary.name for boundary in v.stored_entities}):
+            raise ValueError("The boundaries of a CustomVolume must have different names.")
+        return v
+
+    @pd.model_validator(mode="after")
+    def ensure_usable(self):
+        """Check if the beta mesher is enabled and that the user is using user defined farfield."""
+        validation_info = get_validation_info()
+        if validation_info is None:
+            return self
+        if validation_info.is_beta_mesher and validation_info.farfield_method == "user-defined":
+            return self
+        raise ValueError(
+            "CustomVolume is only supported when beta mesher and user defined farfield are enabled."
+        )

flow360/component/simulation/translator/volume_meshing_translator.py

@@ -12,7 +12,7 @@
     UniformRefinement,
     UserDefinedFarfield,
 )
-from flow360.component.simulation.primitives import Box, Cylinder, Surface
+from flow360.component.simulation.primitives import Box, CustomVolume, Cylinder, Surface
 from flow360.component.simulation.simulation_params import SimulationParams
 from flow360.component.simulation.translator.utils import (
     get_global_setting_from_first_instance,
@@ -140,8 +140,27 @@ def rotation_cylinder_entity_injector(entity: Cylinder):
     }
 
 
+def _get_custom_volumes(volume_zones: list):
+    """Get translated custom volumes from volume zones."""
+    custom_volumes = []
+    for zone in volume_zones:
+        if isinstance(zone, CustomVolume):
+            custom_volumes.append(
+                {
+                    "name": zone.name,
+                    "patches": sorted(
+                        [surface.name for surface in zone.boundaries.stored_entities]
+                    ),
+                }
+            )
+    if custom_volumes:
+        # Sort custom volumes by name
+        custom_volumes.sort(key=lambda x: x["name"])
+    return custom_volumes
+
+
 @preprocess_input
-# pylint: disable=unused-argument,too-many-branches
+# pylint: disable=unused-argument,too-many-branches,too-many-statements
 def get_volume_meshing_json(input_params: SimulationParams, mesh_units):
     """
     Get JSON for surface meshing.
@@ -285,4 +304,9 @@ def get_volume_meshing_json(input_params: SimulationParams, mesh_units):
     if sliding_interfaces:
         translated["slidingInterfaces"] = sliding_interfaces
 
+    ##::  Step 6: Get custom volumes
+    custom_volumes = _get_custom_volumes(meshing_params.volume_zones)
+    if custom_volumes:
+        translated["zones"] = custom_volumes
+
     return translated

flow360/component/simulation/user_defined_dynamics/user_defined_dynamics.py

@@ -126,7 +126,7 @@ def ensure_output_surface_existence(cls, value):
         # pylint: disable=protected-access
         if isinstance(value, Surface) and value._will_be_deleted_by_mesher(
             at_least_one_body_transformed=validation_info.at_least_one_body_transformed,
-            farfield_method=validation_info.auto_farfield_method,
+            farfield_method=validation_info.farfield_method,
             global_bounding_box=validation_info.global_bounding_box,
             planar_face_tolerance=validation_info.planar_face_tolerance,
             half_model_symmetry_plane_center_y=validation_info.half_model_symmetry_plane_center_y,

flow360/component/simulation/validation/validation_context.py

@@ -122,7 +122,7 @@ class ParamsValidationInfo:  # pylint:disable=too-few-public-methods,too-many-in
     """
 
     __slots__ = [
-        "auto_farfield_method",
+        "farfield_method",
         "is_beta_mesher",
         "use_geometry_AI",
         "using_liquid_as_material",
@@ -138,7 +138,7 @@ class ParamsValidationInfo:  # pylint:disable=too-few-public-methods,too-many-in
     ]
 
     @classmethod
-    def _get_auto_farfield_method_(cls, param_as_dict: dict):
+    def _get_farfield_method_(cls, param_as_dict: dict):
         volume_zones = None
         try:
             if param_as_dict["meshing"]:
@@ -150,6 +150,8 @@ def _get_auto_farfield_method_(cls, param_as_dict: dict):
             for zone in volume_zones:
                 if zone["type"] == "AutomatedFarfield":
                     return zone["method"]
+                if zone["type"] == "UserDefinedFarfield":
+                    return "user-defined"
         return None
 
     @classmethod
@@ -297,7 +299,7 @@ def _get_at_least_one_body_transformed(cls, param_as_dict: dict):  # pylint:disa
         return False
 
     def __init__(self, param_as_dict: dict, referenced_expressions: list):
-        self.auto_farfield_method = self._get_auto_farfield_method_(param_as_dict=param_as_dict)
+        self.farfield_method = self._get_farfield_method_(param_as_dict=param_as_dict)
         self.is_beta_mesher = self._get_is_beta_mesher_(param_as_dict=param_as_dict)
         self.use_geometry_AI = self._get_use_geometry_AI_(  # pylint:disable=invalid-name
             param_as_dict=param_as_dict

flow360/component/simulation/validation/validation_simulation_params.py

@@ -23,6 +23,7 @@
     TimeAverageSurfaceOutput,
     VolumeOutput,
 )
+from flow360.component.simulation.primitives import CustomVolume
 from flow360.component.simulation.time_stepping.time_stepping import Steady, Unsteady
 from flow360.component.simulation.utils import is_exact_instance
 from flow360.component.simulation.validation.validation_context import (
@@ -311,14 +312,17 @@ def _validate_cht_has_heat_transfer(params):
 
 def _check_complete_boundary_condition_and_unknown_surface(
     params,
-):  # pylint:disable=too-many-branches
+):  # pylint:disable=too-many-branches, too-many-locals
     ## Step 1: Get all boundaries patches from asset cache
     current_lvls = get_validation_levels() if get_validation_levels() else []
     if all(level not in current_lvls for level in (ALL, CASE)):
         return params
 
     validation_info = get_validation_info()
 
+    if not validation_info:
+        return params
+
     asset_boundary_entities = params.private_attribute_asset_cache.boundaries
 
     # Filter out the ones that will be deleted by mesher
@@ -359,6 +363,13 @@ def _check_complete_boundary_condition_and_unknown_surface(
                 if item.name != "symmetric"
             ]
 
+    potential_zone_zone_interfaces = set()
+    if validation_info.farfield_method == "user-defined":
+        for zones in params.meshing.volume_zones:
+            if isinstance(zones, CustomVolume):
+                for boundary in zones.boundaries.stored_entities:
+                    potential_zone_zone_interfaces.add(boundary.name)
+
     if asset_boundary_entities is None or asset_boundary_entities == []:
         raise ValueError("[Internal] Failed to retrieve asset boundaries")
 
@@ -388,7 +399,7 @@ def _check_complete_boundary_condition_and_unknown_surface(
             used_boundaries.add(entity.name)
 
     ## Step 3: Use set operations to find missing and unknown boundaries
-    missing_boundaries = asset_boundaries - used_boundaries
+    missing_boundaries = asset_boundaries - used_boundaries - potential_zone_zone_interfaces
     unknown_boundaries = used_boundaries - asset_boundaries
 
     if missing_boundaries:

flow360/component/simulation/validation/validation_utils.py

@@ -79,7 +79,7 @@ def check_deleted_surface_in_entity_list(value):
             surface, Surface
         ) and surface._will_be_deleted_by_mesher(  # pylint:disable=protected-access
             at_least_one_body_transformed=validation_info.at_least_one_body_transformed,
-            farfield_method=validation_info.auto_farfield_method,
+            farfield_method=validation_info.farfield_method,
             global_bounding_box=validation_info.global_bounding_box,
             planar_face_tolerance=validation_info.planar_face_tolerance,
             half_model_symmetry_plane_center_y=validation_info.half_model_symmetry_plane_center_y,
@@ -108,7 +108,7 @@ def check_deleted_surface_pair(value):
     for surface in value.pair:
         if surface._will_be_deleted_by_mesher(  # pylint:disable=protected-access
             at_least_one_body_transformed=validation_info.at_least_one_body_transformed,
-            farfield_method=validation_info.auto_farfield_method,
+            farfield_method=validation_info.farfield_method,
             global_bounding_box=validation_info.global_bounding_box,
             planar_face_tolerance=validation_info.planar_face_tolerance,
             half_model_symmetry_plane_center_y=validation_info.half_model_symmetry_plane_center_y,