dragonfly_doe2.properties.room2d module

Room2D DOE-2 Properties.

class dragonfly_doe2.properties.room2d.Room2DDoe2Properties(host, assigned_flow=None, flow_per_area=None, min_flow_ratio=None, min_flow_per_area=None, hmax_flow_ratio=None)[source]

Bases: object

DOE-2 Properties for Dragonfly Room2D.

Parameters:

  • host – A dragonfly_core Room2D object that hosts these properties.

  • assigned_flow – A number for the design supply air flow rate for the zone the Room2D is assigned to (cfm). This establishes the minimum allowed design air flow. Note that the actual design flow may be larger. If None, this parameter will not be written into the INP. (Default: None).

  • flow_per_area – A number for the design supply air flow rate to the zone per unit floor area (cfm/ft2). If None, this parameter will not be written into the INP. (Default: None).

  • min_flow_ratio – A number between 0 and 1 for the minimum allowable zone air supply flow rate, expressed as a fraction of design flow rate. Applicable to variable-volume type systems only. If None, this parameter will not be written into the INP. (Default: None).

  • min_flow_per_area – A number for the minimum air flow per square foot of floor area (cfm/ft2). This is an alternative way of specifying the min_flow_ratio. If None, this parameter will not be written into the INP. (Default: None).

  • hmax_flow_ratio – A number between 0 and 1 for the ratio of the maximum (or fixed) heating airflow to the cooling airflow. The specific meaning varies according to the type of zone terminal. If None, this parameter will not be written into the INP. (Default: None).

Properties:

  • host

  • assigned_flow

  • flow_per_area

  • min_flow_ratio

  • min_flow_per_area

  • hmax_flow_ratio

ToString()[source]
apply_properties_from_dict(data)[source]

Apply properties from a Room2DDoe2Properties dictionary.

Parameters:

data – A Room2DDoe2Properties dictionary (typically coming from a Model).

check_floor_plate_vertex_count(raise_exception=True, detailed=False)[source]

Check whether the Room2D’s floor geometry exceeds the maximum vertex count.

The DOE-2 engine currently does not support such rooms and limits the total number of vertices to 120.

Parameters:

  • raise_exception – If True, a ValueError will be raised if the Room2D floor plate exceeds the maximum number of vertices supported by DOE-2. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.

check_no_floor_plate_holes(raise_exception=True, detailed=False)[source]

Check whether the Room2D’s floor geometry has holes.

EQuest currently has no way to represent such rooms so, if the issue is not addressed, the hole will simply be removed as part of the process of exporting to an INP file.

Parameters:

  • raise_exception – If True, a ValueError will be raised if the Room2D floor plate has one or more holes. (Default: True).

  • detailed – Boolean for whether the returned object is a detailed list of dicts with error info or a string with a message. (Default: False).

Returns:

A string with the message or a list with a dictionary if detailed is True.

duplicate(new_host=None)[source]

Get a copy of this object.

Parameters:

new_host – A new Room2D object that hosts these properties. If None, the properties will be duplicated with the same host.

classmethod from_dict(data, host)[source]

Create Room2DDoe2Properties from a dictionary.

Parameters:

  • data – A dictionary representation of Room2DDoe2Properties with the format below.

  • host – A Room2D object that hosts these properties.

{
"type": 'Room2DDoe2Properties',
"assigned_flow": 100,  # number in cfm
"flow_per_area": 1,  # number in cfm/ft2
"min_flow_ratio": 0.3, # number between 0 and 1
"min_flow_per_area": 0.3, # number in cfm/ft2
"hmax_flow_ratio": 0.3  # number between 0 and 1
}
from_honeybee(hb_properties)[source]

Transfer Doe-2 attributes from a Honeybee Room to Dragonfly Room2D.

Parameters:

hb_properties – The RoomDoe2Properties of the honeybee Room that is being translated to a Dragonfly Room2D.

to_dict(abridged=False)[source]

Return Room2D Doe2 properties as a dictionary.

to_honeybee(new_host)[source]

Get a honeybee version of this object.

Parameters:

new_host – A honeybee-core Room object that will host these properties.

property assigned_flow

Get or set the design supply air flow rate for the zone (cfm).

property flow_per_area

Get or set the design supply air flow rate per unit floor area (cfm/ft2).

property hmax_flow_ratio

Get or set the ratio of the maximum heating airflow to the cooling airflow.

property host

Get the Room2D object hosting these properties.

property min_flow_per_area

Get or set the minimum air flow per square foot of floor area (cfm/ft2).

property min_flow_ratio

Get or set the the min supply airflow rate as a fraction of design flow rate.