Outflow

class Outflow

Bases: BoundaryBase

Outflow defines the outflow boundary condition based on the input spec.

Example

• Define outflow boundary condition with pressure:

  >>> fl.Outflow(
  ...     surfaces=volume_mesh["fluid/outlet"],
  ...     spec=fl.Pressure(value = 0.99e6 * fl.u.Pa)
  ... )
  

• Define outflow boundary condition with Mach number:

  >>> fl.Outflow(
  ...     surfaces=volume_mesh["fluid/outlet"],
  ...     spec=fl.Mach(value = 0.2)
  ... )
  

• Define outflow boundary condition with mass flow rate:

  >>> fl.Outflow(
  ...     surfaces=volume_mesh["fluid/outlet"],
  ...     spec=fl.MassFlowRate(value = 123 * fl.u.lb / fl.u.s)
  ... )
  

---

Attributes

entities: EntityList[Surface, MirroredSurface, WindTunnelGhostSurface]

List of boundaries with the Outflow boundary condition imposed.

name: str, optional

Name of the Outflow boundary condition.

Default:

'Outflow'

spec: Pressure | MassFlowRate | Mach

Specify the static pressure, mass flow rate, or Mach number parameters at the Outflow boundary.

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')