honeybee_openstudio.hvac.standards.hvac_systems module¶

Module taken from OpenStudio-standards.

https://github.com/NREL/openstudio-standards/blob/master/ lib/openstudio-standards/prototypes/common/objects/Prototype.hvac_systems.rb

honeybee_openstudio.hvac.standards.hvac_systems.model_add_baseboard(model, thermal_zones, hot_water_loop=None)[source]¶

Adds hydronic or electric baseboard heating to each zone.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to add baseboards to.
hot_water_loop – [OpenStudio::Model::PlantLoop] The hot water loop that serves the baseboards. If None, baseboards are electric.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_central_air_source_heat_pump(model, thermal_zones, heating=True, cooling=True, ventilation=False)[source]¶

Adds an air source heat pump to each zone. Code adapted from.

https://github.com/NREL/OpenStudio-BEopt/blob/master/measures/ ResidentialHVACAirSourceHeatPumpSingleSpeed/measure.rb

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to add fan coil units to.
heating – [Boolean] if true, the unit will include a heating coil.
cooling – [Boolean] if true, the unit will include a DX cooling coil.
ventilation – [Boolean] if true, the unit will include an OA intake.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_chw_loop(model, system_name='Chilled Water Loop', cooling_fuel='Electricity', dsgn_sup_wtr_temp=44.0, dsgn_sup_wtr_temp_delt=10.1, chw_pumping_type=None, chiller_cooling_type=None, chiller_condenser_type=None, chiller_compressor_type=None, num_chillers=1, condenser_water_loop=None, waterside_economizer='none')[source]¶

Create a chilled water loop and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
system_name – [String] the name of the system, or None in which case it will be defaulted.
cooling_fuel – [String] cooling fuel. Valid choices are: Electricity, DistrictCooling.
dsgn_sup_wtr_temp – [Double] design supply water temperature in degrees Fahrenheit, default 44F.
dsgn_sup_wtr_temp_delt – [Double] design supply-return water temperature difference in degrees Rankine, default 10 dF.
chw_pumping_type – [String] valid choices are const_pri, const_pri_var_sec.
chiller_cooling_type – [String] valid choices are AirCooled, WaterCooled.
chiller_condenser_type – [String] valid choices are WithCondenser, WithoutCondenser, None.
chiller_compressor_type – [String] valid choices are Centrifugal, Reciprocating, Rotary Screw, Scroll, None.
num_chillers – [Integer] the number of chillers.
condenser_water_loop – [OpenStudio::Model::PlantLoop] optional condenser water loop for water-cooled chillers. If None, the chillers will be air cooled.
waterside_economizer – [String] Options are none, integrated, non-integrated. If integrated will add a heat exchanger to the supply inlet of the chilled water loop to provide waterside economizing whenever wet bulb temperatures allow. Non-integrated will add a heat exchanger in parallel with the chiller that will operate only when it can meet cooling demand exclusively with the waterside economizing.

Returns:

[OpenStudio::Model::PlantLoop] the resulting chilled water loop.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_cw_loop(model, system_name='Condenser Water Loop', cooling_tower_type='Open Cooling Tower', cooling_tower_fan_type='Propeller or Axial', cooling_tower_capacity_control='TwoSpeed Fan', number_of_cells_per_tower=1, number_cooling_towers=1, use_90_1_design_sizing=True, sup_wtr_temp=70.0, dsgn_sup_wtr_temp=85.0, dsgn_sup_wtr_temp_delt=10.0, wet_bulb_approach=7.0, pump_spd_ctrl='Constant', pump_tot_hd=49.7)[source]¶

Creates a condenser water loop and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object
system_name – [String] the name of the system, or None in which case it will be defaulted.
cooling_tower_type – [String] valid choices are Open Cooling Tower, Closed Cooling Tower.
cooling_tower_fan_type – [String] valid choices are Centrifugal, “Propeller or Axial.”
cooling_tower_capacity_control – [String] valid choices are Fluid Bypass, Fan Cycling, TwoSpeed Fan, Variable Speed Fan.
number_of_cells_per_tower – [Integer] the number of discrete cells per tower.
number_cooling_towers – [Integer] the number of cooling towers to be added (in parallel).
use_90_1_design_sizing – [Boolean] will determine the design sizing temperatures based on the 90.1 Appendix G approach. Overrides sup_wtr_temp, dsgn_sup_wtr_temp, dsgn_sup_wtr_temp_delt, and wet_bulb_approach if True.
sup_wtr_temp – [Double] supply water temperature in degrees Fahrenheit, default 70F.
dsgn_sup_wtr_temp – [Double] design supply water temperature in degrees Fahrenheit, default 85F.
dsgn_sup_wtr_temp_delt – [Double] design water range temperature in degrees Rankine (aka. dF), default 10R.
wet_bulb_approach – [Double] design wet bulb approach temperature, default 7R.
pump_spd_ctrl – [String] pump speed control type, Constant or Variable (default).
pump_tot_hd – [Double] pump head in ft H2O.

Returns:

[OpenStudio::Model::PlantLoop] the resulting condenser water plant loop

