×
Menu
Index

Methods Defined Here

 
air_supply () -> dictionary
Air supply data for the Apache system.  Returns dictionary with the following keys:
 
condition
(int) supply condition.  See air_supply_cond_names()
 
profile (optional)
(string) adjacent condition profile ID, only present if condition = 1
OA_max_flow
(float, l/s) maximum outside air supply flow rate
temperature_difference
(float, K) air supply temperature difference (0 for no sizing)
cooling_max_flow
(float, l/s) maximum cooling air supply flow rate
 
auxiliary_energy () -> dictionary
Auxiliary energy data for the Apache system.  Returns dictionary with the following keys:
 
method
(int) auxiliary energy method.  See aux_energy_method_names()
 
SFP (optional)
(float, W/l/s) specific fan power (SFP).  Only if method != 3
AEV
(float, W/m2) energy value.  Only if method != 0
equivalent_energy
(float, kWh/m2/y) equivalent energy in, for 3255hrs operation.  Only if method != 0
off_schedule_AEV
(float, W/m2) off-schedule heating/cooling AEV
 
control () -> dictionary
Control data for the Apache system.  Returns dictionary with the following keys:
 
master_zone
(string) master zone room ID
 
cooling () -> dictionary
Cooling data for the Apache system.  Returns dictionary with the following keys:
 
cool_vent_mechanism
(int) cooling/ventilation mechanism.  See cooling_mech_names()
fuel (optional)
(int) fuel.  Only if has_absorption_chiller == False.  See fuel_names()
SEER
(float, kW/kW) seasonal energy efficiency ratio
del_eff
(float) delivery efficiency
SSEER
(float, kW/kW) seasonal system energy efficiency ratio
gen_size
(float, kW) generator size
has_absorption_chiller
(Boolean) whether the system has an absorption chiller
pump_and_fan_power_perc
(float) pump & fan power (% of rejected heat)
 
 
heating () -> dictionary
Heating data for the Apache system.  Returns dictionary with the following keys:
 
fuel
(int) generator fuel.  See fuel_names()
gen_seasonal_eff
(float) seasonal efficiency of the generator
del_eff
(float) delivery efficiency of the generator
SCoP
(float, kW/kW) seasonal coefficient of performance
gen_size
(float, kW) generator size
HR_effectiveness
(float) ventilation heat recovery effectiveness
HR_return_temp
(float, °C) ventilation heat recovery return air temperature
used_with_CHP
(Boolean) whether the heat source is used in conjunction with CHP
CHP_ranking (optional)
(int) ranking of heat source after the CHP plant.  Only if CHP is present
CHP_heat_output (optional)
(float, kW) heat output of CHP.  Only if CHP is present
 
hot_water () -> dictionary
Hot water data for the Apache system.  Returns dictionary with the following keys:
 
has_ApHVAC_boiler
(Boolean) whether the system is served by an ApacheHVAC boiler
del_eff
(float) DHW delivery efficiency
cold_water_inlet_temp
(float, °C) mean cold water inlet temperature
supply_temp
(float, °C) hot water supply temperature
is_storage_system
(Boolean) whether the system is a storage system
storage_volume (optional)
(float, liters) storage volume.  Only if storage is used
insulation_type (optional)
(int) type of insulation.  See insulation_names().Only if storage is used
insulation_thickness (optional)
(float, mm) insulation thickness. Only if storage is used
storage_losses (optional)
(float, kWh/l/day) storage losses. Only if storage is used
has_secondary_circulation
(Boolean) whether the system has secondary circulation
circulation_losses (optional)
(float, W/m) circulation losses.  Only if secondary circulation is present
pump_power (optional)
(float, kW) pump power. Only if secondary circulation is present
loop_length (optional)
(float, meters) loop length. Only if secondary circulation is present
has_time_switch (optional)
(Boolean) whether or not there is a time switch. Only if secondary circulation is present
 
 
set_air_supply (air_supply_data)
 
Set air supply data from the supplied dictionary
Dictionary keys are:
 
condition
profile
OA_max_flow
temperature_difference
cooling_max_flow
 
set_auxiliary_energy (aux_data)
 
Set auxiliary energy data from the supplied dictionary
Dictionary keys are:
 
method
SFP
AEV
off_schedule_AEV
fan_fraction
 
set_control (control_id)
 
Set the master zone control.
 
set_cooling (cooling_data)
 
Set cooling data from the supplied dictionary.
Dictionary keys are:
 
cool_vent_mechanism
has_absorption_chiller
fuel
SEER
del_eff
SSEER
gen_size
pump_and_fan_power_perc
 
set_default (system_id)
 
Set the default system ID.
 
set_heating (heating_data)
 
Set heating data from the supplied dictionary.
Dictionary keys are:
 
fuel
gen_seasonal_eff
SCoP
gen_size
HR_effectiveness
HR_return_temp
used_with_CHP
CHP_ranking
CHP_heat_output
 
set_hot_water (hot_water_data)
 
Set hot water data from the supplied dictionary.
Dictionary keys are:
 
has_ApHVAC_boiler
del_eff
cold_water_inlet_temp
supply_temp
is_storage_system
storage_volume
insulation_type
insulation_thickness
storage_losses
has_secondary_circulation
circulation_losses
pump_power
loop_length
has_time_switch
 
set_name (name)
 
Set the system name.
 
set_solar_water_heating (sol_water_data)
 
Set solar hot water heating data from the supplied dictionary.
Dictionary keys are:
 
type
area
azimuth
tilt
shading_factor
degradation_factor
conversion_eff
coeff_a1
coeff_a2
flow_rate
pump_fuel
volume
storage_loss
refl_length
refl_width
refl_focal_length
units_per_row
num_rows
tube_extension
intercept_factor
abso_radius
abso_absorptance
mirror_reflectance
cover_trans
fluid_flow
pump_power
heat_capacity
HX_effectiveness
tank_volume
tank_heat_loss
coeff_c1
coeff_c2
has_space_or_process_heating
supply_temp
return_temp
 
solar_water_heating () -> dictionary
Solar water heating data for the Apache system.  Returns dictionary with the following keys:
 
has_solar_heating
(Boolean) whether or not there is solar heating.  All other keys are present only if this value is true
area (optional)
(float, m2) area
azimuth (optional)
(float, degrees clockwise from North) azimuth
tilt (optional)
(float, degrees from horizontal) tilt
shading_factor (optional)
(float) shading factor
degradation_factor (optional)
(float) degradation factor
conversion_eff (optional)
(float) conversion efficiency at ambient temperature
coeff_a1 (optional)
(float, W/m2/K) first order heat loss coefficient (a1)
coeff_a2 (optional)
(float, W/m2/K) second order heat loss coefficient (a2)
flow_rate (optional)
(float, l/h/m2) flow rate
pump_power (optional)
(float, kW) pump power
HX_effectiveness (optional)
(float) heat exchanger effectiveness
storage_volume (optional)
(float, liters) volume
storage_losses (optional)
(float, kWh/l/day) storage loss at max. temperature