API Reference bldg_segment

bldg_segment

Building ‘Segment’ Level Data Attributes

Source: honeybee_ph/bldg_segment.py


PhVentilationSummerBypassMode

Summer bypass control mode for the ventilation system heat exchanger.

Inherits from: enumerables.CustomEnum

Values

ValueMeaning
"1-None"No bypass.
"2-Temperature Controlled"
"3-Enthalpy Controlled"
"4-Always"Bypass always active in summer.

PhWindExposureType

Wind exposure classification for infiltration calculations.

Inherits from: enumerables.CustomEnum

Values

ValueMeaning
"1-SEVERAL_SIDES_EXPOSED_NO_SCREENING"Multiple exposed sides, no screening.
"2-SEVERAL_SIDES_EXPOSED_MODERATE_SCREENING"Multiple exposed sides, moderate screening.
"3-SEVERAL_SIDES_EXPOSED_HIGH_SCREENING"Multiple exposed sides, high screening.
"4-ONE_SIDE_EXPOSED_NO_SCREENING"One exposed side, no screening.
"5-ONE_SIDE_EXPOSED_MODERATE_SCREENING"One exposed side, moderate screening.
"6-USER_DEFINED"User-defined wind exposure coefficient.
"7-ONE_SIDE_EXPOSED_HIGH_SCREENING"One exposed side, high screening.

PhSummerVentilationExtractSystemControl

Control mode for summer nighttime extract ventilation system.

Inherits from: enumerables.CustomEnum

Values

ValueMeaning
"1-TEMPERATURE_CONTROLLED"Controlled by temperature setpoint.
"2-HUMIDITY_CONTROLLED"Controlled by humidity setpoint.

SummerVentilation

Summer ventilation settings for a building segment.

Inherits from: _base._Base

Attributes

AttributeTypeDescription
ventilation_system_achVentilation system air change rate.
summer_bypass_modePhVentilationSummerBypassModeHRV bypass control mode. Default: “4-Always”.
daytime_extract_system_achDaytime extract system ACH.
daytime_extract_system_fan_power_wh_m3Daytime extract fan specific power in Wh/m3.
daytime_window_achDaytime window ventilation ACH.
nighttime_extract_system_achNighttime extract system ACH.
nighttime_extract_system_fan_power_wh_m3Nighttime extract fan specific power in Wh/m3.
nighttime_extract_system_heat_fractionNighttime extract heat recovery fraction.
nighttime_extract_system_controlPhSummerVentilationExtractSystemControlNighttime extract system control mode. Default: “1-TEMPERATURE_CONTROLLED”.
nighttime_window_achNighttime window ventilation ACH.
nighttime_minimum_indoor_temp_CMinimum indoor temperature for nighttime ventilation in degrees Celsius.

SetPoints

Heating and cooling temperature setpoints for a building segment.

Inherits from: _base._Base

Attributes

AttributeTypeDescription
winterfloatWinter heating setpoint in degrees Celsius. Default: 20.0.
summerfloatSummer cooling setpoint in degrees Celsius. Default: 25.0.

BldgSegment

A building segment representing one thermally distinct zone for PH certification.

Inherits from: _base._Base

Attributes

AttributeTypeDescription
display_namestr
num_floor_levelsintNumber of above-grade floor levels. Default: 1.
num_dwelling_unitsintNumber of dwelling units. Default: 1.
siteSiteClimate and location data for this segment.
source_energy_factorsFactorCollectionSource energy conversion factors.
co2e_factorsFactorCollectionCO2-equivalent emission factors.
phius_certificationPhiusCertificationPhius certification settings.
phi_certificationPhiCertificationPHI certification settings.
set_pointsSetPointsHeating/cooling temperature setpoints.
mech_room_tempfloatMechanical room temperature in degrees Celsius. Default: 20.0.
non_combustible_materialsboolTrue if non-combustible construction. Default: False.
thermal_bridgesDict[str, PhThermalBridge]Thermal bridges keyed by identifier.
wind_exposure_typePhWindExposureTypeWind exposure classification.
summer_ventilationSummerVentilationSummer ventilation parameters.

Properties

PropertyTypeDescription
summer_hrv_bypass_mode

Methods

add_new_thermal_bridge(tb)

Add a thermal bridge to this building segment.

ArgTypeDescription
tbPhThermalBridgeThe thermal bridge to add.

Returns: None

move(moving_vec3D)

Move the BldgSegment along a vector.

ArgTypeDescription
moving_vec3DVector3DThe direction and distance to move.

Returns: BldgSegment

rotate(axis_vec3D, angle_degrees, origin_pt3D)

Rotate the BldgSegment by a certain angle around an axis and origin.

ArgTypeDescription
axis_vec3DVector3DThe axis of rotation.
angle_degreesfloatThe rotation angle in degrees.
origin_pt3DPoint3DThe origin around which to rotate.

Returns: BldgSegment

rotate_xy(angle_degrees, origin_pt3D)

Rotate the BldgSegment counterclockwise in the XY plane by a certain angle.

ArgTypeDescription
angle_degreesfloatThe rotation angle in degrees.
origin_pt3DPoint3DThe origin around which to rotate.

Returns: BldgSegment

reflect(plane)

Reflect the BldgSegment across a plane.

ArgTypeDescription
planePlaneThe plane across which to reflect.

Returns: BldgSegment

scale(scale_factor, origin_pt3D)

Scale the BldgSegment by a factor from an origin point.

ArgTypeDescription
scale_factorfloatThe scaling factor.
origin_pt3D`Point3DNone`

Returns: BldgSegment