honeybee_openstudio.hvac.standards.hvac_systems.model_add_district_ambient_loop(model, system_name='Ambient Loop')[source]¶

Adds an ambient condenser water loop that represents a district system.

It connects buildings as a shared sink/source for heat pumps.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
system_name – [String] the name of the system, or None in which case it will be defaulted.

Returns:

[OpenStudio::Model::PlantLoop] the ambient loop.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_doas(model, thermal_zones, system_name=None, doas_type='DOASCV', hot_water_loop=None, chilled_water_loop=None, hvac_op_sch=None, min_oa_sch=None, min_frac_oa_sch=None, fan_maximum_flow_rate=None, econo_ctrl_mthd='NoEconomizer', include_exhaust_fan=True, demand_control_ventilation=False, doas_control_strategy='NeutralSupplyAir', clg_dsgn_sup_air_temp=60.0, htg_dsgn_sup_air_temp=70.0, energy_recovery=False)[source]¶

Creates a DOAS system with terminal units for each zone.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
system_name – [String] the name of the system, or None in which case it will be defaulted.
doas_type – [String] DOASCV or DOASVAV, determines whether the DOAS is operated at scheduled, constant flow rate, or airflow is variable to allow for economizing or demand controlled ventilation.
hot_water_loop – [OpenStudio::Model::PlantLoop] hot water loop to connect to heating and zone fan coils.
chilled_water_loop – [OpenStudio::Model::PlantLoop] chilled water loop to connect to cooling coil.
hvac_op_sch – [String] name of the HVAC operation schedule, default is always on.
min_oa_sch – [String] name of the minimum outdoor air schedule, default is always on.
min_frac_oa_sch – [String] name of the minimum fraction of outdoor air schedule, default is always on.
fan_maximum_flow_rate – [Double] fan maximum flow rate in cfm, default is autosize.
econo_ctrl_mthd – [String] economizer control type, default is Fixed Dry Bulb. If enabled, the DOAS will be sized for twice the ventilation minimum to allow economizing.
include_exhaust_fan – [Boolean] if true, include an exhaust fan.
demand_control_ventilation – [Boolean] if true, include demand controlled ventilation controls and variable volume fans.
doas_control_strategy – [String] DOAS control strategy. Valid options include NeutralSupplyAir and ColdSupplyAir.
clg_dsgn_sup_air_temp – [Double] design cooling supply air temperature in degrees Fahrenheit, default 65F.
htg_dsgn_sup_air_temp – [Double] design heating supply air temperature in degrees Fahrenheit, default 75F.
energy_recovery – [Boolean] if true, an ERV will be added to the system.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_doas_cold_supply(model, thermal_zones, system_name=None, hot_water_loop=None, chilled_water_loop=None, hvac_op_sch=None, min_oa_sch=None, min_frac_oa_sch=None, fan_maximum_flow_rate=None, econo_ctrl_mthd='FixedDryBulb', energy_recovery=False, clg_dsgn_sup_air_temp=55.0, htg_dsgn_sup_air_temp=60.0)[source]¶

Creates a DOAS system with cold supply and terminal units for each zone.

This is the default DOAS system for DOE prototype buildings. Use model_add_doas for other DOAS systems.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
system_name – [String] the name of the system, or None in which case it will be defaulted.
hot_water_loop – [OpenStudio::Model::PlantLoop] hot water loop to connect to heating and zone fan coils.
chilled_water_loop – [OpenStudio::Model::PlantLoop] chilled water loop to connect to cooling coil.
hvac_op_sch – [String] name of the HVAC operation schedule, default is always on.
min_oa_sch – [String] name of the minimum outdoor air schedule, default is always on.
min_frac_oa_sch – [String] name of the minimum fraction of outdoor air schedule, default is always on.
fan_maximum_flow_rate – [Double] fan maximum flow rate in cfm, default is autosize.
econo_ctrl_mthd – [String] economizer control type, default is Fixed Dry Bulb.
energy_recovery – [Boolean] if true, an ERV will be added to the system.
clg_dsgn_sup_air_temp – [Double] design cooling supply air temperature in degrees Fahrenheit, default 65F.
htg_dsgn_sup_air_temp – [Double] design heating supply air temperature in degrees Fahrenheit, default 75F.

Returns:

[OpenStudio::Model::AirLoopHVAC] the resulting DOAS air loop.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_evap_cooler(model, thermal_zones)[source]¶

Creates an evaporative cooler for each zone and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_four_pipe_fan_coil(model, thermal_zones, chilled_water_loop, hot_water_loop=None, ventilation=False, capacity_control_method='CyclingFan')[source]¶

