VERoomData

class iesve.VERoomData

Bases: object

Room data. Returned by iesve.VEBody.get_room_data()

get_air_exchanges() → list[RoomAirExchange]

Get the room’s air exchanges

get_apache_systems() → dict

Gets the system data. Returns:

Dictionary with the following information, including whether values are from template:

• Systems: HVAC system ID; methodology and whether the space is conditioned; auxiliary ventilation system ID and whether it matches the HVAC system; DHW system ID and whether is matches the HVAC system

• Heating: size (kW), radiant fraction, supply air temperature and whether the heating capacity is unlimited. If the capacity is not unlimited then the capacity and its units are included.

• Cooling: size (kW), radiant fraction, supply air temperature and whether the cooling capacity is unlimited. If the capacity is not unlimited then the capacity and its units are included.

• Outside air supply: flow rate and units, free cooling flow capacity and units, and variation profile ID.

• Ventilation & extract: whether room has local mechanical exhaust. If it does then also included are: the extract flow rate and units, SFP (W/l/s) and whether the extract fan is remote from the room.

Additional data is provided for HVAC and NCM modes.

• NCM mode will return entries for:

  • demand_controlled_ventilation_type

  • demand_controlled_ventilation_air_flow

  • heat_recovery

  • seasonal_efficiency

  • use_default_seasonal_efficiency

  • default_seasonal_efficiency

  • use_night_cooling

  • night_cooling_sfp

  • night_cooling_max_flow_rate

  • night_cooling_max_hrs_month

• Apache HVAC Methodology will return entries for:

  • outside_air_ventilation_increase

  • outside_air_ventilation_increase_from_template

  • ventilation_req

  • max_req

  • outdoor_air_change_requirement_used

  • outdoor_air_change_requirement_total_volume_per_second

  • exhaust_air_change_req_is_checked

  • exhaust_air_change_req

get_building_regs() → dict

Get the room’s building regulation data. Only use this on NCM models. Returns dictionary with the following entries:

• air_permeability and dhw_pipe_length

• associated_occupied_room

• criterion_3_solar_gain_benchmark

• criterion_3_solar_gain_total

• criterion_3_status

• destratification_fans

• external_ventilation_rate

• external_ventilation_rate_from_template

• high_pressure_drop_air_treatment

• high_pressure_drop_air_treatment_from_template

• include_room_in_building_regs_analysis

• ncm_activity

• ncm_activity_from_template

• ncm_building_area_type

• ncm_building_area_type_from_template

• room_part_of_core_area

• room_type

• room_type_from_template

• section_63_loft_access

• section_63_loft_access_from_template

get_general() → dict_VERoomData_general

Gets the general room data. Returns dictionary with the following information:

• Body name & ID

• General and thermal templates assigned to the body

• Room volume (m³) and floor area (m²)

• Lettable percentage, circulation percentage, whether or not the floor area is included in the building floor area, and whether these values are from template.

Additional data is provided for HVAC mode

get_internal_gains() → list[RoomInternalGain]

Get the room’s internal gains.

Returns:

(lighting / power / people).

Return type:

list[RoomInternalGain]

get_ncm_lighting() → dict

Get NCM lighting data. Only use this on NCM models. Returns dictionary with the following entries:

• automatic_daylight_zoning

• automatic_daylight_zoning_percentage

• constant_illuminance_control

• control_type

• design_illuminance

• different_sensor_control_back

• display_lighting_time_switching

• has_display_lighting

• lamp_efficacy

• lamp_type

• light_output_ratio

• lighting_case

• lumens_circuit_watt

• luminaires_fitted

• occupancy_parasitic_power

• occupancy_parasitic_power_default

• occupancy_parasitic_power_unit

• occupancy_time_switch_control

• occupancy_sensing

• photoelectric_parasitic_power

• photoelectric_parasitic_power_default

• photoelectric_parasitic_power_unit

• photoelectric_time_switch_control

• sensor_type

• use_efficient_lamps

• use_photoelectric

• wattage

• wattage_unit

get_necb_2017_lighting_controls() → dict

Gets the NECB 2017 Lighting Controls information. Returns dictionary containing the following entries:

• is_manual

• is_restricted_to_manual_on

• is_restricted_to_partial_auto_on

• is_bilevel

• is_auto_daylight_responsive_side_lighting

• is_auto_daylight_responsive_top_lighting

• is_auto_partial_off

• is_auto_full_off

• is_scheduled_shut_off

get_room_conditions() → dict

Gets the room conditions. Returns: Dictionary with the following information, including whether values are from template:

• Heating: profile ID, whether setpoint is timed/constant/two-value, and either setpoint values (°C) or setpoint profile ID

• Cooling: profile ID, whether setpoint is timed/constant/two-value, and either setpoint values (°C) or setpoint profile ID

• DHW: value and units, whether DHW is linked to occupancy or an independent profile and a usage profile ID if relevant

• Plant (auxiliary energy): profile type and profile ID.

• Solar reflected fraction

• Furniture mass factor

• Humidity control: percentage saturation lower/upper limits and max heating (+ humidification) and max dehumidification (+ cooling), in kW.

Additional data is provided for HVAC mode.

get_transpired_solar_collectors() → list[dict]

Get the room’s transpired solar collectors. Only use this on NCM models. Returns a list containing a dictionary for each transpired solar collector. Dictionary contains the following entries:

• adjacency_area

• collector_area

• surface_number

set(general_data: dict, room_conditions_data: dict, system_data: dict) → None

Sets all non-NCM room data using the provided dictionaries. For dictionary keys see:

• iesve.VERoomData.set_general(),

• iesve.VERoomData.set_room_conditions()

• iesve.VERoomData.set_apache_systems()

set_apache_systems(**kwds)

Helper for @overload to raise when called.

set_building_regs(**kwds)

Helper for @overload to raise when called.

set_collector_area(surface_number: int, collector_area: float) → None

Sets the collector area for the transpired solar collector of the indicated surface.

set_general(**kwds)

Helper for @overload to raise when called.

set_ncm_lighting(**kwds)

Helper for @overload to raise when called.

set_room_conditions(**kwds)

Helper for @overload to raise when called.

id: str

ID of the room this data belongs to