RoomAirExchange

class iesve.RoomAirExchange

Bases: object

Interface for Room Data: Air Exchanges. Used by VERoomData class to return air exchanges data for a room. The following Air Exchange types are supported:

  • Infiltration

  • Natural Ventilation

  • Auxiliary Ventilation


get() dict

Returns a dictionary containing the data for an air exchange. The following fields are returned:

Key

Description

adjacent_condition_string

(string)

adjacent_condition_val

(int) iesve.AdjacentCondition_type

adjacent_condition_val_from_template

(Bool)

max_flow_from_template

(Bool)

max_flows

(Dictionary of 4 floats, indexed by integer)

Represent the various flow conversions

name

(string)

offset_temperature

(float) Only present when adjacent_condition == 2

temperature_profile

(string) Profile ID, only present when

adjacent_condition references a profile)

temperature_profile_from_template

(Bool)

type_val

(int) iesve.AirExchange_type

units_strs

(Dictionary of strings, indexed by integer)

String representations of units for max_flows

units_val

(int) See iesve.AirChange_unit

variation_profile

(string) Profile ID

variation_profile_from_template

(Bool)


set(data: dict)

Sets the room air exchange using a dictionary. Keys are the same as the get() dict, however:

  • ‘name’, ‘type_val’, ‘type_str’, ‘units_strs’, ‘max_flows’ and ‘adjacent_condition_string’ will be accepted but will not set values

  • Relevant enums required for set function, using int will result in an error.

  • ‘max_flow’(double) is an additional/optional key that sets the max flow value in the defined units type (units_val). This optional takes the air exchange off template.


adjacent_condition: AdjacentCondition_type

adjacent condition property. Modifiable.

Modifying this will set adjacent_condition_uses_template to False


adjacent_condition_from_template: bool

if adjacent_condition taken from template. Modifiable.

Setting to True will reset it


air_change_rate_from_template: bool

if max_flow and air_change_unit taken from template. Modifiable.

Setting to True will reset them


air_change_unit: AirChange_unit

airchange flow unit property. Modifiable. Modifying this will set iesve.RoomAirExchange.air_change_rate_from_template to False


exchange_type: AirExchange_type

airchange type property. Read only.


max_flow: float

Max airchange rate. Modifiable. Units are set in ‘air_change_unit’ property. Modifying this will set iesve.RoomAirExchange.air_change_rate_from_template to False.

Value between 0 and 5000 ACH when modifying, values in other units will be converted before validation


offset_temperature: float | None

air offset temperature. Modifiable. Modifying this will set offset_temperature_uses_template to False.

Will return None if adjacent condition is not ‘external_air_and_offset_temp’

Value between -50 and 50 deg C


offset_temperature_from_template: bool

if offset_temperature taken from template. Modifiable.

Setting to True will reset it


temperature_profile_id: str

temperature profile id. Modifiable. Modifying this will set temperature_profile_id_uses_template to False.

Will return None if adjacent condition is not ‘external_air_and_offset_temp’


temperature_profile_id_from_template: bool

if temperature_profile_id taken from template. Modifiable.

Setting to True will reset it


variation_profile_id: str

variation profile id property. Modifiable. Modifying this will set iesve.RoomAirExchange.variation_profile_id_from_template to False.

Note: Make sure to use an ID that exists, as value will not be verified.


variation_profile_id_from_template: bool

if variation_profile_id taken from template. Modifiable.

Setting to True will reset it