Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Deconstruct a ProgramType object into its component load objects.
program [Required]
A ProgramType object or text for the identifier of a ProgramType to be looked up in the program type library.
people
A People object that describes the occupancy of the program. If None, no people are assumed to occupy the program.
lighting
A Lighting object that describes the lighting usage of the program. If None, no lights are assumed to be installed.
electric_equip
An ElectricEquipment object to describe the usage of electric equipment within the program. If None, no electric equipment is assumed to be installed.
gas_equip
A GasEquipment object to describe the usage of gas equipment within the program. If None, no gas equipment is assumed to be installed.
hot_water
A ServiceHotWater object to describe the usage of hot water within the program. If None, no hot water is be assumed for the program.
infiltration
An Infiltration object to describe the outdoor air leakage of the program. If None, no infiltration is be assumed for the program.
ventilation
A Ventilation object to describe the minimum outdoor air requirement of the program. If None, no ventilation requirement is be assumed for the program.
setpoint
A Setpoint object to describe the temperature and humidity setpoints of the program. If None, the ProgramType cannot be assigned to a Room that is conditioned.
Apply or edit load values on a Room or ProgramType.
This component will not edit any of the schedule objects associated with each load value. If no schedule currently exists to describe how the load varies over the simulation, the "Always On" schedule will be used as a default.
room_or_program [Required]
Honeybee Rooms or ProgramType objects to which the input load objects should be assigned. This can also be the identifier of a ProgramType to be looked up in the program type library. This can also be a Honeybee Model for which all Rooms will be assigned the loads.
people_per_floor
A numerical value for the number of people per square meter of floor area.
lighting_per_floor
A numerical value for the lighting power density in Watts per square meter of floor area.
electric_per_floor
A numerical value for the electric equipment power density in Watts per square meter of floor area.
gas_per_floor
A numerical value for the gas equipment power density in Watts per square meter of floor area.
hot_wtr_per_floor
A numerical value for the total volume flow rate of water per unit area of floor in (L/h-m2).
infilt_per_exterior
A numerical value for the intensity of infiltration in m3/s per square meter of exterior surface area. Typical values for this property are as follows (note all values are at typical building pressures of ~4 Pa):
vent_per_floor
A numerical value for the intensity of outdoor air ventilation in m3/s per square meter of floor area. This will be added to the vent_per_person_ and vent_ach_ to produce the final minimum outdoor air specification.
vent_per_person
A numerical value for the intensity of outdoor air ventilation in m3/s per person. This will be added to the vent_per_floor_, and vent_ach_ to produce the final minimum outdoor air specification. Note that setting this value does not mean that ventilation is varied based on real-time occupancy but rather that the minimum level of ventilation is determined using this value and the People object of the zone. To vary ventilation on a timestep basis, a ventilation schedule should be used or the dcv_ option should be selected on the HVAC system if it is available.
vent_ach
A numerical value for the intensity of outdoor air ventilation in air changes er hour (ACH). This will be added to the vent_per_floor_ and vent_per_person_ to produce the final minimum outdoor air specification.
report
Reports, errors, warnings, etc.
mod_obj
The input Rooms or ProgramTypes with their load values modified.
Apply ProgramType objects to Rooms or a Model.
rooms [Required]
Honeybee Rooms to which the input program should be assigned. This can also be a Honeybee Model for which all Rooms will be assigned the ProgramType.
program [Required]
A ProgramType object to apply to the input rooms. This can also be text for the program of the Rooms (to be looked up in the ProgramType library) such as that output from the "HB List Programs" component.
overwrite
A Boolean to note whether any loads assigned specifically to the Room, which overwrite the loads of ProgramType should be reset so that they are determined by the input program. (Default: False).
report
Reports, errors, warnings, etc.
rooms
The input Rooms with their loads edited.
Apply absolute load values to Rooms.
Note that, while the assigned load values are absolute, this component will convert them to the "normalized" value for each room (eg. lighting per floor area) in order to apply them to the rooms. So any existing specification of load intensity is overwritten with the absolute load here.
This also means that, if a room has no floors (or exterior walls for infiltration), the resulting load values will be equal to 0 regardless of the input here. The only exception is the vent_flow_, which will be applied regardless of the room properties.
This component will not edit any of the schedules or other properties associated with each load value. If no schedule currently exists to describe how the load varies over the simulation, the "Always On" schedule will be used as a default.
rooms [Required]
Honeybee Rooms to which the input load values should be assigned. This can also be a Honeybee Model for which all Rooms will be assigned the loads.
person_count
A number for the quantity of people in the room.
lighting_watts
A number for the installed wattage of lighting in the room (W).
electric_watts
A number for the installed wattage of electric equipment in the room (W).
gas_watts
A number for the installed wattage of gas equipment in the room (W).
hot_wtr_flow
Number for the peak flow rate of service hot water in the room in liters per hour (L/h).
infiltration_ach
A number for the infiltration flow rate in air changes per hour (ACH).
vent_flow
A numerical value for the absolute of flow of outdoor air ventilation for the room in cubic meters per second (m3/s). Note that inputting a value here will overwrite all specification of outdoor air ventilation currently on the room (per_floor, per_person, ach).
report
Reports, errors, warnings, etc.
rooms
The input Rooms with their load values modified.
Apply simple daylight controls to Rooms.
Such simple controls will dim the lights in the energy simulation according to whether the illuminance at a sensor location is at a target illuminance setpoint. The method used to estimate illuiminance is fairly simple and, for more detailed control over the parameters used to compute illuminance, the "HB Daylight Control Schedule" component under HB-Radiance should be used.
rooms [Required]
Honeybee Rooms to which simple daylight controls should be assigned. This can also be a Honeybee Model for which all Rooms will be assigned daylight control sensors.
sensor_points
A list of point objects that align with the input _rooms and assign the position of the daylight sensor within the Room. This point should lie within the Room volume and a warning will be thrown and no daylight controls assigned for any point that lies outside the corresponding room. If unspecified, the sensor will be assigned to the center of the room at 0.8 meters above the floor. Note that such a center point might lie outside rooms that are significantly concave and no daylight controls will be assigned to these rooms in this case.
ill_setpoint
A number for the illuminance setpoint in lux beyond which electric lights are dimmed if there is sufficient daylight. Some common setpoints are listed below. (Default: 300 lux). 50 lux - Corridors and hallways. 150 lux - Computer work spaces (screens provide illumination). 300 lux - Paper work spaces (reading from surfaces that need illumination). 500 lux - Retail spaces or museums illuminating merchandise/artifacts. 1000 lux - Operating rooms and workshops where light is needed for safety.
control_fract
A number between 0 and 1 that represents the fraction of the Room lights that are dimmed when the illuminance at the sensor position is at the specified illuminance. 1 indicates that all lights are dim-able while 0 indicates that no lights are dim-able. Deeper rooms should have lower control fractions to account for the face that the lights in the back of the space do not dim in response to suitable daylight at the front of the room. (Default: 1).
min_power_in
A number between 0 and 1 for the the lowest power the lighting system can dim down to, expressed as a fraction of maximum input power. (Default: 0.3).
min_light_out
A number between 0 and 1 the lowest lighting output the lighting system can dim down to, expressed as a fraction of maximum light output. (Default: 0.2).
off_at_min
Boolean to note whether lights should switch off completely when they get to the minimum power input. (Default: False).
report
Reports, errors, warnings, etc.
rooms
The input Rooms with simple daylight controls assigned to them.
-
Create a Lighting object that can be used to create a ProgramType or be assigned directly to a Room.
name
Text to set the name for the Lighting and to be incorporated into a unique Lighting identifier. If None, a unique name will be generated.
watts_per_area [Required]
A numerical value for the lighting power density in Watts per square meter of floor area.
schedule [Required]
A fractional for the use of lights over the course of the year. The fractional values will get multiplied by the _watts_per_area to yield a complete lighting profile.
radiant_fract
A number between 0 and 1 for the fraction of the total lighting load given off as long wave radiant heat.
visible_fract
A number between 0 and 1 for the fraction of the total lighting load given off as short wave visible light.
return_fract
A number between 0 and 1 for the fraction of the total lighting load that goes into the zone return air (into the zone outlet node). Default: 0.0 (representative of pendant lighting).
baseline
An optional number for the baseline lighting power density in W/m2 of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1. If set to None, it will default to 11.84029 W/m2, which is that ASHRAE 90.1-2004 baseline for an office.
lighting
A Lighting object that can be used to create a ProgramType or be assigned directly to a Room.
-
Create a People object that can be used to create a ProgramType or be assigned directly to a Room.
name
Text to set the name for the People and to be incorporated into a unique People identifier. If None, a unique name will be generated.
ppl_per_area [Required]
A numerical value for the number of people per square meter of floor area.
occupancy_sch [Required]
A fractional schedule for the occupancy over the course of the year. The fractional values in this schedule will get multiplied by the _people_per_area to yield a complete occupancy profile.
activity_sch
A schedule for the activity of the occupants over the course of the year. The type limt of this schedule should be "Activity Level" and the values of the schedule equal to the number of Watts given off by an individual person in the room. If None, it will a default constant schedule with 120 Watts per person will be used, which is typical of awake, adult humans who are seated.
latent_fraction
An optional number between 0 and 1 for the fraction of the heat given off by people that is latent (as opposed to sensible). when unspecified, this will be autocalculated based on the activity level and the conditions in the room at each timestep of the simulation. The autocalculation therefore accounts for the change in heat loss through respiration and sweating that occurs at warmer temperatures and higher activity levels, which is generally truer to physics compared to a fixed number.
people
A People object that can be used to create a ProgramType or be assigned directly to a Room.
-
Create an Equipment object that can be used to specify equipment usage in a ProgramType.
name
Text to set the name for the Equipment and to be incorporated into a unique Equipment identifier. If None, a unique name will be generated.
watts_per_area [Required]
A numerical value for the equipment power density in Watts per square meter of floor area.
schedule [Required]
A fractional schedule for the use of equipment over the course of the year. The fractional values will get multiplied by the _watts_per_area to yield a complete equipment profile.
radiant_fract
A number between 0 and 1 for the fraction of the total equipment load given off as long wave radiant heat. (Default: 0).
latent_fract
A number between 0 and 1 for the fraction of the total equipment load that is latent (as opposed to sensible). (Default: 0).
lost_fract
A number between 0 and 1 for the fraction of the total equipment load that is lost outside of the zone and the HVAC system. Typically, this is used to represent heat that is exhausted directly out of a zone (as you would for a stove). (Default: 0).
gas
Set to "True" to have the output Equipment object be for GasEquipment (as opposed to ElectricEquipment).
equip
An Equipment object that can be used to specify equipment usage in a ProgramType.
-
Create an Infiltration object that can be used to create a ProgramType or be assigned directly to a Room.
name
Text to set the name for the Infiltration and to be incorporated into a unique Infiltration identifier. If None, a unique name will be generated.
flow_per_ext_area [Required]
A numerical value for the intensity of infiltration in m3/s per square meter of exterior surface area. Typical values for this property are as follows (note all values are at typical building pressures of ~4 Pa):
0.0001 (m3/s per m2 facade) - Tight building
0.0003 (m3/s per m2 facade) - Average building
0.0006 (m3/s per m2 facade) - Leaky building
schedule
A fractional schedule for the infiltration over the course of the year. The fractional values will get multiplied by the flow_per_exterior_area to yield a complete infiltration profile.
infil
An Infiltration object that can be used to create a ProgramType or be assigned directly to a Room.
-
Apply values for setpoints to a Room or ProgramType.
room_or_program [Required]
Honeybee Rooms or ProgramType objects to which the input setpoints should be assigned. This can also be the identifier of a ProgramType to be looked up in the program type library. This can also be a Honeybee Model for which all Rooms will be assigned the setpoints.
cooling_setpt
A numerical value for a single constant temperature for the cooling setpoint [C].
heating_setpt
A numerical value for a single constant temperature for the heating setpoint [C].
humid_setpt
A numerical value for a single constant value for the humidifying setpoint [%].
dehumid_setpt
A numerical value for a single constant value for the dehumidifying setpoint [%].
cutout_difference
An optional positive number for the temperature difference between the cutout temperature and the setpoint temperature. Specifying a non-zero number here is useful for modeling the throttling range associated with a given setup of setpoint controls and HVAC equipment. Throttling ranges describe the range where a zone is slightly over-cooled or over-heated beyond the thermostat setpoint. They are used to avoid situations where HVAC systems turn on only to turn off a few minutes later, thereby wearing out the parts of mechanical systems faster. They can have a minor impact on energy consumption and can often have significant impacts on occupant thermal comfort, though using the default value of zero will often yield results that are close enough when trying to estimate the annual heating/cooling energy use. Specifying a value of zero effectively assumes that the system will turn on whenever conditions are outside the setpoint range and will cut out as soon as the setpoint is reached. (Default: 0).
report
Reports, errors, warnings, etc.
mod_obj
The input Rooms or ProgramTypes with their setpoint values edited.
-
Apply process loads to Rooms.
Examples of process loads include wood burning fireplaces, kilns, manufacturing equipment, and various industrial processes. They can also be used to represent certain specialized pieces of equipment to be separated from the other end uses, such as MRI machines, theatrical lighting, elevators, etc.
rooms [Required]
Honeybee Rooms to which process loads should be assigned.
name
Text to set the name for the Process load and to be incorporated into a unique Process load identifier. If None, a unique name will be generated.
watts [Required]
A number for the process load power in Watts.
schedule [Required]
A fractional schedule for the use of the process over the course of the year. The fractional values will get multiplied by the _watts to yield a complete process load profile.
fuel_type [Required]
Text to denote the type of fuel consumed by the process. Using the "None" type indicates that no end uses will be associated with the process, only the zone gains. Choose from the following.
use_category
Text to indicate the end-use subcategory, which will identify the process load in the EUI output. For example, “Cooking”, “Clothes Drying”, etc. (Default: General).
radiant_fract
A number between 0 and 1 for the fraction of the total process load given off as long wave radiant heat. (Default: 0).
latent_fract
A number between 0 and 1 for the fraction of the total process load that is latent (as opposed to sensible). (Default: 0).
lost_fract
A number between 0 and 1 for the fraction of the total process load that is lost outside of the zone and the HVAC system. Typically, this is used to represent heat that is exhausted directly out of a zone (as you would for a stove). (Default: 0).
report
Reports, errors, warnings, etc.
rooms
The input Rooms with process loads assigned to them.
Set up a Honeybee Model to use the EnergyPlus Airflow Network (AFN) for all airflow in the energy simulation.
Compared to the default single-zone methods that Honeybee uses for infiltration and ventilation, the AFN represents air flow in a manner that is truer to the fluid dynamic behavior of real buildings. In particular, the AFN more accurately models the flow of air from one zone to another, accounting for the pressure changes induced by wind and air density differences. However, using the AFN means that the simulation will take considerably longer to run compared to the single zone option and the difference in simuation resuts is only likely to be significant when the Model contains operable windows or the building is extremely leaky.
Passing a Honeybee Model through this component before energy simulation will result in the following changes to the EnergyPlus IDF:
All ZoneInfiltration objects will be excluded and, instead, infitration will be modeled with AFN Crack objects assigned to each opaque Face.
For all AirBoundary Faces within the Model, ZoneMixing objects will be excluded and, instead, the air boundary will be modeled with AFN Crack objects that have very large pressure coefficients derived from the orifice equation and the area of the air wall.
For all operable Apertures, ZoneVentilation:WindandStackOpenArea objects will be excluded and, instead, these opearable apertures will be modeled with AFN SimpleOpening objects.
For each Room with a VentilationControl object to specify setpoints at which the windows open, an Energy Management System (EMS) program will be written to dictate when the operable Apertures of the Room open.
model [Required]
A Honeybee Model for which the Airflow network will be set up. This Model should have everything assigned to it that is needed for simulation, including solved adjacencies and relevant window- opening properties.
leakage_template
Text identifying the leakiness of the Model, which is used to generate AFNCrack objects that represent infiltration for each of the Model's surfaces (Face, Aperture, and Door). Choose from the following.
Excellent
Medium
VeryPoor These three text values correspond to DesignBuilder's Cracks Templates, which provide typical crack flow coefficients and exponents for different envelope tightness classifications. If None, the exterior airflow leakage parameters will be derived from the room infiltration rate specified in the room's energy properties, which are in units of m3/s per m2 of facade. This derivation from the Room's infiltration will compute air leakage parameters for exterior cracks that produce a total air flow rate equivalent to the room's infiltration rate at an envelope pressure difference of 4 Pa. This default derivation is not as complete of a representation of building ariflow dynamics as the DesignBuilder Crack Templates are. However, since the airflow leakae parameters are derived from values in m3/s-m2 of infiltration, they are easier to relate to the results of infiltration blower-door tests, which typically express infiltration rates in these units.
delta_pressure
The air pressure difference across the building envelope in Pascals, which is used to calculate infiltration crack flow coefficients when no leakage tempate is specified. The resulting average simulated air pressure difference will roughly equal this delta pressure times the nth root of the ratio between the simulated and target room infiltration rates. (Default: 4).
ref_pressure
The reference barometric pressure measurement in Pascals under which the surface crack data were obtained. (Default: 101325).
high_rise
Booling indicating whether the Model is LowRise or HighRise. This parameter is used to estimate building-wide wind pressure coefficients for the AFN by approximating the building geometry as an extruded rectangle. LowRise corresponds to a building where the height is less then three times the width AND length of the footprint. HighRise corresponds to a building where height is more than three times the width OR length of the footprint. If None, this property will be auto-calculated from Room geometry of the Model. This default assumption may not be appropriate if the Model represents only a portion of a larger Building.
long_axis
A number between 0 and 180 for the clockwise angle difference in degrees that the long axis of the building is from true North. This parameter is used to estimate building-wide wind pressure coefficients for the AFN by approximating the building geometry as an extruded rectangle. 0 indicates a North-South long axis while 90 indicates an East-West long axis. If None, this property will be auto-calculated from Room geometry of the Model (either 0 or 90). This default assumption may not be appropriate if the Model represents only a portion of a larger Building.
aspect_ratio
A number between 0 and 1 for the aspect ratio of the building's footprint, defined as the ratio of length of the short axis divided by the length of the long axis. This parameter is used to estimate building-wide wind pressure coefficients for the AFN by approximating the building geometry as an extruded rectangle If None, this property will be auto-calculated from Room geometry of the Model and the long_axis above. This default assumption may not be appropriate if the Model represents only a portion of a larger building.
report
...
model
The input Honeybee Model for which the Airflow network has been set up.
Create a Setpoint object that can be used to create a ProgramType or be assigned directly to a Room.
name
Text to set the name for the Setpoint and to be incorporated into a unique Setpoint identifier. If None, a unique name will be generated.
heating_sch [Required]
A temperature schedule for the heating setpoint. The type limit of this schedule should be temperature and the values should be the temperature setpoint in degrees Celcius.
cooling_sch [Required]
A temperature schedule for the cooling setpoint. The type limit of this schedule should be temperature and the values should be the temperature setpoint in degrees Celcius.
humid_setpt
A numerical value between 0 and 100 for the relative humidity humidifying setpoint [%]. This value will be constant throughout the year. If None, no humidification will occur.
dehumid_setpt
A numerical value between 0 and 100 for the relative humidity dehumidifying setpoint [%]. This value will be constant throughout the year. If None, no dehumidification will occur beyond that which is needed to create air at the cooling supply temperature.
cutout_difference
An optional positive number for the temperature difference between the cutout temperature and the setpoint temperature. Specifying a non-zero number here is useful for modeling the throttling range associated with a given setup of setpoint controls and HVAC equipment. Throttling ranges describe the range where a zone is slightly over-cooled or over-heated beyond the thermostat setpoint. They are used to avoid situations where HVAC systems turn on only to turn off a few minutes later, thereby wearing out the parts of mechanical systems faster. They can have a minor impact on energy consumption and can often have significant impacts on occupant thermal comfort, though using the default value of zero will often yield results that are close enough when trying to estimate the annual heating/cooling energy use. Specifying a value of zero effectively assumes that the system will turn on whenever conditions are outside the setpoint range and will cut out as soon as the setpoint is reached. (Default: 0).
setpoint
A Setpoint object that can be used to create a ProgramType or be assigned directly to a Room.
Add ventilation fans to Rooms.
This fan is not connected to any heating or cooling system and is meant to represent the intentional circulation of unconditioned outdoor air for the purposes of keeping a space cooler, drier or free of indoor pollutants (as in the case of kitchen or bathroom exhaust fans).
rooms [Required]
Honeybee Rooms to which ventilation fans should be assigned.
name
Text to set the name for the ventilation fan and to be incorporated into a unique ventilation fan identifier. If None, a unique name will be generated.
flow_rate [Required]
A positive number for the flow rate of the fan in m3/s.
vent_type
Text to indicate the type of type of ventilation. Choose from the options below. For either Exhaust or Intake, values for fan pressure and efficiency define the fan electric consumption. For Exhaust ventilation, the conditions of the air entering the space are assumed to be equivalent to outside air conditions. For Intake and Balanced ventilation, an appropriate amount of fan heat is added to the entering air stream. For Balanced ventilation, both an intake fan and an exhaust fan are assumed to co-exist, both having the same flow rate and power consumption (using the entered values for fan pressure rise and fan total efficiency). Thus, the fan electric consumption for Balanced ventilation is twice that for the Exhaust or Intake ventilation types which employ only a single fan. (Default: Balanced).
pressure_rise
A number for the the pressure rise across the fan in Pascals (N/m2). This is often a function of the fan speed and the conditions in which the fan is operating since having the fan blow air through filters or narrow ducts will increase the pressure rise that is needed to deliver the input flow rate. The pressure rise plays an important role in determining the amount of energy consumed by the fan. Smaller fans like a 0.05 m3/s desk fan tend to have lower pressure rises around 60 Pa. Larger fans, such as a 6 m3/s fan used for ventilating a large room tend to have higher pressure rises around 400 Pa. The highest pressure rises are typically for large fans blowing air through ducts and filters, which can have pressure rises as high as 1000 Pa. If this input is None, the pressure rise will be estimated from the flow_rate, with higher flow rates corresponding to larger pressure rises (up to 400 Pa). These estimated pressure rises are generally assumed to have minimal obstructions between the fan and the room and they should be increased if the fan is blowing air through ducts or filters.
efficiency
A number between 0 and 1 for the overall efficiency of the fan. Specifically, this is the ratio of the power delivered to the fluid to the electrical input power. It is the product of the fan motor efficiency and the fan impeller efficiency. Fans that have a higher blade diameter and operate at lower speeds with smaller pressure rises for their size tend to have higher efficiencies. Because motor efficiencies are typically between 0.8 and 0.9, the best overall fan efficiencies tend to be around 0.7 with most typical fan efficiencies between 0.5 and 0.7. The lowest efficiencies often happen for small fans in situations with high pressure rises for their size, which can result in efficiencies as low as 0.15. If None, this input will be estimated from the fan flow rate and pressure rise with large fans operating at low pressure rises for their size having up to 0.7 efficiency and small fans operating at high pressure rises for their size having as low as 0.15 efficiency.
vent_cntrl
A Ventilation Control object from the "HB Ventilation Control" component that dictates the conditions under which the fan is turned on. If None, the fan on all of the time.
report
Reports, errors, warnings, etc.
rooms
The input Rooms with ventilation fans assigned to them.
Create a Ventilation object that can be used to create a ProgramType or be assigned directly to a Room.
Note the the 4 ventilation types (flow_per_person, flow_per_area, flow_per_zone, ach) are ultimately summed together to yeild the ventilation design flow rate used in the simulation.
name
Text to set the name for the Ventilation and to be incorporated into a unique Ventilation identifier. If None, a unique name will be generated.
flow_per_person
A numerical value for the intensity of outdoor air ventilation in m3/s per person. This will be added to the flow_per_area, flow_per_zone and ach to produce the final minimum outdoor air specification. Note that setting this value here does not mean that ventilation is varied based on real-time occupancy but rather that the minimum level of ventilation is determined using this value and the People object of the Room. To vary ventilation on a timestep basis, a ventilation schedule should be used or the dcv_ option should be selected on the HVAC system if it is available. (Default: 0).
flow_per_area
A numerical value for the intensity of ventilation in m3/s per square meter of floor area. This will be added to the flow_per_person, flow_per_zone and ach to produce the final minimum outdoor air specification. (Default: 0).
flow_per_zone
A numerical value for the design level of ventilation in m3/s for the entire zone. This will be added to the flow_per_person, flow_per_area and ach to produce the final minimum outdoor air specification. (Default: 0).
ach
A numberical value for the design level of ventilation in air changes per hour (ACH) for the entire zone. This will be added to the flow_per_person, flow_per_area and flow_per_zone to produce the final minimum outdoor air specification. (Default: 0).
schedule
An optional fractional schedule for the ventilation over the course of the year. The fractional values will get multiplied by the total design flow rate (determined from the fields above and the calculation_method) to yield a complete ventilation profile. Setting this schedule to be the occupancy schedule of the zone will mimic demand controlled ventilation. If None, a constant design level of ventilation will be used throughout all timesteps of the simulation. (Default: None).
vent
An Ventilation object that can be used to create a ProgramType or be assigned directly to a Room.
Create an ServiceHotWater object that can be used to specify hot water usage in a ProgramType.
name
Text to set the name for the ServiceHotWater and to be incorporated into a unique ServiceHotWater identifier. If None, a unique name will be generated.
flow_per_area [Required]
A numerical value for the total volume flow rate of water per unit area of floor (L/h-m2).
schedule [Required]
A fractional schedule for the use of hot water over the course of the year. The fractional values will get multiplied by the _flow_per_area to yield a complete water usage profile.
target_temp
The target temperature of the water out of the tap in Celsius. This the temperature after the hot water has been mixed with cold water from the water mains. The default value assumes that the flow_per_area on this object is only for water straight out of the water heater. (Default: 60C).
sensible_fract
A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone. (Default: 0.2).
latent_fract
A number between 0 and 1 for the fraction of the total hot water load that is latent (as opposed to sensible). (Default: 0.05).
hot_water
A ServiceHotWater object that can be used to specify hot water usage in a ProgramType.
Create a Ventilation Control object to dictate the temperature setpoints and schedule for ventilative cooling (eg. opening windows).
Note the all of the default setpoints of this object are set to always perform ventilative cooling such that one can individually decide which setpoints are relevant to a given ventilation strategy.
min_in_temp
A number between -100 and 100 for the minimum indoor temperature at which to ventilate in Celsius. Typically, this variable is used to initiate ventilation with values around room temperature above which the windows will open (eg. 22 C). (Default: -100 C).
max_in_temp
A number between -100 and 100 for the maximum indoor temperature at which to ventilate in Celsius. This can be used to set a maximum temperature at which point ventilation is stopped and a cooling system is turned on. (Default: 100 C).
min_out_temp
A number between -100 and 100 for the minimum outdoor temperature at which to ventilate in Celsius. This can be used to ensure ventilative cooling doesn't happen during the winter even if the Room is above the min_in_temp. (Default: -100 C).
max_out_temp
A number between -100 and 100 for the maximum outdoor temperature at which to ventilate in Celsius. This can be used to set a limit for when it is considered too hot outside for ventilative cooling. (Default: 100).
delta_temp
A number between -100 and 100 for the temperature differential in Celsius between indoor and outdoor below which ventilation is shut off. This should usually be a positive number so that ventilation only occurs when the outdoors is cooler than the indoors. Negative numbers indicate how much hotter the outdoors can be than the indoors before ventilation is stopped. (Default: -100).
schedule
An optional schedule for the ventilation over the course of the year. This can also be the name of a schedule to be looked up in the standards library. Note that this is applied on top of any setpoints. The type of this schedule should be On/Off and values should be either 0 (no possibility of ventilation) or 1 (ventilation possible). (Default: "Always On")
vent_cntrl
HBZones with their airflow modified.
-
Convert infiltration flow per exterior area measured at a particular blower door pressure to flow per exterior area measured at a typical building pressure.
This is accomplished by computing a normalized-area air mass flow coefficient that is derived the power law relationship between pressure and air flow. Cqa = Qblow / dPblow^n And then using the coefficient to approximate air flow at typical building pressure. Qbldg = Cqa * dPbldg^n
where: Cqa: Air mass flow coefficient per unit meter at 1 Pa [kg/m2/s/P^n] Qblow: Blower-induced volumetric air flow rate per area [m3/s/m2] dPblow: Blower-induced change in pressure across building envelope orifice [Pa] Qbldg: Typical building volumetric air flow rate per area [m3/s/m2] dPbldg: Typical building change in pressure across building envelope orifice [Pa] d: Air density [1.2041 kg/m3] n: Air mass flow exponent [0.65]
infilt_per_exterior [Required]
A numerical value for the intensity of air flow induced by blower pressure in m3/s per square meter of exterior surface area.
blower_pressure
A number representing the pressure differential in Pascals (Pa) between indoors/outdoors at which the specified _infilt_per_exterior occurs. Typical pressures induced by blower doors are 75 Pa and 50 Pa. (Default: 75).
bldg_pressure
The reference air pressure difference across building envelope under typical conditions in Pascals. (Default: 4).
infilt
The intensity of infiltration in m3/s per square meter of exterior surface area at the input bldg_pressure.
C_qa
Air mass flow coefficient per square meter at 1 Pa [kg/m2/s/P^n].
-
Define the window opening properties for all operable apertures of a Room.
By default, the properties assigned by this component are translated into simple ZoneVentilation objects in the resulting IIDF, which can approximate airflow from both single-sided bouyancy-driven ventilation as well as wind-driven cross ventilation. Bouyancy-driven flow can happen for essentially all openings while wind-driven flow can only happen when there are pressure differences across windows on opposite sides of a Room.
Simple ZoneVentilation is computed using the following formulas:
VentilationWind = WindCoefficient OpeningArea Schedule WindSpeed VentilationStack = StackDischargeCoefficient OpeningArea ScheduleValue SQRT(2 GravityAccelration HeightNPL * (|(TempZone - TempOutdoors)| / TempZone)) TotalVentilation = SQRT((VentilationWind)^2 + (VentilationStack)^2)
Note that the (OpeningArea) term is derived from the fract_area_oper and the area of each aperture while the (HeightNPL) term is derived from the fract_height_oper and the height of each aperture. The "NPL" stands for "Neutral Plane" and the whole term represents the height from midpoint of lower opening to the neutral pressure level of the window (computed as 1/4 of the height of each Aperture in the translation from honeybee to IDF).
More complex airflow phenomena can be modeled by using this component in conjunction with with the Airflow Network (AFN) component. Note that the window opening properties assigned by this component are still relevant for such AFN simulations.
rooms [Required]
Honeybee Room objects to which window ventilation opening properties will be assigned. Note that this component only assigns such properties to operable Apertures on the rooms. If the is_operable property of any of a room's apertures is not True, no opening properties will be assigned.
vent_cntrl [Required]
A Ventilation Control object from the "HB Ventilation Control" component, which dictates the opening behaviour of the Room's apertures.
fract_area_oper
A number between 0.0 and 1.0 for the fraction of the window area that is operable. (Default: 0.5, typical of sliding windows).
fract_height_oper
A number between 0.0 and 1.0 for the fraction of the distance from the bottom of the window to the top that is operable. (Default: 1.0, typical of windows that slide horizontally).
discharge_coeff
A number between 0.0 and 1.0 that will be multipled by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. (Default: 0.45, for unobstructed windows with insect screens). This value should be lowered if windows are of an awning or casement type and not allowed to fully open. Some common values for this coefficient include the following.
0.0 - Completely discount stack ventilation from the calculation.
0.45 - For unobstructed windows with an insect screen.
0.65 - For unobstructed windows with NO insect screen.
wind_cross_vent
Boolean to indicate if there is an opening of roughly equal area on the opposite side of the Room such that wind-driven cross ventilation will be induced. If False, the assumption is that the operable area is primarily on one side of the Room and there is no wind-driven ventilation. If None, the normal vectors of the operable aperturs of the input _rooms will be analyzed. If window normals of a given room are found to have an angle difference greater than 90 degrees, cross ventilation will be set to True. Otherwise, it will be False.
report
...
rooms
The input Honeybee Rooms with their window-opening properties edited.
-
Deconstruct an Equipment object into its constituient properties.
equip [Required]
An ElectricEquipment or a GasEquipment object to be deconstructed.
name
An Equipment object that can be used to create a ProgramType or be assigned directly to a Room.
watts_per_area
A numerical value for the equipment power density in Watts per square meter of floor area.
schedule
A fractional for the use of equipment over the course of the year. The fractional values will get multiplied by the watts_per_area to yield a complete equipment profile.
radiant_fract
A number between 0 and 1 for the fraction of the total equipment load given off as long wave radiant heat.
latent_fract
A number between 0 and 1 for the fraction of the total equipment load that is latent (as opposed to sensible).
lost_fract
A number between 0 and 1 for the fraction of the total equipment load that is lost outside of the zone and the HVAC system. Typically, this is used to represent heat that is exhausted directly out of a zone (as you would for a stove).
is_gas
Will be True if the input Equipment object is for GasEquipment; False if it is for ElectricEquipment.
-
Deconstruct an Infiltration object into its constituient properties.
infil [Required]
An Infiltration object to be deconstructed.
name
Text string for the infiltration display name.
flow_per_ext_area
A numerical value for the intensity of infiltration in m3/s per square meter of exterior surface area. Typical values for this property are as follows (note all values are at typical building pressures of ~4 Pa):
0.0001 (m3/s per m2 facade) - Tight building
0.0003 (m3/s per m2 facade) - Average building
0.0006 (m3/s per m2 facade) - Leaky building
schedule
A fractional schedule for the infiltration over the course of the year. The fractional values will get multiplied by the flow_per_exterior_area to yield a complete infiltration profile.
-
Deconstruct a ServiceHotWater object into its constituient properties.
hot_water [Required]
A ServiceHotWater object to be deconstructed.
name
An Equipment object that can be used to create a ProgramType or be assigned directly to a Room.
flow_per_area
A numerical value for the total volume flow rate of water per unit area of floor (L/h-m2).
schedule
A fractional schedule for the use of hot water over the course of the year. The fractional values will get multiplied by the _flow_per_area to yield a complete water usage profile.
target_temp
The target temperature of the water out of the tap in Celsius. This the temperature after the hot water has been mixed with cold water from the water mains.
sensible_fract
A number between 0 and 1 for the fraction of the total hot water load given off as sensible heat in the zone.
latent_fract
A number between 0 and 1 for the fraction of the total hot water load that is latent (as opposed to sensible).
-
Deconstruct a Lighting object into its constituient properties.
lighting [Required]
A Lighting object to be deconstructed.
name
Text string for the lighting display name.
watts_per_area
A numerical value for the lighting power density in Watts per square meter of floor area.
schedule
A fractional for the use of lights over the course of the year. The fractional values will get multiplied by the watts_per_area to yield a complete lighting profile.
radiant_fract
A number between 0 and 1 for the fraction of the total lighting load given off as long wave radiant heat.
visible_fract
A number between 0 and 1 for the fraction of the total lighting load given off as short wave visible light.
return_fract
A number between 0 and 1 for the fraction of the total lighting load that goes into the zone return air.
baseline
The baseline lighting power density in W/m2 of floor area. This baseline is useful to track how much better the installed lights are in comparison to a standard like ASHRAE 90.1.
-
Deconstruct a People object into its constituient properties.
people [Required]
A People object to deconstruct.
name
Text string for the people object display name.
ppl_per_area
A numerical value for the number of people per square meter of floor area.
occupancy_sch
A fractional schedule for the occupancy over the course of the year. The fractional values in this schedule get multiplied by the _people_per_area to yield a complete occupancy profile.
activity_sch
A schedule for the activity of the occupants over the course of the year. The type limt of this schedule are "Power" and the values of the schedule equal to the number of Watts given off by an individual person in the room.
Deconstruct a Setpoint object into its constituient properties.
setpoint [Required]
A Setpoint object to be deconstructed.
name
Text string for the setpoint display name.
heating_sch
A temperature schedule for the heating setpoint. The type limit of this schedule should be temperature and the values should be the temperature setpoint in degrees Celcius.
cooling_sch
A temperature schedule for the cooling setpoint. The type limit of this schedule should be temperature and the values should be the temperature setpoint in degrees Celcius.
humid_setpt
A numerical value between 0 and 100 for the relative humidity humidifying setpoint [%]. This value will be constant throughout the year. If None, no humidification will occur.
dehumid_setpt
A numerical value between 0 and 100 for the relative humidity dehumidifying setpoint [%]. This value will be constant throughout the year. If None, no dehumidification will occur beyond that which is needed to create air at the cooling supply temperature.
Deconstruct a Ventilation object into its constituient properties.
Note the the 4 ventilation types (flow_per_person, flow_per_area, flow_per_zone, ach) are ultimately summed together to yeild the ventilation design flow rate used in the simulation.
vent [Required]
An Ventilation object to be deconstructed.
name
Text string for the ventilation display name.
flow_per_person
A numerical value for the intensity of ventilation in m3/s per person. Note that setting this value here does not mean that ventilation is varied based on real-time occupancy but rather that the design level of ventilation is determined using this value and the People object of the zone. To vary ventilation in real time, the ventilation schedule should be used. Most ventilation standards support that a value of 0.01 m3/s (10 L/s or ~20 cfm) per person is sufficient to remove odors.
flow_per_area
A numerical value for the intensity of ventilation in m3/s per square meter of floor area.
flow_per_zone
A numerical value for the design level of ventilation in m3/s for the entire zone.
ach
A numberical value for the design level of ventilation in air changes per hour (ACH) for the entire zone. This is particularly helpful for hospitals, where ventilation standards are often given in ACH.
schedule
An optional fractional schedule for the ventilation over the course of the year. The fractional values will get multiplied by the total design flow rate (determined from the fields above and the calculation_method) to yield a complete ventilation profile. If None, the design level of ventilation is used throughout all timesteps of the simulation.
