flow360.PorousJump#

class PorousJump[source]#

Bases: Flow360BaseModel

PorousJump defines the Porous Jump boundary condition.

Example

  • Define a porous jump condition:

    >>> fl.PorousJump(
    ...     surface_pairs=[
    ...         (volume_mesh["blk-1/Interface-blk-2"], volume_mesh["blk-2/Interface-blk-1"]),
    ...         (volume_mesh["blk-1/Interface-blk-3"], volume_mesh["blk-3/Interface-blk-1"]),
    ...     ],
    ...    darcy_coefficient = 1e6 / fl.u.m **2,
    ...    forchheimer_coefficient = 1 / fl.u.m,
    ...    thickness = 1 * fl.u.m,
    ... )
    

name: str | None = 'PorousJump'#

Name of the PorousJump boundary condition.

type: Literal['PorousJump'] = 'PorousJump'#
entity_pairs: UniqueItemList[SurfacePair] [Required] (alias 'surface_pairs')#

List of matching pairs of Surface.

darcy_coefficient: Annotated[_InverseAreaType, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] [Required]#

Darcy coefficient of the porous media model which determines the scaling of the viscous loss term. The value defines the coefficient for the axis normal to the surface.

Constraints:
  • func = <function _dimensioned_type_serializer at 0x71c1e223d000>

  • return_type = PydanticUndefined

  • when_used = always

forchheimer_coefficient: Annotated[_InverseLengthType, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] [Required]#

Forchheimer coefficient of the porous media model which determines the scaling of the inertial loss term.

Constraints:
  • func = <function _dimensioned_type_serializer at 0x71c1e223d000>

  • return_type = PydanticUndefined

  • when_used = always

thickness: Annotated[_LengthType, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] [Required]#

Thickness of the thin porous media on the surface

Constraints:
  • func = <function _dimensioned_type_serializer at 0x71c1e223d000>

  • return_type = PydanticUndefined

  • when_used = always