API Reference hot_water_system

hot_water_system

Honeybee-PH-HVAC: Hot Water System.

Source: honeybee_phhvac/hot_water_system.py


PhHotWaterSystem_FromDictError

No description available.

Inherits from: Exception

Attributes

AttributeTypeDescription
msgformat

PhHotWaterSystem

A Passive House hot water system with tanks, heaters, distribution and recirculation piping.

Attributes

AttributeTypeDescription
identifierstrUnique identifier for the system.
id_numintNumeric identifier for the system.
display_namestrUser-facing display name for the system.
tank_1Optional[hwd.PhHvacHotWaterTank]Primary hot water tank.
tank_2Optional[hwd.PhHvacHotWaterTank]Secondary hot water tank.
tank_bufferOptional[hwd.PhHvacHotWaterTank]Buffer tank.
tank_solarOptional[hwd.PhHvacHotWaterTank]Solar tank.

Properties

PropertyTypeDescription
total_distribution_pipe_lengthfloatReturns the total length of all trunk, branch, and fixture piping.
total_home_run_fixture_pipe_lengthfloatReturns the total length of all fixture piping from end to end.
total_recirc_pipe_lengthfloatReturns the total length of all recirculation piping.
recirc_tempfloatReturn the length weighted average of recirculation piping temperatures
recirc_hoursintReturn the length-weighted average of recirculation piping hours.
number_tap_pointsintUnless set explicitly by the user, will return the number of Branch Pipe Elements.
heatersValuesView[hwd.PhHvacHotWaterHeater]Returns a list of all the heaters on the system.
distribution_pipingValuesView[hwp.PhHvacPipeTrunk]Returns a list of all the distribution-piping (Trunks) in the system.
recirc_pipingValuesView[hwp.PhHvacPipeElement]Returns a list of all the recirculation-piping objects in the system.
tanks`list[hwd.PhHvacHotWaterTankNone]`

Methods

clear_heaters()

Remove all heaters from the system.

add_heater(_heater)

Add a new hot-water heater to the system.

ArgTypeDescription
_heaterOptional[hwd.PhHvacHotWaterHeater]The heater to add. If None, no action is taken.

Returns: None

add_distribution_piping(_distribution_piping, _key)

Add a new distribution (branch, trunk, fixture) to the system.

ArgTypeDescription
_distribution_pipingUnion[hwp.PhHvacPipeTrunkThe piping to add.
_keyhwp.PhHvacPipeBranchAn optional key to use for storing the trunk.

Returns: None

clear_distribution_piping()

Clear all distribution piping (Trunks) from the system.

add_recirc_piping(_recirc_piping, _key)

Add a new recirculation pipe element to the system.

ArgTypeDescription
_recirc_pipinghwp.PhHvacPipeElementThe recirculation pipe element to add.
_keyOptional[str]An optional key to use for storing the pipe element.

Returns: None

clear_recirc_piping()

Remove all recirculation piping from the system.

apply_properties_from_dict(abridged_data)

ArgTypeDescription
abridged_data

move(moving_vec3D)

Move the System’s piping along a vector.

ArgTypeDescription
moving_vec3DPoint3DA vector with the direction and distance to move.

Returns: PhHotWaterSystem

rotate(axis_vec3D, angle_degrees, origin_pt3D)

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

ArgTypeDescription
axis_vec3DPoint3DA vector representing the axis of rotation.
angle_degreesfloatAn angle for rotation in degrees.
origin_pt3DPoint3DThe origin around which the object will be rotated.

Returns: PhHotWaterSystem

rotate_xy(angle_degrees, origin_pt3D)

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

ArgTypeDescription
angle_degreesfloatAn angle in degrees.
origin_pt3DPoint3DThe origin around which the object will be rotated.

Returns: PhHotWaterSystem

reflect(normal_vec3D, origin_pt3D)

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

ArgTypeDescription
normal_vec3DVector3DThe normal vector for the reflection plane. THIS VECTOR MUST BE NORMALIZED.
origin_pt3DPoint3DThe origin from which to reflect.

Returns: PhHotWaterSystem

scale(scale_factor, origin_pt3D)

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

ArgTypeDescription
scale_factorfloatHow much the piping should be scaled.
origin_pt3DOptional[Point3D]The origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

Returns: PhHotWaterSystem