Freestream

Freestream#

class Freestream[source]#

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,
...     )
... )

Attributes

entities: EntityList[Surface, MirroredSurface, GhostSurface, WindTunnelGhostSurface, GhostSphere, GhostCircularPlane]#

List of boundaries with the Freestream boundary condition imposed.

turbulence_quantities: TurbulentViscosityRatio | TurbulentKineticEnergy | TurbulentIntensity | TurbulentLengthScale | ModifiedTurbulentViscosityRatio | ModifiedTurbulentViscosity | SpecificDissipationRateAndTurbulentKineticEnergy | TurbulentViscosityRatioAndTurbulentKineticEnergy | TurbulentLengthScaleAndTurbulentKineticEnergy | TurbulentIntensityAndSpecificDissipationRate | TurbulentIntensityAndTurbulentViscosityRatio | TurbulentIntensityAndTurbulentLengthScale | SpecificDissipationRateAndTurbulentViscosityRatio | SpecificDissipationRateAndTurbulentLengthScale | TurbulentViscosityRatioAndTurbulentLengthScale, optional#

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

Default:

None

name: str, optional#

Name of the Freestream boundary condition.

Default:

'Freestream'

velocity: tuple[str, str, str] | VelocityType.Vector, optional#

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.

Default:

None

Additional Constructors

classmethod from_file(filename)#

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json')

Methods

help(methods=False)#

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True)
to_file(filename, **kwargs)#

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')