luminarycloud.params.boundary_conditions¶

Submodules¶

luminarycloud.params.boundary_conditions.inlets

Classes¶

`BoundaryCondition`	Boundary condition for a fluid flow physics solver.
`FarField`	Far-field boundary condition.
`Inlet`	Inlet boundary condition.
`Outlet`	Outlet boundary condition.
`Symmetry`	Symmetry boundary condition.
`Wall`	Wall boundary condition.

Package Contents¶

class luminarycloud.params.boundary_conditions.BoundaryCondition¶

Bases: luminarycloud.params._param_wrappers.ParamGroupWrapper

Boundary condition for a fluid flow physics solver.

classmethod from_proto(proto: T) → Self¶

interface_id: str = ''¶: ID of the multiphysics interface that manages this boundary condition.

name: str = ''¶

surfaces: list[str]¶: Surfaces that this boundary condition is applied to.

class luminarycloud.params.boundary_conditions.FarField¶

Bases: luminarycloud.params.boundary_conditions.BoundaryCondition

Far-field boundary condition.

angle_alpha: float = 0.0¶: Angle of attack. Positive angle of attack results in a non-zero far-field velocity component in the negative body-z direction.

angle_beta: float = 0.0¶: Angle of sideslip. Positive angle of sideslip results in a non-zero far-field velocity component in the positive body-y direction.

flow_direction: luminarycloud.vector3.Vector3¶: Vector specifying the flow direction at the far-field boundary. Automatically scaled to a unit vector internally.

flow_direction_specification: luminarycloud.params.enum.FarFieldFlowDirectionSpecification¶: Method of defining the flow direction at the far-field.

mach_number: float = 0.5¶: Mach number at the boundary.

pressure: float = 101325.0¶: Static pressure at the boundary relative to the reference pressure.

temperature: float = 288.15¶: Static temperature at the boundary.

turbulence: luminarycloud.params.turbulence.TurbulenceSpecification¶: Specification for turbulence at the farfield boundary.

velocity_magnitude: float = 1.0¶: Velocity magnitude at the far-field boundary.

class luminarycloud.params.boundary_conditions.Inlet¶

Bases: luminarycloud.params.boundary_conditions.BoundaryCondition

Inlet boundary condition.

turbulence: luminarycloud.params.turbulence.TurbulenceSpecification¶: Specification for turbulence at the inlet.

class luminarycloud.params.boundary_conditions.Outlet¶

Bases: luminarycloud.params.boundary_conditions.BoundaryCondition

Outlet boundary condition.

classmethod from_proto(proto: T) → Self¶

interface_id: str = ''¶: ID of the multiphysics interface that manages this boundary condition.

name: str = ''¶

pressure: float = 101325.0¶: Static pressure at the outlet boundary relative to the reference pressure.

pressure_constraint: luminarycloud.params.enum.OutletPressureConstraint¶: Mode of imposing pressure at the outlet.

reference_pressure: float = 101325.0¶: Absolute total pressure used to compute the corrected mass flow target.

reference_temperature: float = 288.15¶: Total temperature used to compute the corrected mass flow target.

strategy: luminarycloud.params.enum.OutletStrategy¶: Outlet strategy.

surfaces: list[str]¶: Surfaces that this boundary condition is applied to.

target_mass_flow_rate: float = 1.0¶: Target mass flow rate (or corrected mass flow rate).

class luminarycloud.params.boundary_conditions.Symmetry¶

Bases: luminarycloud.params.boundary_conditions.BoundaryCondition

Symmetry boundary condition.

classmethod from_proto(proto: T) → Self¶

interface_id: str = ''¶: ID of the multiphysics interface that manages this boundary condition.

name: str = ''¶

surfaces: list[str]¶: Surfaces that this boundary condition is applied to.

class luminarycloud.params.boundary_conditions.Wall¶

Bases: luminarycloud.params.boundary_conditions.BoundaryCondition

Wall boundary condition.

classmethod from_proto(proto: T) → Self¶

energy: luminarycloud.params.enum.WallEnergy¶: Condition applied to the energy equation at a solid wall boundary.

equivalent_sand_grain_roughness: float | None = None¶: Equivalent sand-grain roughness of the wall. Set to None to disable roughness control.

fixed_heat_flux: float = 0.0¶: Heat flux per unit area at wall boundary surfaces. Negative values increase temperatures at the wall while positive values decrease it. Set to 0 for an adiabatic wall.

interface_id: str = ''¶: ID of the multiphysics interface that manages this boundary condition.

momentum: luminarycloud.params.enum.WallMomentum¶: Condition applied to the momentum equations at a solid wall boundary.

name: str = ''¶

surfaces: list[str]¶: Surfaces that this boundary condition is applied to.