Adds four pipe fan coil units to each zone.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to add fan coil units.
chilled_water_loop – [OpenStudio::Model::PlantLoop] the chilled water loop that serves the fan coils.
hot_water_loop – [OpenStudio::Model::PlantLoop] the hot water loop that serves the fan coils. If None, a zero-capacity, electric heating coil set to Always-Off will be included in the unit.
ventilation – [Boolean] If true, ventilation will be supplied through the unit. If false, no ventilation will be supplied through the unit, with the expectation that it will be provided by a DOAS or separate system.
capacity_control_method – [String] Capacity control method for the fan coil. Options are ConstantFanVariableFlow, CyclingFan, VariableFanVariableFlow, and VariableFanConstantFlow. If VariableFan, the fan will be VariableVolume.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_furnace_central_ac(model, thermal_zones, heating=True, cooling=False, ventilation=False, heating_type='NaturalGas')[source]¶

Adds a forced air furnace or central AC to each zone.

Default is a forced air furnace without outdoor air. Code adapted from.

https://github.com/NREL/OpenStudio-BEopt/blob/master/measures/ ResidentialHVACFurnaceFuel/measure.rb

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to add furnace to.
heating – [Boolean] if true, the unit will include a heating coil.
cooling – [Boolean] if true, the unit will include a DX cooling coil.
ventilation – [Boolean] if true, the unit will include an OA intake.
heating_type – [String] valid choices are NaturalGas, Gas, Electricity, Electric.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_ground_hx_loop(model, system_name='Ground HX Loop')[source]¶

Creates loop that roughly mimics a properly sized ground heat exchanger.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object
system_name – [String] the name of the system, or None in which case it will be defaulted.

Returns:

[OpenStudio::Model::PlantLoop] the resulting plant loop.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_high_temp_radiant(model, thermal_zones, heating_type='NaturalGas', combustion_efficiency=0.8, control_type='MeanAirTemperature')[source]¶

Creates a high temp radiant heater for each zone and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
heating_type – [String] valid choices are NaturalGas, Electric.
combustion_efficiency – [Double] combustion efficiency as decimal.
control_type – [String] control type.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_hp_loop(model, heating_fuel='NaturalGas', cooling_fuel='Electricity', cooling_type='EvaporativeFluidCooler', system_name='Heat Pump Loop', sup_wtr_high_temp=87.0, sup_wtr_low_temp=67.0, dsgn_sup_wtr_temp=102.2, dsgn_sup_wtr_temp_delt=19.8)[source]¶

Creates a heat pump loop which has a boiler and fluid cooler.

Parameters:

object. (model [OpenStudio::Model::Model] OpenStudio model)
heating_fuel – [String]
cooling_fuel – [String] cooling fuel. Valid options are: Electricity, DistrictCooling.
cooling_type – [String] cooling type if not DistrictCooling. Valid options are: CoolingTower, CoolingTowerSingleSpeed, CoolingTowerTwoSpeed, CoolingTowerVariableSpeed, FluidCooler, FluidCoolerSingleSpeed, FluidCoolerTwoSpeed, EvaporativeFluidCooler, EvaporativeFluidCoolerSingleSpeed, EvaporativeFluidCoolerTwoSpeed
system_name – [String] the name of the system, or None in which case it will be defaulted
sup_wtr_high_temp – [Double] target supply water temperature to enable cooling in degrees Fahrenheit, default 65.0F
sup_wtr_low_temp – [Double] target supply water temperature to enable heating in degrees Fahrenheit, default 41.0F
dsgn_sup_wtr_temp – [Double] design supply water temperature in degrees Fahrenheit, default 102.2F
dsgn_sup_wtr_temp_delt – [Double] design supply-return water temperature difference in degrees Rankine, default 19.8R.

Returns:

[OpenStudio::Model::PlantLoop] the resulting plant loop.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_hvac_system(model, system_type, main_heat_fuel, zone_heat_fuel, cool_fuel, zones, hot_water_loop_type='HighTemperature', chilled_water_loop_cooling_type='WaterCooled', heat_pump_loop_cooling_type='EvaporativeFluidCooler', air_loop_heating_type='Water', air_loop_cooling_type='Water', zone_equipment_ventilation=True, fan_coil_capacity_control_method='CyclingFan')[source]¶

Add the a system type to the zones based on the specified template.

For multi-zone system types, add one system per story.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
system_type – [String] The system type.
main_heat_fuel – [String] Main heating fuel used for air loops and plant loops.
zone_heat_fuel – [String] Zone heating fuel for zone hvac equipment and terminal units.
cool_fuel – [String] Cooling fuel used for air loops, plant loops, and zone equipment.
zones – [Array<OpenStudio::Model::ThermalZone>] array of thermal zones served by the system.
hot_water_loop_type – [String] Archetype for hot water loops. Either HighTemperature (180F supply) (default) or LowTemperature (120F supply). Only used if HVAC system has a hot water loop.
loops. (chilled_water_loop_cooling_type [String] Archetype for chilled water) –
Only used if HVAC system has a chilled water loop and cool_fuel is Electricity. Options are.
- AirCooled
- WaterCooled
heat_pump_loop_cooling_type –
[String] the type of cooling equipment for heat pump loops if not DistrictCooling. Valid options are.
- CoolingTower
- CoolingTowerSingleSpeed
- CoolingTowerTwoSpeed
- CoolingTowerVariableSpeed
- FluidCooler
- FluidCoolerSingleSpeed
- FluidCoolerTwoSpeed
- EvaporativeFluidCooler
- EvaporativeFluidCoolerSingleSpeed
- EvaporativeFluidCoolerTwoSpeed
air_loop_heating_type –
[String] type of heating coil serving main air loop. Options are.
- Gas
- DX
- Water
air_loop_cooling_type –
[String] type of cooling coil serving main air loop. Options are.
- DX
- Water
zone_equipment_ventilation – [Boolean] toggle whether to include outdoor air ventilation on zone equipment including as fan coil units, VRF terminals, or water source heat pumps.
fan_coil_capacity_control_method –
[String] Only applicable to Fan Coil system type. Capacity control method for the fan coil. If VariableFan, the fan will be VariableVolume. Options are.
- ConstantFanVariableFlow
- CyclingFan
- VariableFanVariableFlow
- VariableFanConstantFlow.

