honeybee_doe2.properties.room module

Room DOE-2 Properties.

class honeybee_doe2.properties.room.RoomDoe2Properties(host, assigned_flow=None, flow_per_area=None, min_flow_ratio=None, min_flow_per_area=None, hmax_flow_ratio=None, space_polygon_geometry=None)

Bases: object

DOE-2 Properties for Honeybee Room.

Parameters:

• host – A honeybee_core Room object that hosts these properties.

• assigned_flow – A number for the design supply air flow rate for the zone the Room 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).

• space_polygon_geometry – An optional horizontal Face3D object, which will be used to set the SPACE polygon during export to INP. If None, the SPACE polygon is auto-calculated from the 3D Room geometry. Specifying a geometry here can help overcome some limitations of this auto-calculation, particularly for cases where the floors of the Room are composed of AirBoundaries. (Default: None).

Properties:

• host

• assigned_flow

• flow_per_area

• min_flow_ratio

• min_flow_per_area

• hmax_flow_ratio

• space_polygon_geometry

ToString()

apply_properties_from_dict(data)

Apply properties from a RoomDoe2Properties dictionary.

Parameters:

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

apply_properties_from_user_data()

Apply properties from a the user_data assigned to the host room.

For this method to successfully assign properties from user_data, the properties on this object must currently be None and the keys in user_data must use the INP convention for each of the attributes, which must be CAPITALIZED like the following:

{
"ASSIGNED-FLOW": 100,  # number in cfm
"FLOW/AREA": 1,  # number in cfm/ft2
"MIN-FLOW-RATIO": 0.3, # number between 0 and 1
"MIN-FLOW/AREA": 0.3, # number in cfm/ft2
"HMAX-FLOW-RATIO": 0.3  # number between 0 and 1
}

duplicate(new_host=None)

Get a copy of this object.

Parameters:

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

classmethod from_dict(data, host)

Create RoomDoe2Properties from a dictionary.

Parameters:

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

• host – A Room object that hosts these properties.

{
"type": 'RoomDoe2Properties',
"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
"space_polygon_geometry": {}  # optional Face3D dictionary
}

move(moving_vec)

Move this object along a vector.

Parameters:

moving_vec – A ladybug_geometry Vector3D with the direction and distance to move the object.

reflect(plane)

Reflect this object across a plane.

Parameters:

plane – A ladybug_geometry Plane across which the object will be reflected.

rotate(angle, axis, origin)

Rotate this object by a certain angle around an axis and origin.

Parameters:

• angle – An angle for rotation in degrees.

• axis – Rotation axis as a Vector3D.

• origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

rotate_xy(angle, origin)

Rotate this object counterclockwise in the world XY plane by a certain angle.

Parameters:

• angle – An angle in degrees.

• origin – A ladybug_geometry Point3D for the origin around which the object will be rotated.

scale(factor, origin=None)

Scale this object by a factor from an origin point.

Parameters:

• factor – A number representing how much the object should be scaled.

• origin – A ladybug_geometry Point3D representing the origin from which to scale. If None, it will be scaled from the World origin (0, 0, 0).

to_dict(abridged=False)

Return Room Doe2 properties as a dictionary.

to_inp()

Get RoomDoe2Properties as INP (Keywords, Values).

Returns:

A tuple with two elements.

• keywords: A list of text strings for keywords to assign to the room.

• values: A list of text strings that aligns with the keywords and denotes the value for each keyword.

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 Room 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.

property space_polygon_geometry

Get or set a horizontal Face3D to set the space polygon geometry.