Add geometry refinement and other GAI related options (#1355)

* Add geometry refinement and other GAI related options

* Fix formatting

* Added geometry refinement explicit cast

* Fix some comments

* Fix black

* Address more comments

* Finish adding unit tests

* Fix lint and isort

* Address comments

* Fix json reference unit test failures

---------

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

Author: chai-flex

flow360/cloud/flow360_requests.py

@@ -160,6 +160,7 @@ class _Resource(Flow360RequestsV2):
 
 class NewReportRequest(Flow360RequestsV2):
     "New report request"
+
     name: str
     resources: List[_Resource]
     config_json: str

flow360/cloud/utils.py

@@ -1,5 +1,4 @@
-"""utils for cloud operations
-"""
+"""utils for cloud operations"""
 
 from enum import Enum
 

flow360/component/constants.py

@@ -1,5 +1,4 @@
-"""Constants file
-"""
+"""Constants file"""
 
 
 # pylint: disable=invalid-name,too-few-public-methods

flow360/component/interfaces.py

@@ -1,5 +1,4 @@
-"""webAPI interface definitions
-"""
+"""webAPI interface definitions"""
 
 from typing import Union
 

flow360/component/simulation/meshing_param/face_params.py

@@ -46,6 +46,47 @@ def ensure_surface_existence(cls, value):
         return check_deleted_surface_in_entity_list(value)
 
 
+class GeometryRefinement(Flow360BaseModel):
+    """
+    Setting for refining surface elements for given `Surface`.
+
+    Example
+    -------
+
+      >>> fl.GeometryRefinement(
+      ...     faces=[geometry["face1"], geometry["face2"]],
+      ...     geometry_accuracy=0.001*fl.u.m
+      ... )
+
+    ====
+    """
+
+    name: Optional[str] = pd.Field("Surface refinement")
+    refinement_type: Literal["GeometryRefinement"] = pd.Field("GeometryRefinement", frozen=True)
+    entities: EntityList[Surface] = pd.Field(alias="faces")
+    # pylint: disable=no-member
+
+    geometry_accuracy: LengthType.Positive = pd.Field(
+        description="The smallest length scale that will be resolved accurately by the surface meshing process. "
+    )
+
+    @pd.field_validator("entities", mode="after")
+    @classmethod
+    def ensure_surface_existence(cls, value):
+        """Ensure all boundaries will be present after mesher"""
+        return check_deleted_surface_in_entity_list(value)
+
+    @pd.model_validator(mode="after")
+    def ensure_geometry_ai(self):
+        """Ensure feature is only activated with geometry AI enabled."""
+        validation_info = get_validation_info()
+        if validation_info is None:
+            return self
+        if not validation_info.use_geometry_AI:
+            raise ValueError("GeometryRefinement is only supported by geometry AI.")
+        return self
+
+
 class PassiveSpacing(Flow360BaseModel):
     """
     Passively control the mesh spacing either through adjecent `Surface`'s meshing

flow360/component/simulation/meshing_param/params.py

@@ -11,6 +11,7 @@
 from flow360.component.simulation.meshing_param.edge_params import SurfaceEdgeRefinement
 from flow360.component.simulation.meshing_param.face_params import (
     BoundaryLayer,
+    GeometryRefinement,
     PassiveSpacing,
     SurfaceRefinement,
 )
@@ -35,6 +36,7 @@
     Union[
         SurfaceEdgeRefinement,
         SurfaceRefinement,
+        GeometryRefinement,
         BoundaryLayer,
         PassiveSpacing,
         UniformRefinement,
@@ -70,7 +72,8 @@ class MeshingDefaults(Flow360BaseModel):
     geometry_accuracy: Optional[LengthType.Positive] = pd.Field(
         None,
         description="The smallest length scale that will be resolved accurately by the surface meshing process. "
-        "This parameter is only valid when using geometry AI.",
+        "This parameter is only valid when using geometry AI."
+        "It can be overridden with class: ~flow360.GeometryRefinement.",
     )
 
     ##::   Default surface edge settings
@@ -105,7 +108,7 @@ class MeshingDefaults(Flow360BaseModel):
         " This is only supported by the beta mesher and can not be overridden per face.",
     )
 
-    planar_face_tolerance: pd.NonNegativeFloat = pd.Field(
+    planar_face_tolerance: Optional[pd.NonNegativeFloat] = pd.Field(
         DEFAULT_PLANAR_FACE_TOLERANCE,
         description="Tolerance used for detecting planar faces in the input surface mesh / geometry"
         " that need to be remeshed, such as symmetry planes."
@@ -121,7 +124,21 @@ class MeshingDefaults(Flow360BaseModel):
         " This can be overridden with :class:`~flow360.SurfaceRefinement`.",
         context=SURFACE_MESH,
     )
-    curvature_resolution_angle: AngleType.Positive = ContextField(
+
+    surface_max_aspect_ratio: Optional[pd.PositiveFloat] = ConditionalField(
+        10.0,
+        description="Maximum aspect ratio for surface cells for the GAI surface mesher."
+        " This cannot be overridden per face",
+        context=SURFACE_MESH,
+    )
+
+    surface_max_adaptation_iterations: Optional[pd.NonNegativeInt] = ConditionalField(
+        50,
+        description="Maximum adaptation iterations for the GAI surface mesher.",
+        context=SURFACE_MESH,
+    )
+
+    curvature_resolution_angle: Optional[AngleType.Positive] = ContextField(
         12 * u.deg,
         description=(
             "Default maximum angular deviation in degrees. This value will restrict:"
@@ -161,6 +178,24 @@ def invalid_geometry_accuracy(cls, value):
             raise ValueError("Geometry accuracy is required when geometry AI is used.")
         return value
 
+    @pd.field_validator(
+        "surface_max_aspect_ratio", "surface_max_adaptation_iterations", mode="after"
+    )
+    @classmethod
+    def invalid_geometry_ai_features(cls, value, info):
+        """Ensure surface max aspect ratio is not specified when GAI is not used"""
+        validation_info = get_validation_info()
+
+        if validation_info is None:
+            return value
+
+        # pylint: disable=unsubscriptable-object
+        default_value = cls.model_fields[info.field_name].default
+        if value != default_value and not validation_info.use_geometry_AI:
+            raise ValueError(f"{info.field_name} is only supported when geometry AI is used.")
+
+        return value
+
 
 class MeshingParams(Flow360BaseModel):
     """
@@ -200,6 +235,7 @@ class MeshingParams(Flow360BaseModel):
         + "and first layer thickness will be adjusted to generate `r`-times"
         + " finer mesh where r is the refinement_factor value.",
     )
