API Reference heat_pumps

heat_pumps

Honeybee-PH-HVAC-Equipment: Heat-Pump Devices.

Source: honeybee_phhvac/heat_pumps.py


UnknownPhHeatPumpTypeError

Error raised when an unrecognized heat-pump type name is encountered.

Inherits from: Exception

Attributes

AttributeTypeDescription
msgformatFormatted error message including the received type and valid options.

PhHeatPumpSystem

Base class for all HBPH heat-pump systems.

Inherits from: _base._PhHVACBase

Attributes

AttributeTypeDescription
heat_pump_class_nameThe class name of the heat-pump type.
percent_coveragefloatFractional coverage of the heating load (0.0-1.0).
cooling_paramsPhHeatPumpCoolingParamsCooling parameter collection for this heat pump.

Methods

base_attrs_from_dict(_input_dict)

ArgTypeDescription
_input_dictPhHeatPumpSystem

Returns: PhHeatPumpSystem

check_dict_type(_input_dict)

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

ArgTypeDescription
_input_dictDict[strThe dictionary to validate.

Returns: None

move(moving_vec3D)

Move the System’s elements 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 elements by a certain angle around an axis and origin.

ArgTypeDescription
axis_vec3DA Vector3D 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 elements 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 elements across a plane with the input normal vector and origin.

ArgTypeDescription
normal_vec3DA normalized Vector3D representing the normal for the plane across which elements will be reflected.
origin_pt3DA Point3D representing the origin from which to reflect.

scale(scale_factor, origin_pt3D)

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

ArgTypeDescription
scale_factorA number representing how much the elements should be scaled.
origin_pt3DA Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

PhHeatPumpCoolingParams_Base

Base class for all HBPH cooling parameters.

Inherits from: _base._PhHVACBase

Attributes

AttributeTypeDescription
usedboolWhether this cooling mode is active.

Methods

base_attrs_from_dict(_input_dict)

ArgTypeDescription
_input_dictPhHeatPumpCoolingParams_Base

Returns: PhHeatPumpCoolingParams_Base


PhHeatPumpCoolingParams_Ventilation

Cooling via the fresh-air ventilation system (ERV).

Inherits from: PhHeatPumpCoolingParams_Base

Attributes

AttributeTypeDescription
single_speedboolWhether the system operates at a single speed only.
min_coil_tempfloatMinimum coil temperature in degrees Celsius.
capacityfloatCooling capacity in kW.
annual_COPfloatAnnual coefficient of performance.

PhHeatPumpCoolingParams_Recirculation

Cooling via a recirculation system (typical AC).

Inherits from: PhHeatPumpCoolingParams_Base

Attributes

AttributeTypeDescription
single_speedboolWhether the system operates at a single speed only.
min_coil_tempfloatMinimum coil temperature in degrees Celsius.
flow_rate_m3_hrfloatAirflow rate in cubic meters per hour.
flow_rate_variableboolWhether the flow rate is variable.
capacityfloatCooling capacity in kW.
annual_COPfloatAnnual coefficient of performance.

PhHeatPumpCoolingParams_Dehumidification

Cooling via a dedicated dehumidification system.

Inherits from: PhHeatPumpCoolingParams_Base

Attributes

AttributeTypeDescription
useful_heat_lossboolWhether heat loss from dehumidification is considered useful.
annual_COPfloatAnnual coefficient of performance.

PhHeatPumpCoolingParams_Panel

Cooling via radiant panels.

Inherits from: PhHeatPumpCoolingParams_Base

Attributes

AttributeTypeDescription
annual_COPfloatAnnual coefficient of performance.

PhHeatPumpCoolingParams

A collection of cooling parameters for various types of cooling systems.

Attributes

AttributeTypeDescription
percent_coveragefloatFractional coverage of the cooling load (0.0-1.0).
ventilationPhHeatPumpCoolingParams_VentilationVentilation-based cooling parameters.
recirculationPhHeatPumpCoolingParams_RecirculationRecirculation-based cooling parameters.
dehumidificationPhHeatPumpCoolingParams_DehumidificationDehumidification-based cooling parameters.
panelPhHeatPumpCoolingParams_PanelRadiant-panel-based cooling parameters.

PhHeatPumpAnnual

Electric heat pump with only annual performance values.

Inherits from: PhHeatPumpSystem

Attributes

AttributeTypeDescription
annual_COPfloatAnnual coefficient of performance.
total_system_perf_ratiofloatTotal system performance ratio.

PhHeatPumpRatedMonthly

Electric heat pump with two separate monthly rated performance values.

Inherits from: PhHeatPumpSystem

Attributes

AttributeTypeDescription
COP_1floatCoefficient of performance at the first rating point.
ambient_temp_1Ambient temperature for the first rating point in degrees Celsius.
COP_2floatCoefficient of performance at the second rating point.
ambient_temp_2floatAmbient temperature for the second rating point in degrees Celsius.

Properties

PropertyTypeDescription
monthly_COPSList[float]The two monthly COP rating values.
monthly_tempsList[float]The two monthly ambient temperature rating values in degrees Celsius.

PhHeatPumpCombined

Combined heat pump system (not yet implemented).

Inherits from: PhHeatPumpSystem


PhHeatPumpSystemBuilder

Factory class for constructing the correct PhHeatPumpSystem subclass from a dictionary.