Returns:

Returns True if successful, False if not.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_hw_loop(model, boiler_fuel_type, ambient_loop=None, system_name='Hot Water Loop', dsgn_sup_wtr_temp=180.0, dsgn_sup_wtr_temp_delt=20.0, pump_spd_ctrl='Variable', pump_tot_hd=None, boiler_draft_type=None, boiler_eff_curve_temp_eval_var=None, boiler_lvg_temp_dsgn=None, boiler_out_temp_lmt=None, boiler_max_plr=None, boiler_sizing_factor=None)[source]¶

Create a hot water loop with a boiler, district heat, or water-to-water heat pump.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object
boiler_fuel_type – [String] valid choices are Electricity, NaturalGas, Propane, PropaneGas, FuelOilNo1, FuelOilNo2, DistrictHeating, DistrictHeatingWater, DistrictHeatingSteam, HeatPump
ambient_loop – [OpenStudio::Model::PlantLoop] The condenser loop for the heat pump. Only used when boiler_fuel_type is HeatPump.
system_name – [String] the name of the system. If None, it will be defaulted.
dsgn_sup_wtr_temp – [Double] design supply water temperature in degrees Fahrenheit, default 180F.
dsgn_sup_wtr_temp_delt – [Double] design supply-return water temperature difference in degrees Rankine, default 20R.
pump_spd_ctrl – [String] pump speed control type, Constant or Variable (default).
pump_tot_hd – [Double] pump head in ft H2O.
boiler_draft_type – [String] Boiler type Condensing, MechanicalNoncondensing, Natural (default).
boiler_eff_curve_temp_eval_var – [String] LeavingBoiler or EnteringBoiler temperature for the boiler efficiency curve.
boiler_lvg_temp_dsgn – [Double] boiler leaving design temperature in degrees Fahrenheit.
boiler_out_temp_lmt – [Double] boiler outlet temperature limit in degrees Fahrenheit.
boiler_max_plr – [Double] boiler maximum part load ratio.
boiler_sizing_factor – [Double] boiler oversizing factor.

Returns:

[OpenStudio::Model::PlantLoop] the resulting hot water loop.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_low_temp_radiant(model, thermal_zones, hot_water_loop, chilled_water_loop, plant_supply_water_temperature_control=False, plant_supply_water_temperature_control_strategy='outdoor_air', hwsp_at_oat_low=120.0, hw_oat_low=55.0, hwsp_at_oat_high=80.0, hw_oat_high=70.0, chwsp_at_oat_low=70.0, chw_oat_low=65.0, chwsp_at_oat_high=55.0, chw_oat_high=75.0, radiant_type='floor', radiant_temperature_control_type='SurfaceFaceTemperature', radiant_setpoint_control_type='ZeroFlowPower', include_carpet=True, carpet_thickness_in=0.25, control_strategy='proportional_control', use_zone_occupancy_for_control=True, occupied_percentage_threshold=0.1, model_occ_hr_start=6.0, model_occ_hr_end=18.0, proportional_gain=0.3, switch_over_time=24.0, slab_sp_at_oat_low=73, slab_oat_low=65, slab_sp_at_oat_high=68, slab_oat_high=80, radiant_availability_type='precool', radiant_lockout=False, radiant_lockout_start_time=12.0, radiant_lockout_end_time=20.0)[source]¶

Adds low temperature radiant loop systems to each zone.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to add radiant loops.
hot_water_loop – [OpenStudio::Model::PlantLoop] the hot water loop that serves the radiant loop.
chilled_water_loop – [OpenStudio::Model::PlantLoop] the chilled water loop that serves the radiant loop.
plant_supply_water_temperature_control – [Bool] Set to True if the plant supply water temperature is to be controlled else it is held constant, default to false.
plant_supply_water_temperature_control_strategy –
[String] Method to determine how to control the plant’s supply water temperature. Options include. outdoor_air - Set the supply water temperature based on the outdoor

air temperature.

