Source code for flow360.component.simulation.meshing_param.edge_params

"""Edge based meshing parameters for meshing."""

from typing import Literal, Optional, Union

import pydantic as pd

from flow360.component.simulation.framework.base_model import Flow360BaseModel
from flow360.component.simulation.framework.entity_base import EntityList
from flow360.component.simulation.primitives import Edge
from flow360.component.simulation.unit_system import AngleType, LengthType
from flow360.component.simulation.validation.validation_context import (
    ParamsValidationInfo,
    contextual_model_validator,
)




class AngleBasedRefinement(Flow360BaseModel):
    """
    Surface edge refinement by specifying curvature resolution angle.

    Example
    -------

      >>> fl.AngleBasedRefinement(value=8*fl.u.deg)

    ====
    """

    type: Literal["angle"] = pd.Field("angle", frozen=True)
    value: AngleType = pd.Field()





class HeightBasedRefinement(Flow360BaseModel):
    """
    Surface edge refinement by specifying first layer height of the anisotropic layers.

    Example
    -------

      >>> fl.HeightBasedRefinement(value=1e-4*fl.u.m)

    ====
    """

    type: Literal["height"] = pd.Field("height", frozen=True)
    # pylint: disable=no-member
    value: LengthType.Positive = pd.Field()





class AspectRatioBasedRefinement(Flow360BaseModel):
    """
    Surface edge refinement by specifying maximum aspect ratio of the anisotropic cells.

    Example
    -------

      >>> fl.AspectRatioBasedRefinement(value=10)

    ====
    """

    type: Literal["aspectRatio"] = pd.Field("aspectRatio", frozen=True)
    value: pd.PositiveFloat = pd.Field()





class ProjectAnisoSpacing(Flow360BaseModel):
    """
    Project the anisotropic spacing from neighboring faces to the edge.

    Example
    -------

      >>> fl.ProjectAnisoSpacing()

    ====
    """

    type: Literal["projectAnisoSpacing"] = pd.Field("projectAnisoSpacing", frozen=True)





class SurfaceEdgeRefinement(Flow360BaseModel):
    """
    Setting for growing anisotropic layers orthogonal to the specified `Edge` (s).

    Example
    -------

      >>> fl.SurfaceEdgeRefinement(
      ...     edges=[geometry["edge1"], geometry["edge2"]],
      ...     method=fl.HeightBasedRefinement(value=1e-4)
      ... )

    ====
    """

    name: Optional[str] = pd.Field("Surface edge refinement")
    refinement_type: Literal["SurfaceEdgeRefinement"] = pd.Field(
        "SurfaceEdgeRefinement", frozen=True
    )
    entities: EntityList[Edge] = pd.Field(alias="edges")
    method: Union[
        AngleBasedRefinement,
        HeightBasedRefinement,
        AspectRatioBasedRefinement,
        ProjectAnisoSpacing,
    ] = pd.Field(
        discriminator="type",
        description="Method for determining the spacing. See :class:`AngleBasedRefinement`,"
        " :class:`HeightBasedRefinement`, :class:`AspectRatioBasedRefinement`, :class:`ProjectAnisoSpacing`",
    )

    @contextual_model_validator(mode="after")
    def ensure_not_geometry_ai(self, param_info: ParamsValidationInfo):
        """Ensure that geometry AI is disabled when using this feature."""
        if param_info.use_geometry_AI:
            raise ValueError("SurfaceEdgeRefinement is not currently supported with geometry AI.")
        return self