honeybee_energy.load.ventilation module

Complete definition of ventilation in a simulation, including schedule and load.

class honeybee_energy.load.ventilation.Ventilation(identifier, flow_per_person=0, flow_per_area=0, flow_per_zone=0, air_changes_per_hour=0, schedule=None)[source]

Bases: _LoadBase

A complete definition of ventilation, including schedules and load.

Note the the 4 ventilation types (flow_per_person, flow_per_area, flow_per_zone, and air_changes_per_hour) are ultimately added together to yield the ventilation design flow rate used in the simulation.

Parameters

  • identifier – Text string for a unique Ventilation ID. Must be < 100 characters and not contain any EnergyPlus special characters. This will be used to identify the object across a model and in the exported IDF.

  • 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. Accordingly, setting this value to 0.01 and using 0 for the following ventilation terms will often be suitable for many applications. Default: 0.

  • flow_per_area – A numerical value for the intensity of ventilation in m3/s per square meter of floor area. Default: 0.

  • flow_per_zone – A numerical value for the design level of ventilation in m3/s for the entire zone. Default: 0.

  • air_changes_per_hour – A numerical 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. Default: 0.

  • schedule – An optional ScheduleRuleset or ScheduleFixedInterval for the ventilation over the course of the year. The type of this schedule should be Fractional and the fractional values will get multiplied by the total design flow rate (determined from the sum of the other 4 fields) to yield a complete ventilation profile. Setting this schedule to be the occupancy schedule of the zone will mimic demand controlled ventilation. If None, the design level of ventilation will be used throughout all timesteps of the simulation. Default: None.

Properties:

  • identifier

  • display_name

  • flow_per_person

  • flow_per_area

  • flow_per_zone

  • air_changes_per_hour

  • schedule

  • user_data

ToString()

Overwrite .NET ToString.

static average(identifier, ventilations, weights=None, timestep_resolution=1)[source]

Get an Ventilation object that’s an average between other Ventilations.

Parameters

  • identifier – Text string for a unique ID for the new averaged Ventilation. Must be < 100 characters and not contain any EnergyPlus special characters. This will be used to identify the object across a model and in the exported IDF.

  • ventilations – A list of Ventilation objects that will be averaged together to make a new Ventilation.

  • weights – An optional list of fractional numbers with the same length as the input ventilations. These will be used to weight each of the Ventilation objects in the resulting average. Note that these weights can sum to less than 1 in which case the average flow rates will assume 0 for the unaccounted fraction of the weights.

  • timestep_resolution – An optional integer for the timestep resolution at which the schedules will be averaged. Any schedule details smaller than this timestep will be lost in the averaging process. Default: 1.

duplicate()

Get a copy of this object.

classmethod from_dict(data)[source]

Create a Ventilation object from a dictionary.

Note that the dictionary must be a non-abridged version for this classmethod to work.

Parameters

data – A Ventilation dictionary in following the format below.

{
"type": 'Ventilation',
"identifier": 'Office_Ventilation_0010_000050_0_0',
"display_name": 'Office Ventilation',
"flow_per_person": 0.01, # flow per person
"flow_per_area": 0.0005, # flow per square meter of floor area
"flow_per_zone": 0, # flow per zone
"air_changes_per_hour": 0, # air changes per hour
"schedule": {} # ScheduleRuleset/ScheduleFixedInterval dictionary
}
classmethod from_dict_abridged(data, schedule_dict)[source]

Create a Ventilation object from an abridged dictionary.

Parameters

  • data – A VentilationAbridged dictionary in following the format below.

  • schedule_dict – A dictionary with schedule identifiers as keys and honeybee schedule objects as values (either ScheduleRuleset or ScheduleFixedInterval). These will be used to assign the schedules to the Ventilation object.

{
"type": 'VentilationAbridged',
"identifier": 'Office_Ventilation_0010_000050_0_0',
"display_name": 'Office Ventilation',
"flow_per_person": 0.01, # flow per person
"flow_per_area": 0.0005, # flow per square meter of floor area
"flow_per_zone": 0, # flow per zone
"air_changes_per_hour": 0, # air changes per hour
"schedule": "Office Ventilation Schedule" # Schedule identifier
}
classmethod from_idf(idf_string, schedule_dict)[source]

Create an Ventilation object from an EnergyPlus IDF text string.

Parameters

  • idf_string – A text string fully describing an EnergyPlus DesignSpecification:OutdoorAir definition.

  • schedule_dict – A dictionary with schedule identifiers as keys and honeybee schedule objects as values (either ScheduleRuleset or ScheduleFixedInterval). These will be used to assign the schedules to the Ventilation object.

Returns

ventilation – An Ventilation object loaded from the idf_string.

lock()
to_dict(abridged=False)[source]

Ventilation dictionary representation.

Parameters

abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True), which only specifies the identifiers of schedules. Default: False.

to_idf(zone_identifier)[source]

IDF string representation of Ventilation object.

Note that this method only outputs a single string for the DesignSpecification: OutdoorAir object and, to write everything needed to describe the object into an IDF, this object’s schedule must also be written.

Parameters

zone_identifier – Text for the zone identifier that the Ventilation object is assigned to.

unlock()
property air_changes_per_hour

Get or set the ventilation in air changes per hour (ACH).

property display_name

Get or set a string for the object name without any character restrictions.

If not set, this will be equal to the identifier.

property flow_per_area

Get or set the ventilation in m3/s per square meter of zone floor area.

property flow_per_person

Get or set 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 or demand controlled ventilation options should be set on the HVAC system.

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. Accordingly, setting this value to 0.01 and using 0 for the following ventilation terms will often be suitable for many applications.

property flow_per_zone

Get or set the ventilation in m3/s per zone.

property identifier

Get or set the text string for object identifier.

property properties

Get properties for extensions.

property schedule

Get or set a ScheduleRuleset or ScheduleFixedInterval for ventilation.

property user_data

Get or set an optional dictionary for additional meta data for this object.

This will be None until it has been set. All keys and values of this dictionary should be of a standard Python type to ensure correct serialization of the object to/from JSON (eg. str, float, int, list, dict)