honeybee_energy.ventcool.simulation module

Definitions for global parameters used in the ventilation simulation.

class honeybee_energy.ventcool.simulation.VentilationSimulationControl(vent_control_type='SingleZone', reference_temperature=20, reference_pressure=101325, reference_humidity_ratio=0, building_type='LowRise', long_axis_angle=0, aspect_ratio=1)[source]

Bases: object

Global parameters used to specify the simulation of air flow.

Parameters:

  • vent_control_type –

    Text indicating type of ventilation control. Choose from the following:

    • SingleZone

    • MultiZoneWithDistribution

    • MultiZoneWithoutDistribution

    The MultiZone options will model air flow with the AirflowNetwork model, which is generally more accurate then the SingleZone option, but will take considerably longer to simulate, and requires defining more ventilation parameters to explicitly account for weather and building-induced pressure differences, and the leakage geometry corresponding to specific windows, doors, and surface cracks (Default: ‘SingleZone’).

  • reference_temperature – Reference temperature measurement in Celsius under which the surface crack data were obtained. This is only used for AFN simulations, when vent_control_type is NOT SingleZone. (Default: 20).

  • reference_pressure – Reference barometric pressure measurement in Pascals under which the surface crack data were obtained. This is only used for AFN simulations, when vent_control_type is NOT SingleZone.(Default: 101325).

  • reference_humidity_ratio – Reference humidity ratio measurement in kgWater/kgDryAir under which the surface crack data were obtained. This is only used for AFN simulations, when vent_control_type is NOT SingleZone. (Default: 0).

  • building_type –

    Text indicating relationship between building footprint and height. Choose from the following:

    • LowRise

    • HighRise

    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. This parameter is used to estimate building-wide wind pressure coefficients for the AFN by approximating the building geometry as an extruded rectangle. This property can be auto-calculated from Honeybee Room geometry with the geometry_properties_from_rooms method. (Default: ‘LowRise’).

  • long_axis_angle – 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. (Default: 0).

  • 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 (Default: 1).

Properties:

  • vent_control_type

  • reference_temperature

  • reference_pressure

  • reference_humidity_ratio

  • building_type

  • long_axis_angle

  • aspect_ratio

ToString()[source]

Overwrite .NET ToString.

assign_geometry_properties_from_rooms(rooms)[source]

Assign the geometry properties of this object using an array of Honeybee Rooms.

The building_type (HighRise or LowRise) will be determined by analyzing the bounding box around the Rooms (assessing whether the box is taller than it is wide + long).

This object’s long_axis_angle will be used to orient the bounding box and compute the aspect ratio of the footprint. If the length of what should be the short axis ends up being longer than the other axis, this object’s long_axis_angle will be rotated 90 degrees in order to keep the aspect ratio from being greater than 1.

Parameters:

rooms – An array of Honeybee Rooms, which will have their geometry collectively analyzed in order to set the geometry properties of this object. Typically, this should be all of the Rooms of a Honeybee Model.

duplicate()[source]

Get a copy of this object.

classmethod from_dict(data)[source]

Create a VentilationSimulationControl object from a dictionary.

Parameters:

data – A VentilationSimulationControl dictionary following the format below.

{
"type": "VentilationSimulationControl"
"vent_control_type": SingleZone # type of ventilation control
"reference_temperature": 20 # reference crack temperature
"reference_pressure": 101320 # reference crack barometric pressure
"reference_humidity_ratio": 0.5 # reference crack humidity ratio
"building_type": 'LowRise' # building type text
"long_axis_angle": 0 # angle of building low axis
"aspect_ratio": 1 # aspect ratio of building footprint
}
static geometry_properties_from_rooms(rooms, axis_angle=0)[source]

Get AFN building geometry properties from an array of Honeybee Rooms.

Parameters:

  • rooms – An array of Honeybee Rooms, which will have their geometry collectively analyzed.

  • axis_angle – The clockwise rotation angle in degrees in the XY plane to represent the orientation of the bounding box. (Default: 0).

Returns:

A tuple with 2 values for geometry properties.

  1. Text indicating the building_type (either Highrise or LowRise)

  2. A number for the aspect ratio of the axis_angle-oriented bounding box.

Note that the aspect ratio may be greater than 1 if the axis_angle isn’t aligned to the long axis of the geometry.

lock()
to_dict()[source]

VentilationSimulationControl dictionary representation.

unlock()
BUILDING_TYPES = ('LowRise', 'HighRise')
VENT_CONTROL_TYPES = ('SingleZone', 'MultiZoneWithDistribution', 'MultiZoneWithoutDistribution')
property aspect_ratio

Get or set a number between 0 and 1 for the building footprint aspect ratio.

property building_type

Get or set text indicating whether the building is high or low rise.

property long_axis_angle

Get or set a number between 0 and 180 for the building long axis angle.

The value represents the clockwise difference between the long axis and true North. 0 indicates a North-South long axis while 90 indicates an East-West long axis.

property reference_humidity_ratio

Get or set the humidity ratio for the reference crack.

property reference_pressure

Get or set the barometric pressure for the reference crack.

property reference_temperature

Get or set the temperature for the reference crack.

property vent_control_type

Get or set text indicating type of ventilation control type.