honeybee_phhvac.heating module

Honeybee-PH-HVAC-Equipment: Heating Devices.

exception honeybee_phhvac.heating.UnknownPhHeatingTypeError(_heater_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.heating.PhHeatingDirectElectric[source]

Bases: PhHeatingSystem

Heating via direct-electric (resistance heating).

ToString()
base_attrs_from_dict(_input_dict: PhHeatingSystem) → PhHeatingSystem
check_dict_type(_input_dict: dict) → None

Check that the input dict type is correct for the Heating System being constructed.

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

Move the System’s elements along a vector.

Parameters:

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

reflect(normal_vec3D, origin_pt3D)

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

Parameters:

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

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

rotate(axis_vec3D, angle_degree, origin_pt3D)

Rotate the System’s elements 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 – A Vector3D axis representing the axis of rotation.

  • angle – An angle for rotation in degrees.

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

rotate_xy(angle_degree, origin_pt3D)

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

Parameters:

  • angle – An angle in degrees.

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

scale(scale_factor, origin=None)

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

Parameters:

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

  • origin – 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 identifier
property identifier_short: str
property key
class honeybee_phhvac.heating.PhHeatingDistrict[source]

Bases: PhHeatingSystem

Heating via district-heat.

ToString()
base_attrs_from_dict(_input_dict: PhHeatingSystem) → PhHeatingSystem
check_dict_type(_input_dict: dict) → None

Check that the input dict type is correct for the Heating System being constructed.

duplicate() → PhHeatingDistrict[source]
classmethod from_dict(_input_dict: dict) → PhHeatingDistrict[source]
move(moving_vec3D)

Move the System’s elements along a vector.

Parameters:

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

reflect(normal_vec3D, origin_pt3D)

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

Parameters:

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

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

rotate(axis_vec3D, angle_degree, origin_pt3D)

Rotate the System’s elements 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 – A Vector3D axis representing the axis of rotation.

  • angle – An angle for rotation in degrees.

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

rotate_xy(angle_degree, origin_pt3D)

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

Parameters:

  • angle – An angle in degrees.

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

scale(scale_factor, origin=None)

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

Parameters:

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

  • origin – 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[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
class honeybee_phhvac.heating.PhHeatingFossilBoiler[source]

Bases: PhHeatingSystem

Heating via boiler using fossil-fuel (gas, oil)

ToString()
base_attrs_from_dict(_input_dict: PhHeatingSystem) → PhHeatingSystem
check_dict_type(_input_dict: dict) → None

Check that the input dict type is correct for the Heating System being constructed.

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

Move the System’s elements along a vector.

Parameters:

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

reflect(normal_vec3D, origin_pt3D)

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

Parameters:

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

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

rotate(axis_vec3D, angle_degree, origin_pt3D)

Rotate the System’s elements 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 – A Vector3D axis representing the axis of rotation.

  • angle – An angle for rotation in degrees.

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

rotate_xy(angle_degree, origin_pt3D)

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

Parameters:

  • angle – An angle in degrees.

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

scale(scale_factor, origin=None)

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

Parameters:

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

  • origin – 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 identifier
property identifier_short: str
property key
class honeybee_phhvac.heating.PhHeatingSystem[source]

Bases: _PhHVACBase

Base class for all PH-Heating Systems (elec, boiler, etc…)

ToString()
base_attrs_from_dict(_input_dict: PhHeatingSystem) → PhHeatingSystem[source]
check_dict_type(_input_dict: dict) → None[source]

Check that the input dict type is correct for the Heating System being constructed.

duplicate() → PhHeatingSystem[source]
classmethod from_dict(_input_dict)[source]
move(moving_vec3D)[source]

Move the System’s elements along a vector.

Parameters:

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

reflect(normal_vec3D, origin_pt3D)[source]

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

Parameters:

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

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

rotate(axis_vec3D, angle_degree, origin_pt3D)[source]

Rotate the System’s elements 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 – A Vector3D axis representing the axis of rotation.

  • angle – An angle for rotation in degrees.

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

rotate_xy(angle_degree, origin_pt3D)[source]

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

Parameters:

  • angle – An angle in degrees.

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

scale(scale_factor, origin=None)[source]

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

Parameters:

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

  • origin – 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[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
class honeybee_phhvac.heating.PhHeatingSystemBuilder[source]

Bases: object

Constructor class for PH-HeatingSystems

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

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

class honeybee_phhvac.heating.PhHeatingWoodBoiler[source]

Bases: PhHeatingSystem

Heating via boiler using wood (log, pellet).

ToString()
base_attrs_from_dict(_input_dict: PhHeatingSystem) → PhHeatingSystem
check_dict_type(_input_dict: dict) → None

Check that the input dict type is correct for the Heating System being constructed.

duplicate() → PhHeatingWoodBoiler[source]
classmethod from_dict(_input_dict: dict) → PhHeatingWoodBoiler[source]
move(moving_vec3D)

Move the System’s elements along a vector.

Parameters:

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

reflect(normal_vec3D, origin_pt3D)

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

Parameters:

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

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

rotate(axis_vec3D, angle_degree, origin_pt3D)

Rotate the System’s elements 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 – A Vector3D axis representing the axis of rotation.

  • angle – An angle for rotation in degrees.

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

rotate_xy(angle_degree, origin_pt3D)

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

Parameters:

  • angle – An angle in degrees.

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

scale(scale_factor, origin=None)

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

Parameters:

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

  • origin – 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[source]
property avg_power_output
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
property useful_heat_output