honeybee_phhvac.properties.room module

HB-Room Passive-House-HVAC-Equipment Properties.

exception honeybee_phhvac.properties.room.RoomPhHvacProperties_FromDictError(_expected_types, _input_type)

Bases: Exception

with_traceback()

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

args

class honeybee_phhvac.properties.room.RoomPhHvacProperties(_host: RoomProperties | None)

Bases: object

ToString() → str

add_exhaust_vent_device(_exhaust_vent_device: _ExhaustVentilatorBase | None) → None

Add an Exhaust Vent Device serving the Room.

add_heat_pump_system(_heat_pump_system: PhHeatPumpSystem | None) → None

Add a Heat Pump System serving the Room.

add_heating_system(_heating_system: PhHeatingSystem | None) → None

Add a Heating System serving the Room.

add_renewable_device(_renewable_device: PhRenewableEnergyDevice | None) → None

Add a Renewable Energy Device serving the Room.

add_supportive_device(_supportive_device: PhSupportiveDevice | None) → None

Add a Supportive Device serving the Room.

apply_properties_from_dict(room_prop_dict: Dict[str, Any], mech_systems: Dict[str, dict[str, Any]], *args: list, **kwargs: dict) → None

Apply properties from a RoomPhHvacPropertiesAbridged dictionary.

clear_systems()

Clear all the HVAC Systems from the Room.

duplicate(new_host: RoomProperties | None = None, *args: list, **kwargs: dict) → RoomPhHvacProperties

classmethod from_dict(_input_dict: Dict[str, Any], host: RoomProperties | None) → RoomPhHvacProperties

move(move_vec3D)

Move the Room’s HVAC Systems along a vector.

When used in within Honeybee, this method will most often be triggered as part of a larger model-transform. For instance, when triggered during a Room’s honeybee.properties._Properties transform.

When this method is used on its own, it is best practice to duplicate the object before applying this transform since it applies the transform to the object directly, rather than returning a new object with the transform applied.

Parameters:

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

reflect(plane: Plane) → None

Reflected the Room’s HVAC Systems across a plane with the input normal vector and origin.

When used in within Honeybee, this method will most often be triggered as part of a larger model-transform. For instance, when triggered during a Room’s honeybee.properties._Properties transform.

When this method is used on its own, it is best practice to duplicate the object before applying this transform since it applies the transform to the object directly, rather than returning a new object with the transform applied.

Parameters:

plane – A Plane object representing the plane across which the object will be reflected.

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the Room’s HVAC Systems by a certain angle around an axis and origin.

When used in within Honeybee, this method will most often be triggered as part of a larger model-transform. For instance, when triggered during a Room’s honeybee.properties._Properties transform.

When this method is used on its own, it is best practice to duplicate the object before applying this transform since it applies the transform to the object directly, rather than returning a new object with the transform applied.

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_degree: float, origin_pt3D: Point3D) → None

Rotate the Room’s HVAC Systems counterclockwise in the XY plane by a certain angle.

When used in within Honeybee, this method will most often be triggered as part of a larger model-transform. For instance, when triggered during a Room’s honeybee.properties._Properties transform.

When this method is used on its own, it is best practice to duplicate the object before applying this transform since it applies the transform to the object directly, rather than returning a new object with the transform applied.

Parameters:

• angle_degree – An angle in degrees.

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

scale(scale_factor, origin_pt3D=None)

Scale the Room’s HVAC Systems by a factor from an origin point.

When used in within Honeybee, this method will most often be triggered as part of a larger model-transform. For instance, when triggered during a Room’s honeybee.properties._Properties transform.

When this method is used on its own, it is best practice to duplicate the object before applying this transform since it applies the transform to the object directly, rather than returning a new object with the transform applied.

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).

set_hot_water_system(_hot_water_system: PhHotWaterSystem | None) → None

Set the Hot Water System serving the Room.

set_ventilation_system(_ventilation_system: PhVentilationSystem | None) → None

Set the Ventilation System serving the Room.

to_dict(abridged: bool = False) → Dict[str, Any]

property exhaust_vent_devices: Set[_ExhaustVentilatorBase]

property heat_pump_systems: Set[PhHeatPumpSystem]

property heating_systems: Set[PhHeatingSystem]

property host: RoomProperties | None

property hot_water_system: PhHotWaterSystem | None

property renewable_devices: Set[PhRenewableEnergyDevice]

property supportive_devices: Set[PhSupportiveDevice]

property ventilation_system: PhVentilationSystem | None

honeybee_phhvac.properties.room.get_exhaust_vent_devices_from_space(_hph_space: Space) → Set[_ExhaustVentilatorBase]

Return a set of all the ExhaustVentilators found on a space’s host HB Room.

honeybee_phhvac.properties.room.get_heat_pump_systems_from_space(_space: Space) → Set[PhHeatPumpSystem]

Return the Heat-Pump Systems from a Honeybee-PH Space.

honeybee_phhvac.properties.room.get_heating_systems_from_space(_space: Space) → Set[PhHeatingSystem]

Return the Heating Systems from a Honeybee-PH Space.

honeybee_phhvac.properties.room.get_hot_water_system_from_space(_space: Space) → PhHotWaterSystem | None

Get the Hot Water System from a Honeybee-PH Space.

honeybee_phhvac.properties.room.get_ph_hvac_from_space(_space: Space) → RoomPhHvacProperties | None

Return the “ph_hvac” Properties of a Honeybee-PH Space’s host Room.

honeybee_phhvac.properties.room.get_ph_hvac_prop_from_room(_room: Room) → RoomPhHvacProperties

Get the RoomPhHvacProperties of a HB-Room object.

honeybee_phhvac.properties.room.get_renewable_devices_from_space(_hph_space: Space) → Set[PhRenewableEnergyDevice]

Return a set of all the Renewable Energy Devices found on a space’s host HB Room.

honeybee_phhvac.properties.room.get_supportive_devices_from_space(_hph_space: Space) → Set[PhSupportiveDevice]

Return a set of all the SupportiveDevices found on a space’s host HB Room.

honeybee_phhvac.properties.room.get_ventilation_system_from_space(_space: Space) → PhVentilationSystem | None

Get the Ventilation System from a Honeybee-PH Space.