zone_demand - Set the supply water temperature based on the preponderance
of zone demand.
hwsp_at_oat_low – [Double] hot water plant supply water temperature setpoint, in F, at the outdoor low temperature.
hw_oat_low – [Double] hot water plant supply water temperature setpoint, in F, at the outdoor high temperature.
hw_oat_high – [Double] outdoor drybulb air temperature, in F, for high setpoint for hot water plant.
chwsp_at_oat_low – [Double] chilled water plant supply water temperature setpoint, in F, at the outdoor low temperature.
chw_oat_low – [Double] outdoor drybulb air temperature, in F, for low setpoint for chilled water plant.
chwsp_at_oat_high – [Double] chilled water plant supply water temperature setpoint, in F, at the outdoor high temperature.
chw_oat_high – [Double] outdoor drybulb air temperature, in F, for high setpoint for chilled water plant.
radiant_type –
[String] type of radiant system to create in zone. Valid options incllude the following.
- floor
- ceiling
- ceilingmetalpanel
- floorwithhardwood
radiant_temperature_control_type –
[String] determines the controlled temperature for the radiant system options include the following.
- MeanAirTemperature
- MeanRadiantTemperature
- OperativeTemperature
- OutdoorDryBulbTemperature
- OutdoorWetBulbTemperature
- SurfaceFaceTemperature
- SurfaceInteriorTemperature
radiant_setpoint_control_type –
[String] determines the response of the radiant system at setpoint temperature options include the following.
- ZeroFlowPower
- HalfFlowPower
include_carpet – [Boolean] boolean to include thin carpet tile over radiant slab, default to true.
carpet_thickness_in – [Double] thickness of carpet in inches.
control_strategy –
[String] name of control strategy. Options include the following.
- proportional_control
- oa_based_control
- constant_control
- none
If control strategy is proportional_control, the method will apply the CBE radiant control sequences detailed in Raftery et al. (2017) ‘A new control strategy for high thermal mass radiant systems’. If control strategy is oa_based_control, the method will apply native EnergyPlus objects/parameters to vary slab setpoint based on outdoor weather. If control strategy is constant_control, the method will apply native EnergyPlus objects/parameters to maintain a constant slab setpoint. Otherwise no control strategy will be applied and the radiant system will assume the EnergyPlus default controls.
use_zone_occupancy_for_control – [Boolean] Set to true if radiant system is to use specific zone occupancy objects for CBE control strategy. If False, then it will use values in model_occ_hr_start and model_occ_hr_end for all radiant zones. default to True.
occupied_percentage_threshold – [Double] the minimum fraction (0 to 1) that counts as occupied if this parameter is set, the returned ScheduleRuleset will be 0 = unoccupied, 1 = occupied. Otherwise the ScheduleRuleset will be the weighted fractional occupancy schedule. Only used if use_zone_occupancy_for_control is set to true.
model_occ_hr_start – [Double] (Optional) Only applies if control_strategy is proportional_control. Starting hour of building occupancy.
model_occ_hr_end – [Double] (Optional) Only applies if control_strategy is proportional_control. Ending hour of building occupancy.
proportional_gain – [Double] (Optional) Only applies if control_strategy is proportional_control. Proportional gain constant (recommended 0.3 or less).
switch_over_time – [Double] Time limitation for when the system can switch between heating and cooling
slab_sp_at_oat_low – [Double] radiant slab temperature setpoint, in F, at the outdoor high temperature.
slab_oat_low – [Double] outdoor drybulb air temperature, in F, for low radiant slab setpoint.
slab_sp_at_oat_high – [Double] radiant slab temperature setpoint, in F, at the outdoor low temperature.
slab_oat_high – [Double] outdoor drybulb air temperature, in F, for high radiant slab setpoint.
radiant_availability_type –
[String] a preset that determines the availability of the radiant system. Options include the following.
- all_day - radiant system is available 24 hours a day
- precool - primarily operates radiant system during night-time hours
- afternoon_shutoff - avoids operation during peak grid demand
- occupancy - operates radiant system during building occupancy hours
radiant_lockout – [Boolean] True if system contains a radiant lockout. If true, it will overwrite radiant_availability_type.
radiant_lockout_start_time – [double] decimal hour of when radiant lockout starts. Only used if radiant_lockout is True.
radiant_lockout_end_time – [double] decimal hour of when radiant lockout ends. Only used if radiant_lockout is True.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_minisplit_hp(model, thermal_zones, cooling_type='Two Speed DX AC', heating_type='Single Speed DX', hvac_op_sch=None)[source]¶

Creates a minisplit heatpump system for each zone and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
cooling_type – [String] valid choices are Two Speed DX AC, Single Speed DX AC, Single Speed Heat Pump.
heating_type – [String] valid choices are Single Speed DX.
hvac_op_sch – [String] name of the HVAC operation schedule or None in which case will be defaulted to always on.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_plant_supply_water_temperature_control(model, plant_water_loop, control_strategy='outdoor_air', sp_at_oat_low=None, oat_low=None, sp_at_oat_high=None, oat_high=None, thermal_zones=())[source]¶

Adds supply water temperature control on specified plant water loops.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
plant_water_loop – [OpenStudio::Model::PlantLoop] plant water loop to add supply water temperature control.
control_strategy –
[String] Method to determine how to control the plant’s supply water temperature (swt). Options include the following. outdoor_air – The plant’s swt will be proportional to the outdoor

