Add structured box region to volume meshing params (#1463)

Author: shreyas-flex

flow360/__init__.py

@@ -33,6 +33,7 @@
     AxisymmetricRefinement,
     RotationCylinder,
     RotationVolume,
+    StructuredBoxRefinement,
     UniformRefinement,
     UserDefinedFarfield,
 )
@@ -198,6 +199,7 @@
     "SurfaceRefinement",
     "AutomatedFarfield",
     "AxisymmetricRefinement",
+    "StructuredBoxRefinement",
     "RotationCylinder",
     "RotationVolume",
     "UniformRefinement",

flow360/component/simulation/meshing_param/params.py

@@ -20,6 +20,7 @@
     AxisymmetricRefinement,
     RotationCylinder,
     RotationVolume,
+    StructuredBoxRefinement,
     UniformRefinement,
     UserDefinedFarfield,
 )
@@ -42,6 +43,7 @@
         BoundaryLayer,
         PassiveSpacing,
         UniformRefinement,
+        StructuredBoxRefinement,
         AxisymmetricRefinement,
     ],
     pd.Field(discriminator="refinement_type"),
@@ -334,6 +336,14 @@ def _check_no_reused_volume_entities(self) -> Self:
         | UniformRefinement      |          YES           |           NO           |           NO           |
         +------------------------+------------------------+------------------------+------------------------+
 
+        +------------------------+------------------------+------------------------+
+        |                        |StructuredBoxRefinement | UniformRefinement      |
+        +------------------------+------------------------+------------------------+
+        |StructuredBoxRefinement |          NO            |           --           |
+        +------------------------+------------------------+------------------------+
+        | UniformRefinement      |          NO            |           NO           |
+        +------------------------+------------------------+------------------------+
+
         """
 
         usage = EntityUsageMap()
@@ -347,7 +357,10 @@ def _check_no_reused_volume_entities(self) -> Self:
                 ]
 
         for refinement in self.refinements if self.refinements is not None else []:
-            if isinstance(refinement, (UniformRefinement, AxisymmetricRefinement)):
+            if isinstance(
+                refinement,
+                (UniformRefinement, AxisymmetricRefinement, StructuredBoxRefinement),
+            ):
                 # pylint: disable=protected-access
                 _ = [
                     usage.add_entity_usage(item, refinement.refinement_type)

flow360/component/simulation/meshing_param/volume_params.py

@@ -52,6 +52,63 @@ class UniformRefinement(Flow360BaseModel):
     spacing: LengthType.Positive = pd.Field(description="The required refinement spacing.")
 
 
+class StructuredBoxRefinement(Flow360BaseModel):
+    """
+    - The mesh inside the :class:`StructuredBoxRefinement` is semi-structured.
+    - The :class:`StructuredBoxRefinement` cannot enclose/intersect with other objects.
+    - The spacings along the three box axes can be adjusted independently.
+
+    Example
+    -------
+
+    >>> StructuredBoxRefinement(
+    ...     entities=[
+    ...        Box.from_principal_axes(
+    ...           name="boxRefinement",
+    ...           center=(0, 1, 1) * fl.u.cm,
+    ...           size=(1, 2, 1) * fl.u.cm,
+    ...           axes=((2, 2, 0), (-2, 2, 0)),
+    ...       )
+    ...     ],
+    ...     spacing_axis1=7.5*u.cm,
+    ...     spacing_axis2=10*u.cm,
+    ...     spacing_normal=15*u.cm,
+    ...   )
+    ====
+    """
+
+    # pylint: disable=no-member
+    # pylint: disable=too-few-public-methods
+    name: Optional[str] = pd.Field("StructuredBoxRefinement")
+    refinement_type: Literal["StructuredBoxRefinement"] = pd.Field(
+        "StructuredBoxRefinement", frozen=True
+    )
+    entities: EntityList[Box] = pd.Field()
+
+    spacing_axis1: LengthType.Positive = pd.Field(
+        description="Spacing along the first axial direction."
+    )
+    spacing_axis2: LengthType.Positive = pd.Field(
+        description="Spacing along the second axial direction."
+    )
+    spacing_normal: LengthType.Positive = pd.Field(
+        description="Spacing along the normal axial direction."
+    )
+
+    @pd.model_validator(mode="after")
+    def _validate_only_in_beta_mesher(self):
+        """
+        Ensure that StructuredBoxRefinement objects are only processed with the beta mesher.
+        """
+        validation_info = get_validation_info()
+        if validation_info is None:
+            return self
+        if validation_info.is_beta_mesher:
+            return self
+
+        raise ValueError("`StructuredBoxRefinement` is only supported with the beta mesher.")
+
+
 class AxisymmetricRefinementBase(Flow360BaseModel, metaclass=ABCMeta):
     """Base class for all refinements that requires spacing in axial, radial and circumferential directions."""
 
@@ -149,11 +206,12 @@ class RotationVolume(AxisymmetricRefinementBase):
     type: Literal["RotationVolume"] = pd.Field("RotationVolume", frozen=True)
     name: Optional[str] = pd.Field("Rotation Volume", description="Name to display in the GUI.")
     entities: EntityList[Cylinder, AxisymmetricBody] = pd.Field()
-    enclosed_entities: Optional[EntityList[Cylinder, Surface, AxisymmetricBody]] = pd.Field(
+    enclosed_entities: Optional[EntityList[Cylinder, Surface, AxisymmetricBody, Box]] = pd.Field(
         None,
         description="Entities enclosed by :class:`RotationVolume`. "
-        + "Can be `Surface` and/or other :class:`~flow360.Cylinder`(s)"
-        "and/or other :class:`~flow360.AxisymmetricBody`(s).",
+        "Can be `Surface` and/or other :class:`~flow360.Cylinder`(s)"
+        "and/or other :class:`~flow360.AxisymmetricBody`(s)"
+        "and/or other :class:`~flow360.Box`(s)",
     )
 
     @pd.field_validator("entities", mode="after")
@@ -196,6 +254,28 @@ def _validate_cylinder_name_length(cls, values):
                 )
         return values
 
+    @pd.field_validator("enclosed_entities", mode="after")
+    @classmethod
+    def _validate_enclosed_box_only_in_beta_mesher(cls, values):
+        """
+        Check the name length for the cylinder entities due to the 32-character
+        limitation of all data structure names and labels in CGNS format.
+        The current prefix is 'rotatingBlock-' with 14 characters.
+        """
+        validation_info = get_validation_info()
+        if validation_info is None:
+            return values
+        if validation_info.is_beta_mesher:
+            return values
+
+        for entity in values.stored_entities:
+            if isinstance(entity, Box):
+                raise ValueError(
+                    "`Box` entity in `RotationVolume.enclosed_entities` is only supported with the beta mesher."
+                )
+
+        return values
+
     @pd.field_validator("entities", mode="after")
     @classmethod
     def _validate_axisymmetric_only_in_beta_mesher(cls, values):

flow360/component/simulation/translator/volume_meshing_translator.py

@@ -12,6 +12,7 @@
     AxisymmetricRefinementBase,
     RotationCylinder,
     RotationVolume,
+    StructuredBoxRefinement,
     UniformRefinement,
     UserDefinedFarfield,
 )
@@ -31,6 +32,8 @@
 from flow360.component.simulation.utils import is_exact_instance
 from flow360.exceptions import Flow360TranslationError
 
+# pylint: disable=too-many-locals
+
 
 def uniform_refinement_translator(obj: UniformRefinement):
     """
