API Reference ventilation

ventilation

Honeybee-PH-HVAC-Equipment: Ventilation (ERV) Devices.

Source: honeybee_phhvac/ventilation.py


UnknownPhExhaustVentTypeError

Raised when an unrecognized exhaust ventilation device type is encountered.

Inherits from: Exception

Attributes

AttributeTypeDescription
msgformat

Ventilator

A Passive House ventilation heat-recovery unit (ERV/HRV).

Inherits from: _base._PhHVACBase

Attributes

AttributeTypeDescription
display_namestrUser-facing name for the ventilator.
id_numintNumeric identifier for the ventilator.
quantityintNumber of identical units.
sensible_heat_recoveryfloatSensible heat recovery efficiency (0-1).
latent_heat_recoveryfloatLatent heat recovery efficiency (0-1).
electric_efficiencyfloatSpecific electric power in Wh/m3.
frost_protection_reqdboolWhether frost protection is required.
temperature_below_defrost_usedfloatTemperature threshold for defrost activation (C).
in_conditioned_spaceboolWhether the unit is located in conditioned space.

PhVentilationSystem

Passive House Fresh-Air Ventilation System.

Inherits from: _base._PhHVACBase

Attributes

AttributeTypeDescription
display_namestrUser-facing name for the ventilation system.
sys_typeintSystem type identifier (1 = Balanced PH ventilation with HR).
supply_ductingList[ducting.PhDuctElement]Supply-air duct elements.
exhaust_ductingList[ducting.PhDuctElement]Exhaust-air duct elements.
id_numintNumeric identifier for the system.

Properties

PropertyTypeDescription
ventilation_unitOptional[Ventilator]Return the Ventilator (ERV/HRV) assigned to this system.
supply_ducting_total_lengthfloatReturn the total length of all supply-air ducting in model-units.
exhaust_ducting_total_lengthfloatReturn the total length of all exhaust-air ducting in model-units.
supply_ducting_size_descriptionOptional[str]Return the size of the supply-air ducting.
exhaust_ducting_size_descriptionOptional[str]Return the size of the exhaust-air ducting.

Methods

add_supply_duct_element(_duct_element)

Add a supply-air duct element to the ventilation system.

ArgTypeDescription
_duct_elementducting.PhDuctElementThe duct element to add.

Returns: None

add_exhaust_duct_element(_duct_element)

Add an exhaust-air duct element to the ventilation system.

ArgTypeDescription
_duct_elementducting.PhDuctElementThe duct element to add.

Returns: None

move(moving_vec3D)

Move the System’s ducts along a vector.

ArgTypeDescription
moving_vec3DA Vector3D with the direction and distance to move the ray.

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the System’s ducts by a certain angle around an axis and origin.

ArgTypeDescription
axis_vec3DA Vector3D axis representing the axis of rotation.
angle_degreesAn angle for rotation in degrees.
origin_pt3DA Point3D for the origin around which the object will be rotated.

rotate_xy(angle_degrees, origin_pt3D)

Rotate the System’s ducts counterclockwise in the XY plane by a certain angle.

ArgTypeDescription
angle_degreesAn angle in degrees.
origin_pt3DA Point3D for the origin around which the object will be rotated.

reflect(normal_vec3D, origin_pt3D)

Reflect the System’s ducts across a plane with the input normal vector and origin.

ArgTypeDescription
normal_vec3DA normalized Vector3D representing the plane normal.
origin_pt3DA Point3D representing the origin from which to reflect.

scale(scale_factor, origin_pt3D)

Scale the System’s ducts by a factor from an origin point.

ArgTypeDescription
scale_factorfloatA number representing how much the ducts should be scaled.
origin_pt3DOptional[Point3D]A Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

Returns: PhVentilationSystem


ExhaustVentDryer

Exhaust ventilation device representing a clothes dryer.

Inherits from: _ExhaustVentilatorBase

Attributes

AttributeTypeDescription
display_namestr

ExhaustVentKitchenHood

Exhaust ventilation device representing a kitchen range hood.

Inherits from: _ExhaustVentilatorBase

Attributes

AttributeTypeDescription
display_namestr

ExhaustVentUserDefined

Exhaust ventilation device with user-defined parameters.

Inherits from: _ExhaustVentilatorBase

Attributes

AttributeTypeDescription
display_namestr

PhExhaustDeviceBuilder

Constructor class for HBPH-Exhaust Ventilation Devices