+
     gap_treatment_strength: Optional[float] = ContextField(
         default=0,
         ge=0,

flow360/component/simulation/models/solver_numerics.py

@@ -2,7 +2,7 @@
 Contains basic components(solvers) that composes the `volume` type models.
 Each volume model represents a physical phenomena that require a combination of solver features to model.
 
-E.g. 
+E.g.
 NavierStokes, turbulence and transition composes FluidDynamics `volume` type
 
 """

flow360/component/simulation/operating_condition/atmosphere_model.py

@@ -1,7 +1,7 @@
-""" U.S. STANDARD ATMOSPHERE 1976
+"""U.S. STANDARD ATMOSPHERE 1976
 # https://www.ngdc.noaa.gov/stp/space-weather/online-publications/miscellaneous/us-standard-atmosphere-1976/us-standard-atmosphere_st76-1562_noaa.pdf
  Source: design 360
- """
+"""
 
 from math import exp
 

flow360/component/simulation/primitives.py

@@ -166,6 +166,11 @@ class GeometryBodyGroup(EntityBase):
     transformation: Transformation = pd.Field(
         Transformation(), description="The transformation performed on the body group"
     )
+    mesh_exterior: bool = pd.Field(
+        True,
+        description="Option to define whether to mesh exterior or interior of body group in geometry AI."
+        "Note that this is a beta feature and the interface might change in future releases.",
+    )
 
 
 class _VolumeEntityBase(EntityBase, metaclass=ABCMeta):

flow360/component/types.py

@@ -1,4 +1,4 @@
-""" Defines 'types' that various fields can be """
+"""Defines 'types' that various fields can be"""
 
 from typing import List, Optional, Tuple