honeybee_phhvac.ventilation module

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

exception honeybee_phhvac.ventilation.UnknownPhExhaustVentTypeError(_device_types: list[str], _received_type: str)[source]

Bases: Exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

args
class honeybee_phhvac.ventilation.ExhaustVentDryer[source]

Bases: _ExhaustVentilatorBase

ToString()
duplicate() → ExhaustVentDryer[source]
classmethod from_dict(_input_dict: Dict[str, Any]) → _ExhaustVentilatorBase
move(moving_vec3D)

Move the device’s elements along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(normal_vec3D, origin_pt3D)

Reflected the device’s elements across a plane with the input normal vector and origin_pt3D.

Parameters:

  • normal_vec3D – A Vector3D representing the normal vector for the plane across which the line segment will be reflected. THIS VECTOR MUST BE NORMALIZED.

  • origin_pt3D – A Point3D representing the origin_pt3D from which to reflect.

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the device’s elements by a certain angle around an axis_vec3D and origin_pt3D.

Right hand rule applies: If axis_vec3D has a positive orientation, rotation will be clockwise. If axis_vec3D has a negative orientation, rotation will be counterclockwise.

Parameters:

  • axis_vec3D – A Vector3D axis_vec3D representing the axis_vec3D of rotation.

  • angle_degrees – An angle for rotation in degrees.

  • origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

rotate_xy(angle_degrees, origin_pt3D)

Rotate the device’s elements counterclockwise in the XY plane by a certain angle.

Parameters:

  • angle_degrees – An angle in degrees.

  • origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

scale(scale_factor, origin_pt3D=None)

Scale the device’s elements by a factor from an origin_pt3D point.

Parameters:

  • scale_factor – A number representing how much the line segment should be scaled.

  • origin_pt3D – A Point3D representing the origin_pt3D from which to scale. If None, it will be scaled from the World origin_pt3D (0, 0, 0).

to_dict() → Dict[str, Any]
property display_name

Get or set a string for the object name without any character restrictions. If not set, this will be equal to the identifier.

property identifier
property identifier_short: str
property key
class honeybee_phhvac.ventilation.ExhaustVentKitchenHood[source]

Bases: _ExhaustVentilatorBase

ToString()
duplicate() → ExhaustVentKitchenHood[source]
classmethod from_dict(_input_dict: Dict[str, Any]) → _ExhaustVentilatorBase
move(moving_vec3D)

Move the device’s elements along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(normal_vec3D, origin_pt3D)

Reflected the device’s elements across a plane with the input normal vector and origin_pt3D.

Parameters:

  • normal_vec3D – A Vector3D representing the normal vector for the plane across which the line segment will be reflected. THIS VECTOR MUST BE NORMALIZED.

  • origin_pt3D – A Point3D representing the origin_pt3D from which to reflect.

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the device’s elements by a certain angle around an axis_vec3D and origin_pt3D.

Right hand rule applies: If axis_vec3D has a positive orientation, rotation will be clockwise. If axis_vec3D has a negative orientation, rotation will be counterclockwise.

Parameters:

  • axis_vec3D – A Vector3D axis_vec3D representing the axis_vec3D of rotation.

  • angle_degrees – An angle for rotation in degrees.

  • origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

rotate_xy(angle_degrees, origin_pt3D)

Rotate the device’s elements counterclockwise in the XY plane by a certain angle.

Parameters:

  • angle_degrees – An angle in degrees.

  • origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

scale(scale_factor, origin_pt3D=None)

Scale the device’s elements by a factor from an origin_pt3D point.

Parameters:

  • scale_factor – A number representing how much the line segment should be scaled.

  • origin_pt3D – A Point3D representing the origin_pt3D from which to scale. If None, it will be scaled from the World origin_pt3D (0, 0, 0).

to_dict() → Dict[str, Any]
property display_name

Get or set a string for the object name without any character restrictions. If not set, this will be equal to the identifier.

property identifier
property identifier_short: str
property key
class honeybee_phhvac.ventilation.ExhaustVentUserDefined[source]

Bases: _ExhaustVentilatorBase

ToString()
duplicate() → ExhaustVentUserDefined[source]
classmethod from_dict(_input_dict: Dict[str, Any]) → _ExhaustVentilatorBase
move(moving_vec3D)

Move the device’s elements along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(normal_vec3D, origin_pt3D)

Reflected the device’s elements across a plane with the input normal vector and origin_pt3D.

