CasualGain

class iesve.CasualGain

Bases: object

Internal Gain data. Returned from VEThermalTemplate function get_casual_gains(). Three categories of internal gains are defined (represented by individual classes):

  • EnergyGain

  • LightingGain

  • PeopleGain


get() dict

Returns a dictionary containing the data for the internal gain.

EnergyGain:

Key

Value

allow_profile_saturate

(bool) True if profile saturate allowed, False otherwise

energy_source

(string) Fuel name

id

(string) ID

max_latent_gain

(float) see units_str / units_val for units

max_power_consumption

(float) see units_str / units_val for units

max_sensible_gain

(float) see units_str / units_val for units

name

(string) Gain name

pc_convective_gain

(float) Percentage convective gain, between 0 and 100

radiant_fraction

(float) Radiant fraction

type_str

(string) Gain type: ‘Machinery’, ‘Miscellaneous’,

‘Cooking’, ‘Computers’

type_val

(iesve.EnergyGain_type) see below for valid enum

values

units_str

(string) ‘W/m²’ or ‘W’

units_val

(int) 0 = W/m², 1 = W

variation_profile

(string) profile ID

LightingGain:

Key

Value

allow_profile_saturate

(bool) True if profile saturate allowed, False otherwise

ballast

(float) Ballast

design_illuminance

(float) Design Illuminance

dimming_profile

(string) profile ID

diversity_factor

(float) Diversity factor

energy_source

(string) Fuel name

id

(string) ID

is_non_regulated_load

(bool) True if non-regulated load, False otherwise

maximum_illuminance

(float) Maximum Illuminance

max_power_consumption

(float) see units_str / units_val for units

max_sensible_gain

(float) see units_str / units_val for units

minimum_illuminance

(float) Minimum Illuminance

name

(string) Gain name

pc_convective_gain

(float) Percentage convective gain, between 0 and 100

radiant_fraction

(float) Radiant fraction

type_str

(string) ‘Fluorescent Lighting’ or ‘Tungsten Lighting’

type_val

(iesve.LightingGain_type) see below for valid enum values

units_str

(string) ‘W/m²’, ‘W’, ‘lux’

units_val

(int) 0 = W/m², 1 = W, 2 = lux

variation_profile

(string) profile ID

PeopleGain:

Key

Value

allow_profile_saturate

(bool) True if profile saturate allowed, False otherwise

diversity_factor

(float) Diversity factor

id

(string) ID

max_latent_gain

(float, W) Maximum latent gain

max_sensible_gain

(float) Maximum sensible gain

name

(string) Gain name

number_of_people

(float) only valid/present if units_str / units_val are: people

occupancy_density

(float) only valid/present if units_str / units_val are: m²/person

pc_convective_gain

(float) Percentage convective gain, between 0 and 100

type_str

(string) ‘People’

type_val

(iesve.PeopleGain_type) see below for valid enum values

units_str

(string) ‘m²/person’, ‘people’

units_val

(int) 0 = m²/person, 1 = people

variation_profile

(string) profile ID


is_ncm() bool

True if ncm gain, False otherwise


set(data: dict) None

See get() for dict options. ‘ID’, ‘type_str’, and ‘units_str’ cannot be set


id: str


name: str

Descriptive name



Enums

class iesve.CasualGain_type(*values)

Bases: IntEnum


computers = 5


cooking = 4


data_center_equipment = 11


display_lighting = 9


fluorescent_lighting = 0


general_lighting = 7


local_fans = 14


machinery = 2


miscellaneous = 3


motors = 16


people = 6


process_equipment = 13


process_lighting = 10


refrigeration = 12


task_lighting = 8


transformers = 15


tungsten_lighting = 1



class iesve.LampType(*values)

Bases: IntEnum


fluorescent_compact = 3


fluorescent_no_details = 12


high_pressure_mercury = 9


high_pressure_sodium = 10


led = 1


metal_halide = 8


t12_fluorescent_halophosphate_low_frequency_ballast = 4


t5_fluorescent_triphosphor_coated_high_frequency_ballast = 11


t8_fluorescent_halophosphate_high_frequency_ballast = 6


t8_fluorescent_halophosphate_low_frequency_ballast = 5


t8_fluorescent_triphosphor_high_frequency_ballast = 7


tungsten_halogen = 2


unknown = -1


unset = 0



class iesve.EnergyGain_type(*values)

Bases: IntEnum


computers = 4


cooking = 3


data_centre_equipment = 5


local_fans = 8


machinery = 1


miscellaneous = 2


motors = 10


process_equipment = 7


refrigeration = 6


transformers = 9



class iesve.LightingGain_type(*values)

Bases: IntEnum


display = 5


fluorescent = 1


general = 3


process = 6


task = 4


tungsten = 2



class iesve.PeopleGain_type(*values)

Bases: IntEnum


people = 1