air based on the next 4 parameters.

zone_demand – The plant’s swt will be determined by preponderance
of zone demand.
sp_at_oat_low – [Double] supply water temperature setpoint, in F, at the outdoor low temperature.
oat_low – [Double] outdoor drybulb air temperature, in F, for low setpoint.
sp_at_oat_high – [Double] supply water temperature setpoint, in F, at the outdoor high temperature.
oat_high – [Double] outdoor drybulb air temperature, in F, for high setpoint.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_psz_ac(model, thermal_zones, system_name=None, cooling_type='Single Speed DX AC', chilled_water_loop=None, hot_water_loop=None, heating_type=None, supplemental_heating_type=None, fan_location='DrawThrough', fan_type='ConstantVolume', hvac_op_sch=None, oa_damper_sch=None)[source]¶

Creates a PSZ-AC system for each zone and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
system_name – [String] the name of the system, or None in which case it will be defaulted.
cooling_type – [String] valid choices are Water, Two Speed DX AC, Single Speed DX AC, Single Speed Heat Pump, Water To Air Heat Pump.
chilled_water_loop – [OpenStudio::Model::PlantLoop] chilled water loop to connect cooling coil to, or None.
hot_water_loop – [OpenStudio::Model::PlantLoop] hot water loop to connect heating coil to, or None.
heating_type – [String] valid choices are NaturalGas, Electricity, Water, Single Speed Heat Pump, Water To Air Heat Pump, or None (no heat).
supplemental_heating_type – [String] valid choices are Electricity, NaturalGas, None (no heat).
fan_location – [String] valid choices are BlowThrough, DrawThrough.
fan_type – [String] valid choices are ConstantVolume, Cycling.
hvac_op_sch – [String] name of the HVAC operation schedule or None in which case will be defaulted to always on.
oa_damper_sch – [String] name of the oa damper schedule or None in which case will be defaulted to always open.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_psz_vav(model, thermal_zones, system_name=None, heating_type=None, cooling_type='AirCooled', supplemental_heating_type=None, hvac_op_sch=None, fan_type='VAV_System_Fan', oa_damper_sch=None, hot_water_loop=None, chilled_water_loop=None, minimum_volume_setpoint=None)[source]¶

Creates a packaged single zone VAV system for each zone.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
system_name – [String] the name of the system, or None in which case it will be defaulted.
heating_type – [String] valid choices are NaturalGas, Electricity, Water, None (no heat).
supplemental_heating_type – [String] valid choices are Electricity, NaturalGas, None (no heat).
hvac_op_sch – [String] name of the HVAC operation schedule or None in which case will be defaulted to always on.
oa_damper_sch – [String] name of the oa damper schedule or None in which case will be defaulted to always open.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_ptac(model, thermal_zones, cooling_type='Two Speed DX AC', heating_type='Gas', hot_water_loop=None, fan_type='Cycling', ventilation=True)[source]¶

Creates a PTAC system for each zone and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
cooling_type – [String] valid choices are Two Speed DX AC, Single Speed DX AC.
heating_type – [String] valid choices are NaturalGas, Electricity, Water, nil (no heat).
hot_water_loop – [OpenStudio::Model::PlantLoop] hot water loop to connect heating coil to. Set to nil for heating types besides water.
fan_type – [String] valid choices are ConstantVolume, Cycling.
ventilation – [Boolean] If True, ventilation will be supplied through the unit. If False, no ventilation will be supplied through the unit, with the expectation that it will be provided by a DOAS or separate system.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_pthp(model, thermal_zones, fan_type='Cycling', ventilation=True)[source]¶

Creates a PTHP system for each zone and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
fan_type – [String] valid choices are ConstantVolume, Cycling.
ventilation – [Boolean] If true, ventilation will be supplied through the unit. If False, no ventilation will be supplied through the unit, with the expectation that it will be provided by a DOAS or separate system.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_pvav(model, thermal_zones, system_name=None, return_plenum=None, hot_water_loop=None, chilled_water_loop=None, heating_type=None, electric_reheat=False, hvac_op_sch=None, oa_damper_sch=None, econo_ctrl_mthd=None)[source]¶

Creates a packaged VAV system and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
system_name – [String] the name of the system, or None in which case it will be defaulted.
return_plenum – [OpenStudio::Model::ThermalZone] the zone to attach as the supply plenum, or None, in which case no return plenum will be used.
hot_water_loop – [OpenStudio::Model::PlantLoop] hot water loop to connect heating and reheat coils to. If None, will be electric heat and electric reheat.
chilled_water_loop – [OpenStudio::Model::PlantLoop] chilled water loop to connect cooling coils to. If None, will be DX cooling.
heating_type – [String] main heating coil fuel type. Valid choices are NaturalGas, Electricity, Water, or None (defaults to NaturalGas).
electric_reheat – [Boolean] if true electric reheat coils, if false the reheat coils served by hot_water_loop.
hvac_op_sch – [String] name of the HVAC operation schedule or None in which case will be defaulted to always on.
oa_damper_sch – [String] name of the oa damper schedule or None in which case will be defaulted to always open.
econo_ctrl_mthd – [String] economizer control type.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_pvav_pfp_boxes(model, thermal_zones, system_name=None, chilled_water_loop=None, hvac_op_sch=None, oa_damper_sch=None, fan_efficiency=0.62, fan_motor_efficiency=0.9, fan_pressure_rise=4.0)[source]¶

