API Reference hot_water_piping

hot_water_piping

Honeybee-PH-HVAC: Hot Water Piping.

Source: honeybee_phhvac/hot_water_piping.py


PhHvacPipeMaterial

Enumeration of allowable pipe material types.

Inherits from: enumerables.CustomEnum

Values

ValueMeaning
"1-COPPER_M"Copper type M.
"2-COPPER_L"Copper type L (default).
"3-COPPER_K"Copper type K.
"4-CPVC_CTS_SDR"CPVC CTS SDR.
"5-CPVC_SCH_40"CPVC Schedule 40.
"6-PEX"PEX tubing.
"7-PE"Polyethylene tubing.
"8-PEX_CTS_SDR"PEX CTS SDR.

PhHvacPipeSegment

A single pipe segment (linear) with geometry and a diameter.

Inherits from: _base._PhHVACBase

Attributes

AttributeTypeDescription
geometryThe 3D line segment geometry of the pipe.
diameter_mmThe pipe diameter in millimeters.
insulation_thickness_mmThe insulation thickness in millimeters.
insulation_conductivityThe insulation thermal conductivity (W/m-K).
insulation_reflectiveTrue if the insulation has a reflective surface.
insulation_qualityReserved for future use.
daily_periodHours per day the pipe is in use.
water_temp_cThe water temperature in degrees Celsius.
materialPhHvacPipeMaterialThe pipe material type.

Properties

PropertyTypeDescription
lengthfloatReturn the length of the pipe segment in model-units.
diameter_mfloatReturn the diameter of the pipe segment in meters.
insulation_thickness_mfloatReturn the insulation thickness of the pipe segment in meters.

Methods

move(moving_vec3D)

Move the pipe’s geometry along a vector.

ArgTypeDescription
moving_vec3DVector3DA vector with the direction and distance to move.

Returns: PhHvacPipeSegment

rotate(axis_3D, angle_degrees, origin_pt3D)

Rotate the pipe’s geometry by a certain angle around an axis and origin.

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

Returns: PhHvacPipeSegment

rotate_xy(angle_degrees, origin_pt3D)

Rotate the pipe’s geometry 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: PhHvacPipeSegment

reflect(normal_vec3D, origin_pt3D)

Reflect the pipe’s geometry 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: PhHvacPipeSegment

scale(scale_factor, origin_pt3D)

Scale the pipe’s geometry by a factor from an origin point.

