VEThermalTemplate

class iesve.VEThermalTemplate

Bases: object

add_air_exchange(ae: AirExchange) → None

Add an AirExchange object to the template

add_gain(gain: CasualGain) → None

Add a CasualGain object to the template

apply_changes() → None

Apply any changes made to the template to the model.

Note:

• if this is not called, changes to the template will not be reflected in the model. This includes changes to gains and air exchanges for the template.

• this operation may take a significant amount of time on large models

get() → tuple

Returns a tuple containing all the details for the thermal template. See the individual get_xxx functions below for information on the returned data.

get_air_exchanges() → list[AirExchange]

Returns a list of AirExchange objects

get_apache_systems() → dict

Dictionary containing Apache Systems settings. The following fields are returned:

Key	Description
aux_vent_system	(string) Aux vent system ID
aux_vent_system_same	(Bool) True if aux vent system is same as HVAC system
cooling_capacity_units	(int) iesve.heating_cooling_capacity_unit
cooling_capacity_unlimited	(Bool)
cooling_capacity_value	(float) see cooling_capacity_units for units
cooling_plant_radiant_fraction	(float)
dhw_system	(string) DHW System ID
dhw_system_same	(Bool) True if DHW system is same as HVAC system
heating_capacity_units	(int) iesve.heating_cooling_capacity_unit
heating_capacity_unlimited	(Bool)
heating_capacity_value	(float) see cooling_capacity_units for units
heating_plant_radiant_fraction	(float)
HVAC_system	(string) HVAC System ID
system_air_free_cooling	(float) see system_air_free_cooling_units for units
system_air_free_cooling_units	(int) see below for airflow units
system_air_minimum_flowrate	(float) see system_air_minimum_flowrate_units for units
system_air_minimum_flowrate_units	(int) see below for airflow units
system_air_variation_profile	(string) System air variation profile ID

Valid values for capacity units see iesve.heating_cooling_capacity_unit

Valid values for airflow units:

• 0 = ach

• 1 = l/s

• 2 = l/s/m²

• 3 = l/s/person

get_casual_gains() → list[CasualGain]

Returns a list of InternalGain objects.

get_room_conditions() → dict

Dictionary containing Room Conditions settings. The following fields are returned:

Key	Description
cooling_profile	(string) profile ID
cooling_setpoint	(float, °C) cooling setpoint, only valid if cooling_setpoint_type is constant
cooling_setpoint_profile	(string) only valid if cooling_setpoint_constant is False
cooling_setpoint_twovalue_main_setpoint	(float, °C) Two-value main setpoint
cooling_setpoint_twovalue_profile	(string) Two-value profile ID
cooling_setpoint_twovalue_setback	(float, °C) Two-value setback setpoint
cooling_setpoint_type	(setpoint_type) Setpoint type
dhw	(float) DHW value linked to dhw_units
dhw_profile	(string) ‘-’ if linked to occupancy, else profile ID of DHW profile
dhw_units	(string) one of: l/(h·pers) or l/h
heating_profile	(string), profile ID
heating_setpoint	(float, °C) cooling setpoint, only valid if heating_setpoint_type is True
heating_setpoint_profile	(string) only valid if heating_setpoint_constant is False
heating_setpoint_twovalue_main_setpoint	(float, °C) Two-value main setpoint
heating_setpoint_twovalue_profile	(string) Two-value profile ID
heating_setpoint_twovalue_setback	(float, °C) Two-value setback setpoint
heating_setpoint_type	(setpoint_type) Setpoint type
plant_profile	(string) profile ID
plant_profile_type	(int) 0 = heating Profile, 1 = cooling profile, 2 = independent profile
sat_perc_lower	(float, %)
sat_perc_upper	(float, %)

remove_air_exchange(ae: AirExchange) → None

Remove air exchange from template. Will throw exception if air exchange is not associated with template.

remove_gain(gain: CasualGain) → None

Remove casual gain from template. Will throw exception if gain is not associated with template.

set(room_conditions: dict, system_data: dict) → None

Set both System Data and Room Conditions settings by passing in dictionaries of settings.

See iesve.VEThermalTemplate.set_apache_systems() and iesve.VEThermalTemplate.set_room_conditions() for dictionary keys.

set_apache_systems(**kwds)

Helper for @overload to raise when called.

set_room_conditions(**kwds)

Helper for @overload to raise when called.

name: str

Template description

standard: VEThermalTemplate_standard

Template standard