×
Menu
Index

6.1.36.1 Methods Defined Here

get_air_exchanges() -> list
Get the room's air exchanges.
Returns:
  List of RoomAirExchange objects.
 
get_apache_systems() -> dictionary
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.
 
get_building_regs() -> dictionary
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() -> dictionary
    Gets the general room data.
    Returns:
        Dictionary with the following information:
 
-          Body name & ID
-          General and thermal templates assigned to the body
-          Room volume (m3) and floor area (m2)
-          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
Get the room's internal gains.
Returns:
  List of RoomInternalGain objects (lighting / power / people).
 
get_ncm_lighting() -> dictionary
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_room_conditions() -> dictionary
    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
Get the room's transpired solar collectors. Only use this on NCM models.
Returns:
  List containing a dictionary for each transpired solar collector.
  Dictionary contains the following entries:
 
adjacency_area
collector_area
surface_number
 
set_all(general_data, room_conditions_data, systems_data)
Sets all non-NCM room data using the provided dictionaries.
See set_general(), set_room_conditions() and set_apache_systems()
for dictionary keys.
 
set_apache_systems(data)
Sets system data from the provided dictionary.
Possible dictionary keys are:
 
associated_return_air_plenum
associated_supply_air_plenum
auto_associate_adjacent_plenums
aux_vent_system
aux_vent_system_from_template
aux_vent_system_same
cooling_capacity_unit
cooling_capacity_unlimited
cooling_capacity_unlimited_from_template
cooling_capacity_value
cooling_design_supply_temp
cooling_design_supply_temp_from_template
cooling_plant_radiant_fraction
cooling_plant_radiant_fraction_from_template
cooling_unit_size
demand_controlled_ventilation_air_flow
demand_controlled_ventilation_type
dhw_system
dhw_system_from_template
dhw_system_same
extract_fan_is_remote
extract_flow_rate
extract_flow_rate_unit
has_mech_exhaust
heat_recovery seasonal_efficiency
heating_capacity_unit
heating_capacity_unlimited
heating_capacity_unlimited_from_template
heating_capacity_value
heating_design_supply_temp
heating_design_supply_temp_from_template
heating_plant_radiant_fraction
heating_plant_radiant_fraction_from_template
heating_unit_size
HVAC_methodology
HVAC_methodology_from_template
HVAC_system
HVAC_system_from_template
include_in_room_zone_loads_analysis
include_in_room_zone_loads_analysis_template
mech_sfp
mech_supply_in_room
night_cooling_max_flow_rate
night_cooling_max_hrs_month
night_cooling_sfp
outside_air_ventilation_increase
outside_air_ventilation_increase_from_template
scope_of_extract_system
supply_condition
supply_condition_profile
supply_condition_template
system_air_free_cooling
system_air_free_cooling_from_template
system_air_minimum_flowrate
system_air_minimum_flowrate_from_template
system_air_variation_profile
system_air_variation_profile_from_template
use_default_seasonal_efficiency
use_night_cooling
 
set_building_regs(data)
Sets building regs data from the provided dictionary.
Possible dictionary keys are:
 
air_permeability
associated_occupied_room
destratification_fans
dhw_pipe_length
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
 
set_collector_area(surface_number, collector_area)
Sets the collector area for the transpired solar collector of the indicated surface.
 
set_general(data)
Sets general room data from the provided dictionary.
Possible dictionary keys are:
 
circ_perc
circ_perc_from_template
included_in_building_floor_area
included_in_building_floor_area_from_template
lettable_perc
lettable_perc_from_template
name
 
set_ncm_lighting(data)
Sets NCM lighting data from the provided dictionary.
Possible dictionary keys are:
 
automatic_daylight_zoning
automatic_daylight_zoning_percentage
constant_illuminance_control
control_type
design_illuminance
different_sensor_control_back
display_lighting_time_switching
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_sensing
occupancy_time_switch_control
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
 
set_room_conditions(data)
    Sets room conditions data from the provided dictionary.
    Possible dictionary keys are:
 
cooling_profile
cooling_profile_from_template
cooling_setpoint
cooling_setpoint_constant
cooling_setpoint_from_template
cooling_setpoint_profile
cooling_setpoint_twovalue_main_setpoint
cooling_setpoint_twovalue_profile
cooling_setpoint_twovalue_setback
cooling_setpoint_type
dhw
dhw_from_template
dhw_linked_to_occupancy
dhw_linked_to_occupancy_from_template
dhw_profile
dhw_profile_from_template
dhw_room_level_setting
dhw_room_level_setting_from_template
furniture_mass_factor
furniture_mass_factor_from_template
heating_profile
heating_profile_from_template
heating_setpoint
heating_setpoint_constant
heating_setpoint_from_template
heating_setpoint_profile
heating_setpoint_twovalue_main_setpoint
heating_setpoint_twovalue_profile
heating_setpoint_twovalue_setback
heating_setpoint_type
ncm_plant_profile
plant_profile
plant_profile_from_template
plant_profile_type
sat_perc_lower
sat_perc_lower_from_template
sat_perc_upper
sat_perc_upper_from_template
solar_reflected_fraction
solar_reflected_fraction_from_template