Creates a packaged VAV system with parallel fan powered boxes.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
system_name – [String] the name of the system, or None in which case it will be defaulted.
chilled_water_loop – [OpenStudio::Model::PlantLoop] chilled water loop to connect cooling coils to. If None, will be DX cooling.
hvac_op_sch – [String] name of the HVAC operation schedule or None in which case will be defaulted to always on.
oa_damper_sch – [String] name of the oa damper schedule or None in which case will be defaulted to always open.
fan_efficiency – [Double] fan total efficiency, including motor and impeller.
fan_motor_efficiency – [Double] fan motor efficiency.
fan_pressure_rise – [Double] fan pressure rise, inH2O.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_residential_erv(model, thermal_zones)[source]¶

Add residential zone level ERVs for each zone.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to add heat pumps to.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_residential_ventilator(model, thermal_zones)[source]¶

Add a residential ventilation.

Ventilators are standalone unit ventilation and zone exhaust that operates to provide OA, used in conjuction with a system that having mechanical cooling and a heating coil.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to enable ideal air loads.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_unitheater(model, thermal_zones, hvac_op_sch=None, fan_control_type='ConstantVolume', fan_pressure_rise=0.2, heating_type=None, hot_water_loop=None, rated_inlet_water_temperature=180.0, rated_outlet_water_temperature=160.0, rated_inlet_air_temperature=60.0, rated_outlet_air_temperature=104.0)[source]¶

Creates a unit heater for each zone and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
hvac_op_sch – [String] name of the HVAC operation schedule or None in which case will be defaulted to always on.
fan_control_type – [String] valid choices are OnOff, ConstantVolume, VariableVolume.
fan_pressure_rise – [Double] fan pressure rise, inH2O.
heating_type – [String] valid choices are NaturalGas, Gas, Electricity, Electric, DistrictHeating, DistrictHeatingWater, DistrictHeatingSteam.
hot_water_loop – [OpenStudio::Model::PlantLoop] hot water loop to connect to the heating coil.
rated_inlet_water_temperature – [Double] rated inlet water temperature in degrees Fahrenheit, default is 180F.
rated_outlet_water_temperature – [Double] rated outlet water temperature in degrees Fahrenheit, default is 160F.
rated_inlet_air_temperature – [Double] rated inlet air temperature in degrees Fahrenheit, default is 60F.
rated_outlet_air_temperature – [Double] rated outlet air temperature in degrees Fahrenheit, default is 100F.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_vav_pfp_boxes(model, thermal_zones, system_name=None, chilled_water_loop=None, hvac_op_sch=None, oa_damper_sch=None, fan_efficiency=0.62, fan_motor_efficiency=0.9, fan_pressure_rise=4.0)[source]¶

Creates a VAV system with parallel fan powered boxes and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
system_name – [String] the name of the system, or None in which case it will be defaulted.
chilled_water_loop – [OpenStudio::Model::PlantLoop] chilled water loop to connect to the cooling coil.
hvac_op_sch – [String] name of the HVAC operation schedule or None in which case will be defaulted to always on.
oa_damper_sch – [String] name of the oa damper schedule or None in which case will be defaulted to always open.
fan_efficiency – [Double] fan total efficiency, including motor and impeller.
fan_motor_efficiency – [Double] fan motor efficiency.
fan_pressure_rise – [Double] fan pressure rise, inH2O.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_vav_reheat(model, thermal_zones, system_name=None, return_plenum=None, heating_type=None, reheat_type=None, hot_water_loop=None, chilled_water_loop=None, hvac_op_sch=None, oa_damper_sch=None, fan_efficiency=0.62, fan_motor_efficiency=0.9, fan_pressure_rise=4.0, min_sys_airflow_ratio=0.3, vav_sizing_option='Coincident', econo_ctrl_mthd=None)[source]¶

Creates a VAV system and adds it to the model.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to connect to this system.
system_name – [String] the name of the system, or None in which case it will be defaulted.
return_plenum – [OpenStudio::Model::ThermalZone] the zone to attach as the supply plenum, or None, in which case no return plenum will be used.
heating_type – [String] main heating coil fuel type. valid choices are NaturalGas, Gas, Electricity, HeatPump, DistrictHeating, DistrictHeatingWater, DistrictHeatingSteam, or None (defaults to NaturalGas).
reheat_type – [String] valid options are NaturalGas, Gas, Electricity Water, None (no heat).
hot_water_loop – [OpenStudio::Model::PlantLoop] hot water loop to connect heating and reheat coils to.
chilled_water_loop – [OpenStudio::Model::PlantLoop] chilled water loop to connect cooling coil to.
hvac_op_sch – [String] name of the HVAC operation schedule or None in which case will be defaulted to always on.
oa_damper_sch – [String] name of the oa damper schedule, or None in which case will be defaulted to always open.
fan_efficiency – [Double] fan total efficiency, including motor and impeller.
fan_motor_efficiency – [Double] fan motor efficiency.
fan_pressure_rise – [Double] fan pressure rise, inH2O.
min_sys_airflow_ratio – [Double] minimum system airflow ratio.
vav_sizing_option – [String] air system sizing option, Coincident or NonCoincident.
econo_ctrl_mthd – [String] economizer control type.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_vrf(model, thermal_zones, ventilation=False)[source]¶

