flow360.Freestream

class Freestream

Bases: BoundaryBaseWithTurbulenceQuantities

Freestream defines the freestream boundary condition.

Example

• Define freestream boundary condition with velocity expression and boundaries from the volume mesh:

  >>> fl.Freestream(
  ...     surfaces=[volume_mesh["blk-1/freestream-part1"],
  ...               volume_mesh["blk-1/freestream-part2"]],
  ...     velocity = ["min(0.2, 0.2 + 0.2*y/0.5)", "0", "0.1*y/0.5"]
  ... )
  

• Define freestream boundary condition with turbulence quantities and automated farfield:

  >>> auto_farfield = fl.AutomatedFarfield()
  ... fl.Freestream(
  ...     entities=[auto_farfield.farfield],
  ...     turbulence_quantities= fl.TurbulenceQuantities(
  ...         modified_viscosity_ratio=10,
  ... )
  

---

name: str | None = 'Freestream'

Name of the Freestream boundary condition.

type: Literal['Freestream'] = 'Freestream'

velocity: Tuple[Annotated[str, AfterValidator(func=process_expressions)], Annotated[str, AfterValidator(func=process_expressions)], Annotated[str, AfterValidator(func=process_expressions)]] | Annotated[_VectorType, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] | None = None

The default values are set according to the AerospaceCondition.alpha and AerospaceCondition.beta angles. Optionally, an expression for each of the velocity components can be specified.

entities: EntityList[Surface, GhostSurface, GhostSphere, GhostCircularPlane] [Required] (alias 'surfaces')

List of boundaries with the Freestream boundary condition imposed.

turbulence_quantities: TurbulenceQuantitiesType | None = None

The turbulence related quantities definition.See TurbulenceQuantities() documentation.