Bases: object
Interface for Room Data: Internal Gains. Used by iesve.VERoomData class to
return internal gains data for a room. Three categories of internal gains are defined,
represented by individual classes:
Returns a dictionary containing the data for the internal gain.
See child classes for details on dict return:
Sets the internal gain data from the provided dictionary.
See child classes for details on dict input:
Bases: RoomInternalGain
Key |
Description |
|---|---|
allow_profile_saturate |
(Bool) True if profile saturate allowed, False otherwise |
allow_profile_saturate_from_template |
(Bool) True if value is from template, else False |
diversity_factor |
(float) Diversity factor |
diversity_factor_from_template |
(Bool) True if value is from template, else False |
energy_source |
(str) Fuel string |
energy_source_from_template |
(Bool) True if value is from template, else False |
id |
(str) ID |
max_latent_gains |
(dict of float, indexed by integer) |
max_power_consumptions |
(dict of float, indexed by integer) |
max_sensible_gains |
(dict of float, indexed by integer) |
name |
(string) Gain name |
radiant_fraction |
(float) Radiant fraction from template |
radiant_fraction_from_template |
(Bool) True if value is from template, else False |
type_str |
(string) ‘Machinery’, ‘Miscellaneous’, ‘Cooking’, ‘Computers’ |
type_val |
(int) 2 = Machinery, 3 = Miscellaneous, 4 = Cooking, 5 = Computers |
units_strs |
(dict of string, indexed by integer) Units for latent gains, sensible gains and power consumption dictionaries |
units_val |
(int) Input mode for this gain. 0 = W/m², 1 = W |
units_val_from_template |
(Bool) True if value is from template, else False |
variation_profile |
(string) profile ID |
variation_profile_from_template |
(Bool) True if value is from template, else False |
Sets the internal gain data from the provided dictionary. Possible values are same as get function but ‘id’, ‘type_str’, and ‘unit_strs’ will be ignored.
Bases: RoomInternalGain
Key |
Description |
|---|---|
allow_profile_saturate |
(Bool) True if profile saturate allowed, False otherwise |
allow_profile_saturate_from_template |
(Bool) True if value is from template, else False |
ballast |
(float) Ballast |
ballast_from_template |
(Bool) True if value is from template, else False |
dimming_profile |
(string) profile ID |
dimming_profile_from_template |
(Bool) True if value is from template, else False |
diversity_factor |
(float) Diversity factor |
diversity_factor_from_template |
(Bool) True if value is from template, else False |
energy_source |
(string) Fuel string |
id |
(string) ID |
energy_source_from_template |
(Bool) True if value is from template, else False |
installed_power_density |
(float) W/m²/(100 lux). Only present if lighting is defined as lux (see units_val, units_str = ‘lux’) |
is_ncm_simple_lighting_control |
(Bool) True if gain is NCM simple lighting control, False otherwise |
is_non_regulated_load |
(Bool) True if non-regulated load, False otherwise |
is_non_regulated_load_from_template |
(Bool) True if value is from template, else False |
lamp_efficacy |
(float) Lamp Efficacy |
lamp_type |
(LampType) Lamp type |
light_output_ratio |
(float) Light output ratio between 0 and 1 |
max_illuminance |
(float) lux. Only present if lighting is defined as lux (see units_val, units_str). Represents Max Illuminance for non-Part L (and Part L2 2010) and Design Illuminance for Part L2 2013 and later. |
max_power_consumptions |
(Dictionary of floats, indexed by int) Provides max power at various units |
max_sensible_gains |
(Dictionary of floats, indexed by int) Provides sensible gains at various units |
name |
(string) Gain name |
power_units |
(Dictionary of strings) units for power consumption, sensible gains Dictionaries |
radiant_fraction |
(float) Radiant fraction |
radiant_fraction_from_template |
(Bool) True if value is from template, else False |
type_str |
(string) ‘Fluorescent Lighting’ or ‘Tungsten Lighting’ |
type_val |
(int) 0 = Fluorescent Lighting, 1 = Tungsten Lighting |
units_str |
(string) ‘W/m²’, ‘W’, ‘lux’ |
units_val |
(int) 0 = W/m², 1 = W, 2 = lux |
units_val_from_template |
(Bool) True if value is from template, else False |
variation_profile |
(string) profile ID |
variation_profile_from_template |
(Bool) True if value is from template, else False |
Sets the internal gain data from the provided dictionary. Possible values are same as get function but ‘id’, ‘type_str’, and ‘unit_strs’ will be ignored.
Bases: RoomInternalGain
Key |
Description |
|---|---|
allow_profile_saturate |
(Bool) True if profile saturate allowed, False otherwise |
allow_profile_saturate_from_template |
(Bool) True if value is from template, else False |
diversity_factor |
(float) Diversity factor |
diversity_factor_from_template |
(Bool) True if value is from template, else False |
id |
(string) ID |
max_latent_gain_from_template |
(Bool) True if value is from template, else False |
max_latent_gains |
(Dictionary of floats, indexed by int) Provides latent gains at various units |
max_sensible_gain_from_template |
(Bool) True if value is from template, else False |
max_sensible_gains |
(Dictionary of floats, indexed by int) Provides sensible gains at various units |
name |
(string) Gain name |
occupancies |
(Dictionary of floats, indexed by int) Occupancy values (0: m²/person, 1: people). Matching units are in units_strs |
power_units |
(Dictionary of strings) units for latent gains, sensible gains Dictionaries |
type_str |
(string) ‘People’ |
type_val |
(int) 6 = People |
units_strs |
(Dictionary of string, indexed by integer) Units for occupancies dictionary. 0: m²/person, 1: people |
units_val |
(int) Input mode. 0 = m²/person, 1 = people |
units_val_from_template |
(Bool) True if value is from template, else False |
variation_profile |
(string) profile ID |
variation_profile_from_template |
(Bool) True if value is from template, else False |
Sets the internal gain data from the provided dictionary. Possible values are same as get function but ‘id’, ‘type_str’, and ‘unit_strs’ will be ignored.