Adds Variable Refrigerant Flow system and terminal units for each zone

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to add fan coil units.
ventilation – [Boolean] If True, ventilation will be supplied through the unit. If False, no ventilation will be supplied through the unit, with the expectation that it will be provided by a DOAS or separate system.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_vsd_twr_fan_curve(model)[source]¶: Add a curve to be used for cooling tower fans.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_water_source_hp(model, thermal_zones, condenser_loop, ventilation=True)[source]¶

Adds zone level water-to-air heat pumps for each zone.

Parameters:

object. (model [OpenStudio::Model::Model] OpenStudio model)
zones (thermal_zones [Array<OpenStudio::Model::ThermalZone>] array of) – served by heat pumps.
for (condenser_loop [OpenStudio::Model::PlantLoop] the condenser loop) – the heat pumps.
true (ventilation [Boolean] if) – If false, no ventilation will be supplied through the unit, with the expectation that it will be provided by a DOAS or separate system.
unit. (ventilation will be supplied through the) – If false, no ventilation will be supplied through the unit, with the expectation that it will be provided by a DOAS or separate system.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_waterside_economizer(model, chilled_water_loop, condenser_water_loop, integrated=True)[source]¶

Adds a waterside economizer to the chilled water and condenser loop.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
true (integrated [Boolean] when set to) – Integrated - in series with chillers, can run simultaneously with chillers Non-Integrated - in parallel with chillers, chillers locked out during operation
economizer. (models an integrated waterside) – Integrated - in series with chillers, can run simultaneously with chillers Non-Integrated - in parallel with chillers, chillers locked out during operation

honeybee_openstudio.hvac.standards.hvac_systems.model_add_window_ac(model, thermal_zones)[source]¶

Adds a window air conditioner to each zone. Code adapted from.

https://github.com/NREL/OpenStudio-BEopt/blob/master/measures/ ResidentialHVACRoomAirConditioner/measure.rb

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to add window AC units to.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_zone_erv(model, thermal_zones)[source]¶

Adds zone level ERVs for each zone.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to add heat pumps to.

honeybee_openstudio.hvac.standards.hvac_systems.model_add_zone_heat_cool_request_count_program(model, thermal_zones)[source]¶

Make EMS program that will compare ‘measured’ zone air temperatures to setpoints.

This can be used to determine if zone needs cooling or heating. Program will output the total zones needing heating and cooling and the their ratio using the total number of zones.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
thermal_zones – [Array<OpenStudio::Model::ThermalZone>] array of zones to dictate cooling or heating mode of water plant.

honeybee_openstudio.hvac.standards.hvac_systems.model_get_or_add_ambient_water_loop(model)[source]¶

Get the existing ambient water loop or add a new one if there isn’t one already.

Parameters:: model – [OpenStudio::Model::Model] OpenStudio model object.

honeybee_openstudio.hvac.standards.hvac_systems.model_get_or_add_chilled_water_loop(model, cool_fuel, chilled_water_loop_cooling_type='WaterCooled')[source]¶

Get existing chilled water loop or add a new one if there isn’t one already.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
cool_fuel – [String] the cooling fuel. Valid choices are Electricity, DistrictCooling, and HeatPump.
chilled_water_loop_cooling_type – [String] Archetype for chilled water loops, AirCooled or WaterCooled.

honeybee_openstudio.hvac.standards.hvac_systems.model_get_or_add_ground_hx_loop(model)[source]¶

Get the existing ground heat exchanger loop or add a new one if there isn’t one.

Parameters:: model – [OpenStudio::Model::Model] OpenStudio model object.

honeybee_openstudio.hvac.standards.hvac_systems.model_get_or_add_heat_pump_loop(model, heat_fuel, cool_fuel, heat_pump_loop_cooling_type='EvaporativeFluidCooler')[source]¶

honeybee_openstudio.hvac.standards.hvac_systems.model_get_or_add_hot_water_loop(model, heat_fuel, hot_water_loop_type='HighTemperature')[source]¶

Get existing hot water loop or add a new one if there isn’t one already.

Parameters:

model – [OpenStudio::Model::Model] OpenStudio model object.
heat_fuel – [String] the heating fuel. Valid choices are NaturalGas, Electricity, DistrictHeating, DistrictHeatingWater, DistrictHeatingSteam.
hot_water_loop_type – [String] Archetype for hot water loops.

honeybee_openstudio.hvac.standards.hvac_systems.standard_design_sizing_temperatures()[source]¶: Get a dictionary of design sizing temperatures for lookups.