lizzy.gates

class lizzy.gates.Inlet(name: str, inlet_type: InletType)

Abstract class representing an inlet. PressureInlet and FlowRateInlet derive from this class.

Properties

property name: str

Unique name of the inlet. (read-only)

property is_open: bool

Indicates whether the inlet is currently open (True) or closed (False). (read-only)

property type: InletType

Methods

reset()

Restores the inlet p_value to the value assigned at creation time and sets it to open.

set_open(open_state: bool)

Set the inlet state to open or closed.

Parameters:

open_state (bool) – The state the inlet will be set to: open (True) or closed (False).

class lizzy.gates.PressureInlet(name: str, p_value: float)

A class representing an inlet gate where a pressure boundary condition is imposed (Dirichlet boundary condition).

Parameters:

• name (str) – Unique name of the inlet.

• p_value (float) – Pressure value assigned [Pa].

Properties

property p_value: float

Current pressure value [Pa].

property p0: float

Initial pressure value assigned at inlet creation time. (read-only)

property is_open: bool

Indicates whether the inlet is currently open (True) or closed (False). (read-only)

Methods

reset()

Restores the inlet p_value to the value assigned at creation time and sets it to open.

set_open(open_state: bool)

Set the inlet state to open or closed.

Parameters:

open_state (bool) – The state the inlet will be set to: open (True) or closed (False).

class lizzy.gates.FlowRateInlet(name: str, q_value: float)

A class representing an inlet gate where a volumetric flow rate boundary condition is imposed (Neumann boundary condition).

Parameters:

• name (str) – Unique name of the inlet.

• q_value (float) – Flow rate value assigned [m³/s].

Properties

property q_value: float

Current flow rate value [m³/s].

property q0: float

Initial flow rate value assigned at inlet creation time [m³/s]. (read-only)

property is_open: bool

Indicates whether the inlet is currently open (True) or closed (False). (read-only)

Methods

reset()

Restores the inlet p_value to the value assigned at creation time and sets it to open.

set_open(open_state: bool)

Set the inlet state to open or closed.

Parameters:

open_state (bool) – The state the inlet will be set to: open (True) or closed (False).

class lizzy.gates.Vent(name: str, vacuum_pressure: float = 0.0)

A class respresenting a vent boundary. Vent vacuum pressure will be applied to all non-filled regions in the domain.

Parameters:

• name (str) – Unique name of the vent.

• vacuum_pressure (float, optional) – Vacuum pressure value assigned [Pa]. Default is 0.0.

Properties

property vacuum_pressure: float

Vacuum pressure value [Pa].