luminarycloud.params.simulation.physics.fluid.boundary_conditions.inlet

Classes

FanCurveInlet	Fan curve.
MachInlet	Mach inlet boundary condition.
MassFlowInlet	Mass flow rate inlet boundary condition.
TotalPressureInlet	Total pressure inlet boundary condition.
VelocityComponentsInlet	Velocity components inlet boundary condition.
VelocityMagnitudeInlet	Velocity magnitude inlet boundary condition.

Package Contents

class FanCurveInlet

Fan curve.

to_code() → str

direction: Vector3

Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally.

direction_specification: luminarycloud.params.enum.DirectionSpecification

Method of defining the flow direction at the inlet.

enable_profile: bool = False

Turn on or off the ability to use tabulated data to define spatially varying boundary conditions.

fan_curve_table: Optional[RectilinearTable] = None

Correlation between fan pressure rise and volume flow rate

head_loss_coefficient: float = 0.0

Fraction of dynamic pressure lost through the fan.

id: str = ''

inlet_energy: luminarycloud.params.enum.InletEnergy

Method of defining the inlet energy conditions.

name: str = ''

profile_table: Optional[RectilinearTable] = None

Tabulated data for spatially varying boundary conditions

profile_type: luminarycloud.params.enum.ProfileType

Types of boundary condition profile.

surfaces: list[str] = []

total_pressure: float = 101325

Total pressure at the boundary relative to the material reference pressure.

total_temperature: float = 300

Total temperature at the inlet boundary.

total_temperature_column_index: int = 0

Index of the column of the table in profile_bc_data for Total Temperature

turbulence: TurbulenceBoundaryConditions

Turbulence boundary conditions.

class MachInlet

Mach inlet boundary condition.

to_code() → str

direction: Vector3

Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally.

direction_specification: luminarycloud.params.enum.DirectionSpecification

Method of defining the flow direction at the inlet.

enable_profile: bool = False

Turn on or off the ability to use tabulated data to define spatially varying boundary conditions.

id: str = ''

inlet_energy: luminarycloud.params.enum.InletEnergy

Method of defining the inlet energy conditions.

mach_number: float = 0.5

Mach number at the boundary.

name: str = ''

pressure: float = 101325

Static pressure at the boundary relative to the material reference pressure.

profile_table: Optional[RectilinearTable] = None

Tabulated data for spatially varying boundary conditions

profile_type: luminarycloud.params.enum.ProfileType

Types of boundary condition profile.

surfaces: list[str] = []

total_temperature: float = 300

Total temperature at the inlet boundary.

total_temperature_column_index: int = 0

Index of the column of the table in profile_bc_data for Total Temperature

turbulence: TurbulenceBoundaryConditions

Turbulence boundary conditions.

class MassFlowInlet

Mass flow rate inlet boundary condition.

to_code() → str

direction: Vector3

Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally.

direction_specification: luminarycloud.params.enum.DirectionSpecification

Method of defining the flow direction at the inlet.

enable_profile: bool = False

Turn on or off the ability to use tabulated data to define spatially varying boundary conditions.

id: str = ''

inlet_energy: luminarycloud.params.enum.InletEnergy

Method of defining the inlet energy conditions.

mass_flow_rate: float = 1.0

Mass flow rate at the inlet. The prescribed mass flow is imposed over the aggregate area of all surfaces listed for the inlet boundary condition. To prescribe mass flow on a per-surface basis, create multiple mass flow inlet boundary conditions, each with a single surface.

name: str = ''

profile_table: Optional[RectilinearTable] = None

Tabulated data for spatially varying boundary conditions

profile_type: luminarycloud.params.enum.ProfileType

Types of boundary condition profile.

surfaces: list[str] = []

total_temperature: float = 300

Total temperature at the inlet boundary.

total_temperature_column_index: int = 0

Index of the column of the table in profile_bc_data for Total Temperature

turbulence: TurbulenceBoundaryConditions

Turbulence boundary conditions.

class TotalPressureInlet

Total pressure inlet boundary condition.

to_code() → str

direction: Vector3

Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally.

direction_specification: luminarycloud.params.enum.DirectionSpecification

Method of defining the flow direction at the inlet.

enable_profile: bool = False

Turn on or off the ability to use tabulated data to define spatially varying boundary conditions.

id: str = ''

inlet_energy: luminarycloud.params.enum.InletEnergy

Method of defining the inlet energy conditions.

name: str = ''

profile_table: Optional[RectilinearTable] = None

Tabulated data for spatially varying boundary conditions

profile_type: luminarycloud.params.enum.ProfileType

Types of boundary condition profile.

surfaces: list[str] = []

total_pressure: float = 101325

Total pressure at the boundary relative to the material reference pressure.

total_pressure_column_index: int = 0

Index of the column of the table in profile_bc_data for total pressure

total_temperature: float = 300

Total temperature at the inlet boundary.

total_temperature_column_index: int = 0

Index of the column of the table in profile_bc_data for Total Temperature

turbulence: TurbulenceBoundaryConditions

Turbulence boundary conditions.

class VelocityComponentsInlet

Velocity components inlet boundary condition.

to_code() → str

enable_profile: bool = False

Turn on or off the ability to use tabulated data to define spatially varying boundary conditions.

id: str = ''

inlet_energy: luminarycloud.params.enum.InletEnergy

Method of defining the inlet energy conditions.

name: str = ''

pressure: float = 101325

Static pressure at the boundary relative to the material reference pressure.

profile_table: Optional[RectilinearTable] = None

Tabulated data for spatially varying boundary conditions

profile_type: luminarycloud.params.enum.ProfileType

Types of boundary condition profile.

surfaces: list[str] = []

total_temperature: float = 300

Total temperature at the inlet boundary.

total_temperature_column_index: int = 0

Index of the column of the table in profile_bc_data for Total Temperature

turbulence: TurbulenceBoundaryConditions

Turbulence boundary conditions.

velocity: Vector3

Vector (x,y,z) defining the velocity vector.

class VelocityMagnitudeInlet

Velocity magnitude inlet boundary condition.

to_code() → str

direction: Vector3

Vector (x,y,z) defining the flow direction. Automatically scaled to a unit vector internally.

direction_specification: luminarycloud.params.enum.DirectionSpecification

Method of defining the flow direction at the inlet.

enable_profile: bool = False

Turn on or off the ability to use tabulated data to define spatially varying boundary conditions.

id: str = ''

inlet_energy: luminarycloud.params.enum.InletEnergy

Method of defining the inlet energy conditions.

name: str = ''

pressure: float = 101325

Static pressure at the boundary relative to the material reference pressure.

profile_table: Optional[RectilinearTable] = None

Tabulated data for spatially varying boundary conditions

profile_type: luminarycloud.params.enum.ProfileType

Types of boundary condition profile.

surfaces: list[str] = []

total_temperature: float = 300

Total temperature at the inlet boundary.

total_temperature_column_index: int = 0

Index of the column of the table in profile_bc_data for Total Temperature

turbulence: TurbulenceBoundaryConditions

Turbulence boundary conditions.

velocity: float = 1.0

Velocity magnitude at the inlet boundary.

velocity_column_index: int = 0

Index of the column of the table in profile_bc_data for inlet_velocity_magnitude