6.1.20.1 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()
|
|
|
cooling_max_flow
|
(float, l/s) maximum cooling air supply flow rate
|
|
OA_max_flow
|
(float, l/s) maximum outside air supply flow rate
|
|
profile (optional)
|
(string) adjacent condition profile ID, only present if condition = 1
|
|
temperature_difference
|
(float, K) air supply temperature difference (0 for no sizing)
|
apply_ncm()
Applies NCM wizard data to the system. Call this after setting NCM wizard data to update the system itself. If you don’t call this, changes will be made only in the wizard and not the system.
auxiliary_energy(show_ncm) -> dictionary
Auxiliary energy data for the Apache system.
Parameters:
|
show_ncm (optional)
|
Whether to show NCM specific data in the output
|
Returns:
Dictionary with the following keys:
|
AEV
|
(float, W/m2) energy value. Only if method != 0
|
|
air_supply_mechanism (optional)
|
Air supply mechanism
|
|
equivalent_energy
|
(float, kWh/m2/y) equivalent energy in, for 3255hrs operation. Only if method != 0
|
|
method
|
(int) auxiliary energy method. See aux_energy_method_names()
|
|
off_schedule_AEV
|
(float, W/m2) off-schedule heating/cooling AEV
|
|
SFP (optional)
|
(float, W/l/s) specific fan power (SFP). Only if method != 3
|
bivalent_systems_ncm() -> dictionary
Bivalent systems NCM data for the Apache system. Returns dictionary with the following keys:
|
load_for_primary_system
|
% Load for the primary system
|
|
overall_seasonal_efficiency
|
Overall seasonal efficiency
|
|
systems
|
List of dictionaries of system data (one for each system)
|
System data dictionary contains the following keys:
|
gen_seff
|
GEN SEFF (fraction)
|
|
heat_source
|
Heat source
|
|
load
|
% Load
|
|
meter
|
Energy meter
|
control() -> dictionary
Control data for the Apache system. Returns dictionary with the following keys:
|
master_zone
|
(string) master zone room ID
|
cooling(show_ncm) -> dictionary
Cooling data for the Apache system.
Parameters:
|
show_ncm (optional)
|
Whether to show NCM specific data in the output
|
Returns:
Dictionary with the following keys:
|
cool_vent_mechanism
|
(int) Cooling/ventilation mechanism. See cooling_mech_names()
|
|
del_eff
|
(float) Delivery efficiency
|
|
free_cooling
|
|
|
fuel (optional)
|
(int) Fuel. Only if has_absorption_chiller == False. See fuel_names()
|
|
gen_size
|
(float, kW) Generator size
|
|
has_absorption_chiller
|
(Bool) Whether the system has an absorption chiller
|
|
nominal_eer
|
(float, kW/kW) Nominal EER
|
|
pump_and_fan_power_perc
|
(float) Pump & fan power (% of rejected heat)
|
|
SEER
|
(float, kW/kW) Seasonal energy efficiency ratio
|
|
SSEER
|
(float, kW/kW) Seasonal system energy efficiency ratio
|
cooling_ncm() -> dictionary
Cooling NCM data for the Apache system. Returns dictionary with the following keys:
|
chiller_meter
|
|
|
default_generator_nominal_eer
|
(float) Default nominal EER value
|
|
default_generator_seasonal_eer
|
(float) Default seasonal EER value
|
|
generator_nominal_eer
|
(float) Nominal EER
|
|
generator_nominal_eer_known
|
(bool) Do you know the generator nominal EER?
|
|
generator_seasonal_eer
|
(float) Seasonal EER
|
|
generator_seasonal_eer_known
|
(bool) Do you know the generator seasonal EER?
|
|
mixed_mode
|
(bool) Mixed mode operation strategy (SBEM only)
|
|
power
|
|
|
qualify_for_eca
|
|
|
type
|
|
general_ncm() -> dictionary
General NCM data for the Apache system. Returns dictionary with the following keys:
|
is_proxy_for_hvac
|
(bool) Whether it is a proxy for an ApacheHVAC system
|
|
ncm_system_type
|
|
heating(show_ncm) -> dictionary
Heating data for the Apache system.
Parameters:
|
show_ncm (optional)
|
Whether to show NCM specific data in the output
|
Returns:
Dictionary with the following keys:
|
CHP_heat_output (optional)
|
(float, kW) heat output of CHP. Only if CHP is present
|
|
CHP_ranking (optional)
|
(int) ranking of heat source after the CHP plant. Only if CHP is present
|
|
del_eff
|
(float) delivery efficiency of the generator
|
|
fuel
|
(int) generator fuel. See fuel_names()
|
|
gen_seasonal_eff
|
(float) seasonal efficiency of the generator
|
|
gen_size
|
(float, kW) generator size
|
|
HR_effectiveness
|
(float) ventilation heat recovery effectiveness
|
|
HR_return_temp
|
(float, °C) ventilation heat recovery return air temperature
|
|
Is_heat_pump
|
(bool) Is it a heat pump?
|
|
meter_cef
|
(float) Meter CEF kgCO2/kWh
|
|
meter_pef
|
(float) Meter PEF kgCO2/kWh
|
|
SCoP
|
(float, kW/kW) seasonal coefficient of performance
|
|
used_with_CHP
|
(bool) whether the heat source is used in conjunction with CHP
|
heating_ncm() -> dictionary
Heating NCM data for the Apache system.
Returns:
Dictionary with the following keys:
|
boiler_over_15_years_old
|
(bool) Whether the boiler is over 15 years old
|
|
convectors_have_fans
|
(bool) Whether convectors have fans
|
|
default_fan_power_ratio
|
(float) Default fan power ratio
|
|
default_generator_radiant_efficiency
|
(float) Default generator radiant efficiency
|
|
default_generator_seasonal_efficiency
|
(float) Default generator seasonal efficiency
|
|
fan_power_ratio
|
(float) Fan power ratio
|
|
fan_power_ratio_known
|
(bool) Whether the fan power ratio is known
|
|
generator_radiant_efficiency
|
(float) Generator radiant efficiency
|
|
generator_radiant_efficiency_known
|
(bool) Whether the generator radiant efficiency is known
|
|
generator_seasonal_efficiency
|
(float) Generator seasonal efficiency
|
|
generator_seasonal_efficiency_known
|
(bool) Do you know the generator seasonal efficiency?
|
|
heat_source
|
|
|
installed_after_98
|
(bool) Whether this system was installed on or after 1998
|
|
meter
|
|
|
qualify_for_ecas
|
|
|
uses_chp
|
(bool) Whether this system also uses CHP
|
hot_water(show_ncm) -> dictionary
Hot water data for the Apache system.
Parameters:
|
show_ncm (optional)
|
Whether to show NCM specific data in the output
|
Returns:
Dictionary with the following keys:
|
circulation_losses (optional)
|
(float, W/m) circulation losses. Only if secondary circulation is present
|
|
cold_water_inlet_temp
|
(float, °C) mean cold water inlet temperature
|
|
default_generator_seaonal_efficiency (optional)
|
(float) Default generator seasonal efficiency
|
|
del_eff
|
(float) DHW delivery efficiency
|
|
generator_meter (optional)
|
|
|
generator_seasonal_efficiency (optional)
|
(float) Seasonal generator efficiency
|
|
generator_type (optional)
|
|
|
has_ApHVAC_boiler
|
(Bool) whether the system is served by an ApacheHVAC boiler
|
|
has_secondary_circulation
|
(Bool) whether the system has secondary circulation
|
|
has_time_switch (optional)
|
(Bool) whether or not there is a time switch. Only if secondary circulation is present
|
|
insulation_thickness (optional)
|
(float, mm) insulation thickness. Only if storage is used
|
|
insulation_type (optional)
|
(int) type of insulation. See insulation_names().Only if storage is used
|
|
is_storage_system
|
(Bool) whether the system is a storage system
|
|
later_than_1998 (optional)
|
(Bool) Later than 1998?
|
|
loop_length (optional)
|
(float, meters) loop length. Only if secondary circulation is present
|
|
pump_power (optional)
|
(float, kW) pump power. Only if secondary circulation is present
|
|
storage_losses (optional)
|
(float, kWh/l/day) storage losses. Only if storage is used
|
|
storage_volume (optional)
|
(float, liters) storage volume. Only if storage is used
|
|
supply_temp
|
(float, °C) hot water supply temperature
|
|
use_default_generator_seaonal_efficiency (optional)
|
(bool) Do you know the generator seasonal efficiency?
|
|
pump_meter
|
|
metering_provision_ncm() -> dictionary
Metering provision NCM data for the Apache system.
Returns:
Dictionary with the following keys:
|
control_correction
|
(float) Control correction
|
|
provision_for_metering
|
(bool) Does the system have provisioning for metering?
|
|
warns
|
(bool) Does the metering warn 'out of range' values?
|
set_air_supply(air_supply_data)
Set air supply data from the supplied dictionary.
Dictionary keys are:
|
condition
|
|
cooling_max_flow
|
|
OA_max_flow
|
|
profile
|
|
temperature_difference
|
set_auxiliary_energy(aux_data)
Set auxiliary energy data from the supplied dictionary.
Dictionary keys are:
|
AEV
|
|
air_supply_mechanism
|
|
fan_fraction
|
|
method
|
|
off_schedule_AEV
|
|
SFP
|
set_bivalent_systems_ncm(data)
Set bivalent systems from the supplied list of dictionaries.
Dictionary keys are:
|
heat_source
|
|
meter
|
|
gen_seff
|
|
load
|
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
|
|
del_eff
|
|
free_cooling
|
|
fuel
|
|
gen_size
|
|
has_absorption_chiller
|
|
nominal_eer
|
|
pump_and_fan_power_perc
|
|
SEER
|
|
SSEER
|
set_cooling_ncm(data)
Set cooling NCM data from the supplied dictionary.
Dictionary keys are:
|
chiller_meter
|
|
generator_nominal_eer
|
|
generator_nominal_eer_known
|
|
generator_seasonal_eer
|
|
generator_seasonal_eer_known
|
|
mixed_mode
|
|
power
|
|
qualify_for_eca
|
|
type
|
set_default(system_id)
Set the default system ID.
set_general_ncm(data)
Set general NCM data from the supplied dictionary.
Dictionary keys are:
|
is_proxy_for_hvac
|
|
ncm_system_type
|
set_heating(heating_data)
Set heating data from the supplied dictionary.
Dictionary keys are:
|
CHP_heat_output
|
|
CHP_ranking
|
|
fuel
|
|
gen_seasonal_eff
|
|
gen_size
|
|
HR_effectiveness
|
|
HR_return_temp
|
|
is_heat_pump
|
|
meter_cef
|
|
meter_pef
|
|
SCoP
|
|
used_with_CHP
|
set_heating_ncm(data)
Set heating NCM data from the supplied dictionary.
Dictionary keys are:
|
boiler_over_15_years_old
|
|
convectors_have_fans
|
|
default_fan_power_ratio
|
|
default_generator_radiant_efficiency
|
|
default_generator_seasonal_efficiency
|
|
fan_power_ratio
|
|
fan_power_ratio_known
|
|
generator_radiant_efficiency
|
|
generator_radiant_efficiency_known
|
|
generator_seasonal_efficiency
|
|
generator_seasonal_efficiency_known
|
|
heat_source
|
|
installed_after_98
|
|
Is_heat_pump
|
|
meter
|
|
meter_cef
|
|
meter_pef
|
|
qualify_for_ecas
|
|
uses_chp
|
set_hot_water(hot_water_data)
Set hot water data from the supplied dictionary.
Dictionary keys are:
|
circulation_losses
|
|
cold_water_inlet_temp
|
|
del_eff
|
|
generator_meter
|
|
generator_seasonal_efficiency
|
|
generator_type
|
|
has_ApHVAC_boiler
|
|
has_secondary_circulation
|
|
has_time_switch
|
|
insulation_thickness
|
|
insulation_type
|
|
is_storage_system
|
|
later_than_1998
|
|
loop_length
|
|
pump_power
|
|
storage_losses
|
|
storage_volume
|
|
supply_temp
|
|
use_default_generator_seaonal_efficiency
|
set_metering_provision_ncm(data)
Set metering provsion NCM data from the supplied dictionary.
Dictionary keys are:
|
provision_for_metering
|
|
warns
|
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:
|
abso_absorptance
|
|
abso_radius
|
|
area
|
|
azimuth
|
|
coeff_a1
|
|
coeff_a2
|
|
coeff_c1
|
|
coeff_c2
|
|
conversion_eff
|
|
cover_trans
|
|
degradation_factor
|
|
flow_rate
|
|
fluid_flow
|
|
has_space_or_process_heating
|
|
heat_capacity
|
|
HX_effectiveness
|
|
intercept_factor
|
|
mirror_reflectance
|
|
num_rows
|
|
pump_fuel
|
|
pump_power
|
|
refl_focal_length
|
|
refl_length
|
|
refl_width
|
|
return_temp
|
|
shading_factor
|
|
storage_loss
|
|
supply_temp
|
|
tank_heat_loss
|
|
tank_volume
|
|
tilt
|
|
tube_extension
|
|
type
|
|
units_per_row
|
|
volume
|
set_solar_water_heating_ncm(data)
Set solar hot water heating NCM data from the supplied dictionary.
Dictionary keys are:
|
a1
|
|
a2
|
|
circulation_system
|
|
heat_transfer_rate
|
|
iam
|
|
insulation_thickness
|
|
insulation_type
|
|
is_heat_exchanger
|
|
is_solar_heating
|
|
nominal_pump_power
|
|
overall_heat_loss_coeff
|
|
panel_area
|
|
panel_azimuth
|
|
panel_tilt
|
|
performance_parameters
|
|
performance_parameters_known
|
|
pipes_insulated
|
|
preheating_type
|
|
sigma_0
|
|
volume
|
set_system_adjustment_ncm(data)
Set system adjustment NCM data from the supplied dictionary.
Dictionary keys are:
|
ahu_meets_standards
|
|
cen_class
|
|
ductwork_leakage_test
|
|
ductwork_leakage_test_done
|
|
pump_type
|
|
specific_fan_power
|
|
specific_fan_power_known
|
set_system_controls_ncm(data)
Set system control NCM data from the supplied dictionary.
Dictionary keys are:
|
central_time_control
|
|
local_temperature_control
|
|
local_time_control
|
|
optimum_start_stop_control
|
|
weather_compensation_control
|
set_ventilation_ncm(data)
Set ventilation NCM data from the supplied dictionary.
Dictionary keys are:
|
air_supply_mechanism
|
|
heat_recovery_type
|
|
heat_recovery_efficiency_known
|
|
heat_recovery_efficiency
|
|
variable_heat_recovery
|
solar_water_heating() -> dictionary
Solar water heating data for the Apache system. Returns dictionary with the following keys:
Flat collectors also have the following keys:
|
area
|
(float, m2) Area
|
|
azimuth
|
(float, Degrees clockwise from North) azimuth
|
|
coeff_a1
|
(float, W/m2/K) First order heat loss coefficient (a1)
|
|
coeff_a2
|
(float, W/m2/K) Second order heat loss coefficient (a2)
|
|
conversion_eff
|
(float) Conversion efficiency at ambient temperature
|
|
degradation_factor
|
(float) Degradation factor
|
|
flow_rate
|
(float, l/h/m2) Flow rate
|
|
HX_effectiveness
|
(float) Heat exchanger effectiveness
|
|
pump_fuel
|
|
|
pump_meter_branch
|
(tuple) Pump meter branch
|
|
pump_power
|
(float, kW) Pump power
|
|
shading_factor
|
(float) Shading factor
|
|
storage_loss
|
(float, kWh/l/day) Storage loss at max. temperature
|
|
tilt
|
(float, degrees from horizontal) Tilt
|
|
volume
|
(float, liters) Volume
|
Parabolic collectors also have the following keys:
|
abso_absorptance
|
(float) Absorptance of absorber tube
|
|
abso_radius
|
(float, m) Radius of absorber tube
|
|
azimuth
|
(float, degrees from North) Angle of collector tube
|
|
coeff_c1
|
(float) First order loss coefficient per unit aperture area
|
|
coeff_c2
|
(float) Second order loss coefficient per unit aperture area
|
|
cover_trans
|
(float) Transmittance of cover tube
|
|
fluid_flow
|
(float, l/h/m2) Total fluid flow
|
|
heat_capacity
|
(float, J/kg/K) Fluid specific heat capacity
|
|
HX_effectiveness
|
(float) Heat exchanger effectiveness
|
|
intercept_factor
|
(float) Fraction of beam radiation intercepted by receiver
|
|
mirror_reflectance
|
(float) Reflectance of the mirror
|
|
num_rows
|
(int) Number of rows (in parallel)
|
|
pump_fuel
|
|
|
pump_meter_branch
|
(tuple) Pump meter branch
|
|
pump_power
|
(float, kW) Pump power
|
|
refl_focal_length
|
(float, m) Focal length of one reflector collector unit
|
|
refl_length
|
(float, m) Length of one reflector collector unit
|
|
refl_width
|
(float, m) Width of one reflector collector unit
|
|
tank_heat_loss
|
(float, kWh/l/day) Design tank heat loss
|
|
tank_volume
|
(float, l) Tank volume
|
|
tube_extension
|
(float, m) Extension of tube beyond a single unit
|
|
units_per_row
|
(int) Collector units per row (in series)
|
Flat and parabolic collectors also have the following keys:
|
has_space_or_process_heating
|
Whether there is space or process heating
|
|
return_temp (optional)
|
Water loop design return temperature (°C)
|
|
supply_temp (optional)
|
Water loop design supply temperature (°C)
|
solar_water_heating_ncm() -> dictionary
Solar water heating data for NCM mode. Returns dictionary with the folllowing keys:
|
a1
|
a1 W/m^2K
|
|
a2
|
a2 W/m^2
|
|
circulation_system
|
Circulation system
|
|
heat_transfer_rate
|
Heat transfer rate (W/K)
|
|
iam
|
IAM
|
|
insulation_thickness
|
Insulation thickness (mm)
|
|
insulation_type
|
Insulation type
|
|
is_heat_exchanger
|
Is there a heat exchanger?
|
|
is_solar_heating
|
Is there a solar heating system?
|
|
nominal_pump_power
|
Nomincal pump power, Paux (W)
|
|
overall_heat_loss_coeff
|
Overall heat loss coeff (W/K)
|
|
panel_area
|
Solar panel area (m^2)
|
|
panel_azimuth
|
Solar panel azimuth (degrees clockwise from north)
|
|
panel_tilt
|
Solar panel tilt (degrees from horizontal)
|
|
performance_parameter
|
Performance parameter
|
|
performance_parameters_known
|
Do you know the performance parameters?
|
|
pipes_insulated
|
Are pipes to back-up system insulated?
|
|
preheating_type
|
Pre-heating type
|
|
sigma_0
|
Sigma-0
|
|
volume
|
Solar storage volume (l)
|
system_adjustment_ncm() -> dictionary
System adjustment NCM data for the Apache system. Returns dictionary with the folllowing keys:
|
ahu_meets_standards
|
(bool) Does the AHU meet CEN leakage standards?
|
|
air_leakage
|
(float) Air leakage
|
|
cen_class
|
|
|
default_specific_fan_power
|
(float) Default specific fan power
|
|
ductwork_leakage_test
|
|
|
ductwork_leakage_test_done
|
(bool) Has the ductwork been leakage tested?
|
|
pump_type
|
|
|
specific_fan_power
|
(float) Specific Fan Power of the system
|
|
specific_fan_power_known
|
(bool) Do you know the Specific Fan Power?
|
system_controls_ncm() -> dictionary
System controls NCM data for the Apache system. Returns dictionary with the following keys:
|
central_time_control
|
(bool) Central time control
|
|
local_temperature_control
|
(bool) Local temperature control (i.e., room by room)
|
|
local_time_control
|
(bool) Local time control (i.e., room by room)
|
|
optimum_start_stop_control
|
(bool) Optimum start/stop control
|
|
weather_compensation_control
|
(bool) Weather compensation control
|
ventilation_ncm() -> dictionary
Ventilation NCM data for the Apache system. Returns dictionary with the following keys:
|
air_supply_mechanism
|
|
|
cool_vent_mechanism
|
|
|
default_heat_recovery_efficiency
|
(float) Default heat recovery seasonal efficiency
|
|
heat_recovery_efficiency
|
(float) Heat recovery seasonal efficiency
|
|
heat_recovery_efficiency_known
|
(bool) Do you know the heat recovery seasonal efficiency?
|
|
heat_recovery_type
|
|
|
variable_heat_recovery
|
(bool) Variable heat recovery efficiency?
|