Parameters:

  • normal_vec3D – A Vector3D representing the normal vector for the plane across which the line segment will be reflected. THIS VECTOR MUST BE NORMALIZED.

  • origin_pt3D – A Point3D representing the origin_pt3D from which to reflect.

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the device’s elements by a certain angle around an axis_vec3D and origin_pt3D.

Right hand rule applies: If axis_vec3D has a positive orientation, rotation will be clockwise. If axis_vec3D has a negative orientation, rotation will be counterclockwise.

Parameters:

  • axis_vec3D – A Vector3D axis_vec3D representing the axis_vec3D of rotation.

  • angle_degrees – An angle for rotation in degrees.

  • origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

rotate_xy(angle_degrees, origin_pt3D)

Rotate the device’s elements counterclockwise in the XY plane by a certain angle.

Parameters:

  • angle_degrees – An angle in degrees.

  • origin_pt3D – A Point3D for the origin_pt3D around which the object will be rotated.

scale(scale_factor, origin_pt3D=None)

Scale the device’s elements by a factor from an origin_pt3D point.

Parameters:

  • scale_factor – A number representing how much the line segment should be scaled.

  • origin_pt3D – A Point3D representing the origin_pt3D from which to scale. If None, it will be scaled from the World origin_pt3D (0, 0, 0).

to_dict() → Dict[str, Any]
property display_name

Get or set a string for the object name without any character restrictions. If not set, this will be equal to the identifier.

property identifier
property identifier_short: str
property key
class honeybee_phhvac.ventilation.PhExhaustDeviceBuilder[source]

Bases: object

Constructor class for HBPH-Exhaust Ventilation Devices

ToString()[source]

Overwrite .NET ToString.

classmethod from_dict(_input_dict: dict[str, Any]) → _ExhaustVentilatorBase[source]

Find the right device constructor class from the module based on the ‘type’ name.

class honeybee_phhvac.ventilation.PhVentilationSystem[source]

Bases: _PhHVACBase

Passive House Fresh-Air Ventilation System.

ToString()[source]
add_exhaust_duct_element(_duct_element: PhDuctElement) → None[source]

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

add_supply_duct_element(_duct_element: PhDuctElement) → None[source]

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

duplicate() → PhVentilationSystem[source]
classmethod from_dict(_input_dict: dict[str, Any]) → PhVentilationSystem[source]
move(moving_vec3D)[source]

Move the System’s ducts along a vector.

Parameters:

moving_vec3D – A Vector3D with the direction and distance to move the ray.

reflect(normal_vec3D, origin_pt3D)[source]

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

Parameters:

  • normal_vec3D – A Vector3D representing the normal vector for the plane across which the line segment will be reflected. THIS VECTOR MUST BE NORMALIZED.

  • origin_pt3D – A Point3D representing the origin from which to reflect.

rotate(axis_vec3D, angle_degrees, origin_pt3D)[source]

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

Right hand rule applies: If axis has a positive orientation, rotation will be clockwise. If axis has a negative orientation, rotation will be counterclockwise.

Parameters:

  • axis_vec3D – A Vector3D axis representing the axis of rotation.

  • angle_degrees – An angle for rotation in degrees.

  • origin_pt3D – A Point3D for the origin around which the object will be rotated.

rotate_xy(angle_degrees, origin_pt3D)[source]

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

Parameters:

  • angle_degrees – An angle in degrees.

  • origin_pt3D – A Point3D for the origin around which the object will be rotated.

scale(scale_factor: float, origin_pt3D: Point3D | None = None) → PhVentilationSystem[source]

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

Parameters:

  • scale_factor – A number representing how much the line segment should be scaled.

  • origin_pt3D – A Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

to_dict() → dict[str, Any][source]
property display_name

Get or set a string for the object name without any character restrictions. If not set, this will be equal to the identifier.

property exhaust_ducting_size_description: str | None

Return the size of the exhaust-air ducting.

property exhaust_ducting_total_length: float

Return the total length of all exhaust-air ducting in model-units.

property identifier
property identifier_short: str
property key
property supply_ducting_size_description: str | None

Return the size of the supply-air ducting.

property supply_ducting_total_length: float

Return the total length of all supply-air ducting in model-units.

property ventilation_unit: Ventilator | None
class honeybee_phhvac.ventilation.Ventilator[source]

Bases: _PhHVACBase

ToString()[source]
duplicate() → Ventilator[source]
classmethod from_dict(_input_dict: dict[str, Any]) → Ventilator[source]
to_dict() → dict[str, Any][source]
property display_name

Get or set a string for the object name without any character restrictions. If not set, this will be equal to the identifier.

property identifier
property identifier_short: str
property key