ArgTypeDescription
scale_factorfloatHow much the line segment should be scaled.
origin_pt3DUnion[NoneThe origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

Returns: PhHvacPipeSegment


PhHvacPipeElement

A Pipe Element (Fixture) made up of one or more individual Pipe Segments.

Inherits from: _base._PhHVACBase

Properties

PropertyTypeDescription
segmentsList[PhHvacPipeSegment]Return a list of all the Pipe-Segments in the Pipe-Element.
lengthfloatReturn the total length of the pipe element in model-units.
diameter_mmfloatReturn the length-weighted average diameter of all the pipe segments
water_temp_cfloatReturn the length-weighted average water temperature of all the pipe segments
daily_periodfloatReturn the length-weighted average daily period of all the pipe segments
segment_namesList[str]Return a list of the names of all the PipeSegments in the PipeElement.
material_namestrReturn the material name of the pipe element.

Methods

add_segment(_segment)

Add a new Pipe Segment to the Pipe Element.

ArgTypeDescription
_segmentPhHvacPipeSegmentThe pipe segment to add.

Returns: None

clear_segments()

Clear all the segments from the pipe element.

Returns: None

move(moving_vec3D)

Move the pipe’s segments along a vector.

ArgTypeDescription
moving_vec3DVector3DA vector with the direction and distance to move.

Returns: PhHvacPipeElement

rotate(axis_3D, angle_degrees, origin_pt3D)

Rotate the pipe’s segments by a certain angle around an axis and origin.

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

Returns: PhHvacPipeElement

rotate_xy(angle_degrees, origin_pt3D)

Rotate the pipe’s segments 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: PhHvacPipeElement

reflect(normal_vec3D, origin_pt3D)

Reflect the pipe’s segments 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: PhHvacPipeElement

scale(factor, origin_pt3D)

Scale the pipe’s segments by a factor from an origin point.

ArgTypeDescription
factorfloatHow much the segments 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: PhHvacPipeElement


PhHvacPipeBranch

A ‘Branch’ Pipe which has geometry, and serves one or more ‘Fixture’ (Twig) pipe elements.

Inherits from: _base._PhHVACBase

Attributes

AttributeTypeDescription
pipe_elementPhHvacPipeElementThe pipe element representing the branch geometry.
fixtures(List[PhHvacPipeElement])The fixture (twig) pipe elements connected to this branch.

Properties

PropertyTypeDescription
material_namestrReturn the material name of the pipe element.
diameter_mmfloatReturn the length-weighted diameter (MM) of the pipe element.
twigsAlias for the ‘fixtures’ to better match Phius terminology.
segmentsReturn a list of all the Pipe-Segments in the Branch.
lengthfloatReturn the total length of the branch itself in model-units.
water_temp_cfloatReturn the length-weighted average water temperature of all the pipe segments.
daily_periodfloatReturn the length-weighted average daily period of all the pipe segments.
num_fixturesintReturn the number of fixtures connected to the branch.
total_lengthfloatReturn the total length of the branch PLUS all fixture pipes in model-units.
total_home_run_fixture_lengthfloatReturn the total length (in model-units) of all fixture pipes as measured from end to end.

Methods

add_fixture(_fixture)

Add a new fixture (twig) pipe element to the branch.

ArgTypeDescription
_fixturePhHvacPipeElementThe fixture pipe element to add.

Returns: None

move(moving_vec3D)

Move the pipe’s elements along a vector.

ArgTypeDescription
moving_vec3DVector3DA vector with the direction and distance to move.

Returns: PhHvacPipeBranch

rotate(axis_3D, angle_degrees, origin_pt3D)

Rotate the pipe’s elements by a certain angle around an axis and origin.

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

Returns: PhHvacPipeBranch

rotate_xy(angle_degrees, origin_pt3D)

Rotate the pipe’s elements 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: PhHvacPipeBranch

reflect(normal_vec3D, origin_pt3D)

Reflect the pipe’s elements 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: PhHvacPipeBranch

scale(factor, origin_pt3D)

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

ArgTypeDescription
factorfloatHow much the elements 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: PhHvacPipeBranch


PhHvacPipeTrunk

A ‘Trunk’ Pipe which has geometry, and serves one or more ‘Branches’.

Inherits from: _base._PhHVACBase

Attributes

AttributeTypeDescription
pipe_elementPhHvacPipeElementThe pipe element representing the trunk geometry.
multiplierintA multiplier applied to the trunk for identical risers.
branches(List[PhHvacPipeBranch])The branch pipes connected to this trunk.
demand_recirculationboolTrue if the trunk uses demand recirculation.

Properties

PropertyTypeDescription
material_namestrReturn the material name of the pipe element.
diameter_mmfloatReturn the length-weighted diameter (MM) name of the pipe element.
segmentsReturn a list of all the Pipe-Segments in the Trunk.
lengthfloatReturn the total length of the trunk itself in model-units.
water_temp_cfloatReturn the length-weighted average water temperature (deg-C) of all the pipe segments.
daily_periodfloatReturn the length-weighted average daily period of all the pipe segments.
num_fixturesintReturn the number of fixtures connected to the trunk.
total_lengthfloatReturn the total length (in model-units) of the trunk PLUS all branches and fixture pipes in model-units.
total_home_run_fixture_lengthfloatReturn the total length (in model-units) of all fixture pipes as measured from end to end.

Methods

add_branch(_branch)

Add a new branch pipe to the trunk.

ArgTypeDescription
_branchPhHvacPipeBranchThe branch pipe to add.

Returns: None

move(moving_vec3D)

Move the pipe’s elements along a vector.

ArgTypeDescription
moving_vec3DVector3DA vector with the direction and distance to move.

Returns: PhHvacPipeTrunk

rotate(axis_3D, angle_degrees, origin_pt3D)

Rotate the pipe’s elements by a certain angle around an axis and origin.

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

Returns: PhHvacPipeTrunk

rotate_xy(angle_degrees, origin_pt3D)

Rotate the pipe’s elements 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: PhHvacPipeTrunk

reflect(normal_vec3D, origin_pt3D)

Reflect the pipe’s elements across a plane with the input normal vector and origin.

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

scale(factor, origin_pt3D)

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

ArgTypeDescription
factorfloatHow much the elements 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: PhHvacPipeTrunk