@@ -51,6 +54,17 @@ def cylindrical_refinement_translator(obj: AxisymmetricRefinementBase):
     }
 
 
+def box_refinement_translator(obj: StructuredBoxRefinement):
+    """
+    Translate StructuredBoxRefinement spacings
+    """
+    return {
+        "spacingAxis1": obj.spacing_axis1.value.item(),
+        "spacingAxis2": obj.spacing_axis2.value.item(),
+        "spacingNormal": obj.spacing_normal.value.item(),
+    }
+
+
 def boundary_layer_translator(obj: BoundaryLayer):
     """
     Translate BoundaryLayer.
@@ -100,6 +114,8 @@ def rotation_volume_translator(obj: RotationVolume, rotor_disk_names: list):
                     setting["enclosedObjects"].append("slidingInterface-" + entity.name)
             elif is_exact_instance(entity, AxisymmetricBody):
                 setting["enclosedObjects"].append("slidingInterface-" + entity.name)
+            elif is_exact_instance(entity, Box):
+                setting["enclosedObjects"].append("structuredBox-" + entity.name)
             elif is_exact_instance(entity, Surface):
                 setting["enclosedObjects"].append(entity.name)
     return setting
@@ -126,6 +142,25 @@ def refinement_entity_injector(entity_obj):
     return {}
 
 
+def refinement_entity_box_with_axes_injector(entity_obj: Box):
+    """Injector for Box entity in StructuredBoxRefinement."""
+    lengths = list(entity_obj.size.value)
+
+    axis1 = entity_obj.axes[0]
+    axis2 = entity_obj.axes[1]
+
+    return {
+        "name": entity_obj.name,
+        "type": "box",
+        "lengthAxis1": lengths[0],
+        "lengthAxis2": lengths[1],
+        "lengthNormal": lengths[2],
+        "axis1": list(axis1),
+        "axis2": list(axis2),
+        "center": list(entity_obj.center.value),
+    }
+
+
 def rotor_disks_entity_injector(entity: Cylinder):
     """Injector for Cylinder entity in AxisymmetricRefinement."""
 
@@ -284,6 +319,14 @@ def get_volume_meshing_json(input_params: SimulationParams, mesh_units):
         to_list=True,
         entity_injection_func=rotor_disks_entity_injector,
     )
+    structured_box_refinement = translate_setting_and_apply_to_all_entities(
+        meshing_params.refinements,
+        StructuredBoxRefinement,
+        box_refinement_translator,
+        to_list=True,
+        entity_injection_func=refinement_entity_box_with_axes_injector,
+    )
+
     if uniform_refinement_list:
         translated["refinement"] = []
         translated["refinement"].extend(uniform_refinement_list)
@@ -294,6 +337,10 @@ def get_volume_meshing_json(input_params: SimulationParams, mesh_units):
         translated["rotorDisks"].extend(rotor_disk_refinement)
         rotor_disk_names = [item["name"] for item in rotor_disk_refinement]
 
+    if structured_box_refinement:
+        translated["structuredRegions"] = []
+        translated["structuredRegions"].extend(structured_box_refinement)
+
     faces_aniso_setting = translate_setting_and_apply_to_all_entities(
         meshing_params.refinements,
         BoundaryLayer,