honeybee_energy.properties.face module

Face Energy Properties.

class honeybee_energy.properties.face.FaceEnergyProperties(host, construction=None, vent_crack=None)

Bases: object

Energy Properties for Honeybee Face.

Parameters:

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

• construction – An optional Honeybee OpaqueConstruction object for the face. If None, it will be set by the parent Room ConstructionSet or the the Honeybee default generic ConstructionSet.

• vent_crack – An optional AFNCrack to specify the air leakage crack for the Face. (Default: None).

Properties:

• host

• construction

• vent_crack

• is_construction_set_on_object

ToString()

apply_properties_from_dict(abridged_data, constructions)

Apply properties from a FaceEnergyPropertiesAbridged dictionary.

Parameters:

• abridged_data – A FaceEnergyPropertiesAbridged dictionary (typically coming from a Model).

• constructions – A dictionary of constructions with constructions identifiers as keys, which will be used to re-assign constructions.

duplicate(new_host=None)

Get a copy of this object.

Parameters:

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

classmethod from_dict(data, host)

Create FaceEnergyProperties from a dictionary.

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

Parameters:

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

• host – A Face object that hosts these properties.

{
"type": 'FaceEnergyProperties',
"construction": {},  # opaque construction
"vent_crack": {}  # AFN crack
}

is_equivalent(other)

Check to see if these energy properties are equivalent to another object.

This will only be True if all properties match (except for the host) and will otherwise be False.

r_factor(units='Meters')

Get the Face R-factor [m2-K/W] (including air film resistance).

The air film resistances are computed using the orientation and height of the Face geometry.

Parameters:

units – Text for the units in which the Face geometry exists. These will be used to correctly interpret the dimensions of the geometry for heat flow calculation. (Default: Meters).

reset_construction_to_set()

Reset the construction assigned to this Face and its children to the default.

This means that the Face’s construction and its child Aperture/Door constructions will be assigned by a ConstructionSet.

shgc(units='Meters')

Get the Face solar heat gain coefficient (SHGC).

This value is computed by summing the conducted portions of solar irradiance under the NFRC summer conditions. The air film resistances are computed using the orientation and height of the Face geometry.

Parameters:

units – Text for the units in which the Face geometry exists. These will be used to correctly interpret the dimensions of the geometry for heat flow calculation. (Default: Meters).

to_dict(abridged=False)

Return energy properties as a dictionary.

Parameters:

abridged – Boolean to note whether the full dictionary describing the object should be returned (False) or just an abridged version (True). Default: False.

u_factor(units='Meters')

Get the Face U-factor [W/m2-K] (including resistances for air films).

The air film resistances are computed using the orientation and height of the Face geometry.

Parameters:

units – Text for the units in which the Face geometry exists. These will be used to correctly interpret the dimensions of the geometry for heat flow calculation. (Default: Meters).

property construction

Get or set Face Construction.

If the Construction is not set on the face-level, then it will be assigned based on the ConstructionSet assigned to the parent Room. If there is no parent Room or the parent Room’s ConstructionSet has no construction for the Face type and boundary_condition, it will be assigned using the honeybee default generic construction set.

property host

Get the Face object hosting these properties.

property is_construction_set_on_object

Boolean noting if construction is assigned on the level of this Face.

This is opposed to having the construction assigned by a ConstructionSet.

property vent_crack

Get or set a AFNCrack object to specify Airflow Network air leakage.

Note that anything assigned here has no bearing on the simulation unless the Model that the Face is a part of has its ventilation_simulation_control set for MultiZone air flow, thereby triggering the use of the AirflowNetwork.