# accim - Adaptive-Comfort-Control-Implemented Model
# Copyright (C) 2021-2025 Daniel Sánchez-García
# accim is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# any later version.
# accim is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
"""
Contains the functions to apply setpoints based on the Adaptive Predicted Mean Vote (aPMV) index
"""
import besos.IDF_class
from typing import Union, List
import pandas
# from eppy.bunch_subclass import BadEPFieldError
import eppy
[docs]
def apply_apmv_setpoints(
building: besos.IDF_class,
outputs_freq: List[str] = ['hourly'],
other_PMV_related_outputs: bool = True,
adap_coeff_cooling: Union[float, dict] = 0.293,
adap_coeff_heating: Union[float, dict] = -0.293,
pmv_cooling_sp: Union[float, dict] = -0.5,
pmv_heating_sp: Union[float, dict] = 0.5,
tolerance_cooling_sp_cooling_season: Union[float, dict] = -0.1,
tolerance_cooling_sp_heating_season: Union[float, dict] = -0.1,
tolerance_heating_sp_cooling_season: Union[float, dict] = 0.1,
tolerance_heating_sp_heating_season: Union[float, dict] = 0.1,
cooling_season_start: Union[float, str] = 120,
cooling_season_end: Union[float, str] = 210,
dflt_for_adap_coeff_cooling: float = 0.4,
dflt_for_adap_coeff_heating: float = -0.4,
dflt_for_pmv_cooling_sp: float = 0.5,
dflt_for_pmv_heating_sp: float = -0.5,
dflt_for_tolerance_cooling_sp_cooling_season: float = -0.1,
dflt_for_tolerance_cooling_sp_heating_season: float = -0.1,
dflt_for_tolerance_heating_sp_cooling_season: float = 0.1,
dflt_for_tolerance_heating_sp_heating_season: float = 0.1,
verboseMode: bool = True,
) -> besos.IDF_class:
"""
Applies setpoints based on the Adaptive Predicted Mean Vote (aPMV) index.
:param building: The besos.IDF_class. You can make it by using besos.eppy_funcs.get_building
:param adap_coeff_cooling: A dictionary containing all the zone names in the key field,
and the value for the adaptive coefficient (Lambda, λ) at the cooling season, for example:
{'zonename1': 0.1, 'zonename2': 0.5}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param adap_coeff_heating: A dictionary containing all the zone names in the key field,
and the value for the adaptive coefficient (Lambda, λ) at the heating season, for example:
{'zonename1': -0.1, 'zonename2': -0.5}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param pmv_cooling_sp: A dictionary containing all the zone names in the key field,
and the value for the cooling PMV setpoint, for example:
{'zonename1': 0.5, 'zonename2': 0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param pmv_heating_sp: A dictionary containing all the zone names in the key field,
and the value for the heating PMV setpoint, for example:
{'zonename1': -0.5, 'zonename2': -0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param tolerance_cooling_sp_cooling_season: A dictionary containing all the zone names
in the key field, and the value for the cooling PMV setpoint tolerance in cooling season;
this value will be summed to the resulting aPMV setpoint, therefore, in this case should be
a negative number, for example: {'zonename1': -0.1, 'zonename2': -0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param tolerance_cooling_sp_heating_season: A dictionary containing all the zone names
in the key field, and the value for the cooling PMV setpoint tolerance in heating season;
this value will be summed to the resulting aPMV setpoint, therefore, in this case should be
a negative number, for example: {'zonename1': -0.1, 'zonename2': -0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param tolerance_heating_sp_cooling_season: A dictionary containing all the zone names
in the key field, and the value for the heating PMV setpoint tolerance in cooling season;
this value will be summed to the resulting aPMV setpoint, therefore, in this case should be
a positive number, for example: {'zonename1': 0.1, 'zonename2': 0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param tolerance_heating_sp_heating_season: A dictionary containing all the zone names
in the key field, and the value for the heating PMV setpoint tolerance in heating season;
this value will be summed to the resulting aPMV setpoint, therefore, in this case should be
a positive number, for example: {'zonename1': 0.1, 'zonename2': 0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param dflt_for_adap_coeff_cooling: Float default value applied to the
adap_coeff_cooling argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_adap_coeff_heating: Float default value applied to the
adap_coeff_heating argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_pmv_cooling_sp: Float default value applied to the pmv_cooling_sp argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_pmv_heating_sp: Float default value applied to the pmv_heating_sp argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_tolerance_cooling_sp_cooling_season: Float default value applied to the
tolerance_cooling_sp_cooling_season argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_tolerance_cooling_sp_heating_season: Float default value applied to the
tolerance_cooling_sp_heating_season argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_tolerance_heating_sp_cooling_season: Float default value applied to the
tolerance_heating_sp_cooling_season argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_tolerance_heating_sp_heating_season: Float default value applied to the
tolerance_heating_sp_heating_season argument,
for those occupied zones not specified in the dictionary keys.
:param outputs_freq: A list containing some of the following strings:
['timestep', 'hourly', 'daily', 'monthly', 'runperiod'].
Default value is set to ['hourly'].
Used to define the frequency of the Output:Variable objects.
:param other_PMV_related_outputs: True to print other PMV related outputs.
:param cooling_season_start: The day of the year or a date in the format 'dd/mm'.
Used to define the start of the cooling season.
:param cooling_season_end: The day of the year or a date in the format 'dd/mm'.
Used to define the end of the cooling season.
:param verboseMode: True to print on screen all actions performed.
:return:
"""
# Mapping occupied zones (i.e. zones that have a related people object)
#todo testing from here
# # Scanning occupied zones
# occupiedZones_orig = []
#
# # Check if model comes from OpenStudio
#
# # Check if ZoneList or SpaceList are used
# occupiedZones_orig_osm = []
#
# spacelist_use = False
# try:
# if len(building.idfobjects['SPACELIST']) > 0:
# spacelist_use = True
# spacenames_for_ems_uniquekey = []
# spacenames_for_ems_name = []
# spacenames_for_ems_uniquekey_people = []
# zonenames_for_ems_with_sl = []
# for people in building.idfobjects['PEOPLE']:
# for spacelist in [i for i in building.idfobjects['SPACELIST'] if i.Name == people.Zone_or_ZoneList_or_Space_or_SpaceList_Name]:
# for space in [i for i in building.idfobjects['SPACE'] if i.Space_Type == spacelist.Name]:
# spacenames_for_ems_uniquekey.append(f'{space.Name} {spacelist.Name}')
# spacenames_for_ems_name.append(space.Name)
# spacenames_for_ems_uniquekey_people.append(f'{space.Name} {people.Name}')
# occupiedZones_orig_osm.append(space.Zone_Name)
# for zone in [i for i in building.idfobjects['ZONE'] if space.Zone_Name == i.Name]:
# zonenames_for_ems_with_sl.append(zone.Name)
# except KeyError:
# idd = '-'.join([str(i) for i in building.idd_version])
# print('Searching Spacelist objects returned KeyError. '
# f'That means these are not supported in the EnergyPlus version {idd}')
#
# occupiedZones_orig_dsb = []
# for i in building.idfobjects['ZONE']:
# for k in building.idfobjects['PEOPLE']:
# try:
# if i.Name == k.Zone_or_ZoneList_or_Space_or_SpaceList_Name:
# occupiedZones_orig_dsb.append(i.Name.upper())
# except eppy.bunch_subclass.BadEPFieldError:
# if i.Name == k.Zone_or_ZoneList_Name:
# occupiedZones_orig_dsb.append(i.Name.upper())
#
# if spacelist_use:
# occupiedZones_orig = occupiedZones_orig_osm
# occupiedZones = [i.replace(' ', '_') for i in occupiedZones_orig]
# origin_dsb = False
# ems_objs_name = spacenames_for_ems_name
# ems_objs_key = spacenames_for_ems_uniquekey
# ems_zonenames = zonenames_for_ems_with_sl
# ems_zonenames_underscore = [i.replace(' ', '_') for i in ems_zonenames]
# else:
# occupiedZones_orig = occupiedZones_orig_dsb
# occupiedZones = [i.replace(':', '_') for i in occupiedZones_orig]
# origin_dsb = True
# ems_objs_name = occupiedZones
# ems_objs_key = occupiedZones_orig
# ems_zonenames = occupiedZones_orig
# ems_zonenames_underscore = occupiedZones_orig
#todo testing until here
try:
ppl_temp = [[people.Zone_or_ZoneList_Name, people.Name] for people in building.idfobjects['People']]
except eppy.bunch_subclass.BadEPFieldError:
print('Zone_or_ZoneList_Name field not found in People object.')
try:
ppl_temp = [[people.Zone_or_ZoneList_or_Space_or_SpaceList_Name, people.Name] for people in building.idfobjects['People']]
except eppy.bunch_subclass.BadEPFieldError:
print('Zone_or_ZoneList_or_Space_or_SpaceList_Name field not found in People object.')
try:
ppl_temp = [[people.Zone_Name, people.Name] for people in building.idfobjects['People']]
except eppy.bunch_subclass.BadEPFieldError:
print('Zone_Name field not found in People object.')
zones_with_ppl_colon = [ppl[0] for ppl in ppl_temp]
ppl_names = [ppl[1] for ppl in ppl_temp]
zones_with_ppl_underscore = [z.replace(':', '_') for z in zones_with_ppl_colon]
# Managing cooling season start user input: transform dd/mm date into number if needed
if type(cooling_season_start) is str:
from accim.utils import transform_ddmm_to_int
cooling_season_start = transform_ddmm_to_int(cooling_season_start)
if type(cooling_season_end) is str:
from accim.utils import transform_ddmm_to_int
cooling_season_end = transform_ddmm_to_int(cooling_season_end)
# Gathering adap_coeff_cooling, adap_coeff_heating, pmv_cooling_sp, pmv_heating_sp arguments into df
df_arguments = generate_df_from_args(
building=building,
adap_coeff_heating=adap_coeff_heating,
adap_coeff_cooling=adap_coeff_cooling,
pmv_heating_sp=pmv_heating_sp,
pmv_cooling_sp=pmv_cooling_sp,
tolerance_cooling_sp_cooling_season=tolerance_cooling_sp_cooling_season,
tolerance_cooling_sp_heating_season=tolerance_cooling_sp_heating_season,
tolerance_heating_sp_cooling_season=tolerance_heating_sp_cooling_season,
tolerance_heating_sp_heating_season=tolerance_heating_sp_heating_season,
dflt_for_adap_coeff_cooling=dflt_for_adap_coeff_cooling,
dflt_for_adap_coeff_heating=dflt_for_adap_coeff_heating,
dflt_for_pmv_cooling_sp=dflt_for_pmv_cooling_sp,
dflt_for_pmv_heating_sp=dflt_for_pmv_heating_sp,
dflt_for_tolerance_cooling_sp_cooling_season=dflt_for_tolerance_cooling_sp_cooling_season,
dflt_for_tolerance_cooling_sp_heating_season=dflt_for_tolerance_cooling_sp_heating_season,
dflt_for_tolerance_heating_sp_cooling_season=dflt_for_tolerance_heating_sp_cooling_season,
dflt_for_tolerance_heating_sp_heating_season=dflt_for_tolerance_heating_sp_heating_season,
)
# Adding Schedule:Compact objects for PMV setpoints
sch_comp_objs = [i.Name for i in building.idfobjects['Schedule:Compact']]
for i in ['PMV_H_SP', 'PMV_C_SP']:
for zone in zones_with_ppl_underscore:
if f'{i}_{zone}' in sch_comp_objs:
if verboseMode:
print(f"{i}_{zone} Schedule already was in the model")
else:
building.newidfobject(
'Schedule:Compact',
Name=f'{i}_{zone}',
Schedule_Type_Limits_Name="Any Number",
Field_1='Through: 12/31',
Field_2='For: AllDays',
Field_3='Until: 24:00,1'
)
if verboseMode:
print(f"{i}_{zone} Schedule has been added")
comf_fanger_dualsps = [i for i in building.idfobjects['ThermostatSetpoint:ThermalComfort:Fanger:DualSetpoint']]
for i in comf_fanger_dualsps:
for j in range(len(zones_with_ppl_colon)):
if zones_with_ppl_colon[j] in i.Name:
i.Fanger_Thermal_Comfort_Heating_Schedule_Name = f'PMV_H_SP_{zones_with_ppl_underscore[j]}'
i.Fanger_Thermal_Comfort_Cooling_Schedule_Name = f'PMV_C_SP_{zones_with_ppl_underscore[j]}'
# EMS
# Adding sensors
sensornamelist = ([sensor.Name for sensor in building.idfobjects['EnergyManagementSystem:Sensor']])
for i in range(len(zones_with_ppl_underscore)):
if f'PMV_{zones_with_ppl_underscore[i]}' in sensornamelist:
if verboseMode:
print(f'Not added - PMV_{zones_with_ppl_underscore[i]} Sensor')
else:
building.newidfobject(
'EnergyManagementSystem:Sensor',
Name=f'PMV_{zones_with_ppl_underscore[i]}',
OutputVariable_or_OutputMeter_Index_Key_Name=ppl_names[i],
OutputVariable_or_OutputMeter_Name='Zone Thermal Comfort Fanger Model PMV'
)
if verboseMode:
print(f'Added - PMV_{zones_with_ppl_underscore[i]} Sensor')
if f'People_Occupant_Count_{zones_with_ppl_underscore[i]}' in sensornamelist:
if verboseMode:
print(f'Not added - People_Occupant_Count_{zones_with_ppl_underscore[i]} Sensor')
else:
building.newidfobject(
'EnergyManagementSystem:Sensor',
Name=f'People_Occupant_Count_{zones_with_ppl_underscore[i]}',
OutputVariable_or_OutputMeter_Index_Key_Name=ppl_names[i],
OutputVariable_or_OutputMeter_Name='People Occupant Count'
)
if verboseMode:
print(f'Added - People_Occupant_Count_{zones_with_ppl_underscore[i]} Sensor')
# Adding actuators
actuatornamelist = [actuator.Name for actuator in building.idfobjects['EnergyManagementSystem:Actuator']]
for i in ['PMV_H_SP', 'PMV_C_SP']:
for zone in zones_with_ppl_underscore:
if f'{i}_act_{zone}' in actuatornamelist:
if verboseMode:
print(f'Not added - {i}_act_{zone} Actuator')
else:
building.newidfobject(
'EnergyManagementSystem:Actuator',
Name=f'{i}_act_{zone}',
Actuated_Component_Unique_Name=f'{i}_{zone}',
Actuated_Component_Type='Schedule:Compact',
Actuated_Component_Control_Type='Schedule Value',
)
if verboseMode:
print(f'Added - {i}_act_{zone} Actuator')
# Adding GlobalVariables
globalvariablenames = [
'CoolingSeason',
'CoolSeasonEnd',
'CoolSeasonStart'
]
globalvariablezonenames = []
for i in [
'tolerance_cooling_sp',
'tolerance_cooling_sp_cooling_season',
'tolerance_cooling_sp_heating_season',
'tolerance_heating_sp',
'tolerance_heating_sp_cooling_season',
'tolerance_heating_sp_heating_season',
'adap_coeff',
'adap_coeff_heating',
'adap_coeff_cooling',
'pmv_heating_sp',
'pmv_cooling_sp',
'aPMV',
'comfhour',
'discomfhour',
'discomfhour_heat',
'discomfhour_cold',
'occupied_hour',
'aPMV_H_SP',
'aPMV_C_SP',
'aPMV_H_SP_noTol',
'aPMV_C_SP_noTol',
]:
for zone in zones_with_ppl_underscore:
globalvariablezonenames.append(f'{i}_{zone}')
allgvs = globalvariablenames + globalvariablezonenames
for gv in allgvs:
building.newidfobject(
'EnergyManagementSystem:GlobalVariable',
Erl_Variable_1_Name=gv,
)
if verboseMode:
print(f'Added - {gv} GlobalVariable object')
# Programs
programlist = [
program.Name
for program
in building.idfobjects['EnergyManagementSystem:Program']
]
if f'set_cooling_season_input_data' in programlist:
if verboseMode:
print(f'Not added - set_cooling_season_input_data Program')
else:
building.newidfobject(
'EnergyManagementSystem:Program',
Name=f'set_cooling_season_input_data',
Program_Line_1=f'set CoolSeasonStart = {cooling_season_start}',
Program_Line_2=f'set CoolSeasonEnd = {cooling_season_end}'
)
if verboseMode:
print(f'Added - set_cooling_season_input_data Program')
if f'set_cooling_season' in programlist:
if verboseMode:
print(f'Not added - set_cooling_season Program')
else:
building.newidfobject(
'EnergyManagementSystem:Program',
Name=f'set_cooling_season',
Program_Line_1='if CoolSeasonEnd > CoolSeasonStart',
Program_Line_2='if (DayOfYear >= CoolSeasonStart) && (DayOfYear < CoolSeasonEnd)',
Program_Line_3='set CoolingSeason = 1',
Program_Line_4='else',
Program_Line_5='set CoolingSeason = 0',
Program_Line_6='endif',
Program_Line_7='elseif CoolSeasonStart > CoolSeasonEnd',
Program_Line_8='if (DayOfYear >= CoolSeasonStart) || (DayOfYear < CoolSeasonEnd)',
Program_Line_9='set CoolingSeason = 1',
Program_Line_10='else',
Program_Line_11='set CoolingSeason = 0',
Program_Line_12='endif',
Program_Line_13='endif',
)
if verboseMode:
print(f'Added - set_cooling_season Program')
for i in zones_with_ppl_colon:
zonename = df_arguments.loc[i, 'underscore_zonename']
if f'set_zone_input_data_{zonename}' in programlist:
if verboseMode:
print(f'Not added - set_zone_input_data_{zonename} Program')
else:
building.newidfobject(
'EnergyManagementSystem:Program',
Name=f'set_zone_input_data_{zonename}',
Program_Line_1=f'set adap_coeff_cooling_{zonename} = {df_arguments.loc[i, "adap_coeff_cooling"]}',
Program_Line_2=f'set adap_coeff_heating_{zonename} = {df_arguments.loc[i, "adap_coeff_heating"]}',
Program_Line_3=f'set pmv_cooling_sp_{zonename} = {df_arguments.loc[i, "pmv_cooling_sp"]}',
Program_Line_4=f'set pmv_heating_sp_{zonename} = {df_arguments.loc[i, "pmv_heating_sp"]}',
Program_Line_5=f'set tolerance_cooling_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_cooling_season"]}',
Program_Line_6=f'set tolerance_cooling_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_heating_season"]}',
Program_Line_7=f'set tolerance_heating_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_cooling_season"]}',
Program_Line_8=f'set tolerance_heating_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_heating_season"]}',
)
if verboseMode:
print(f'Added - set_zone_input_data_{zonename} Program')
if f'apply_aPMV_{zonename}' in programlist:
if verboseMode:
print(f'Not added - apply_aPMV_{zonename} Program')
else:
building.newidfobject(
'EnergyManagementSystem:Program',
Name=f'apply_aPMV_{zonename}',
Program_Line_1='if CoolingSeason == 1',
Program_Line_2='set adap_coeff_' + zonename + ' = adap_coeff_cooling_' + zonename + '',
Program_Line_3='set tolerance_cooling_sp_' + zonename + ' = tolerance_cooling_sp_cooling_season_' + zonename + '',
Program_Line_4='set tolerance_heating_sp_' + zonename + ' = tolerance_heating_sp_cooling_season_' + zonename + '',
Program_Line_5='elseif CoolingSeason == 0',
Program_Line_6='set adap_coeff_' + zonename + ' = adap_coeff_heating_' + zonename + '',
Program_Line_7='set tolerance_cooling_sp_' + zonename + ' = tolerance_cooling_sp_heating_season_' + zonename + '',
Program_Line_8='set tolerance_heating_sp_' + zonename + ' = tolerance_heating_sp_heating_season_' + zonename + '',
Program_Line_9='endif',
Program_Line_10='set aPMV_H_SP_noTol_' + zonename + ' = pmv_heating_sp_' + zonename + '/(1+adap_coeff_' + zonename + '*pmv_heating_sp_' + zonename + ')',
Program_Line_11='set aPMV_C_SP_noTol_' + zonename + ' = pmv_cooling_sp_' + zonename + '/(1+adap_coeff_' + zonename + '*pmv_cooling_sp_' + zonename + ')',
Program_Line_12='set aPMV_H_SP_' + zonename + ' = aPMV_H_SP_noTol_' + zonename + '+tolerance_heating_sp_' + zonename + '',
Program_Line_13='set aPMV_C_SP_' + zonename + ' = aPMV_C_SP_noTol_' + zonename + '+tolerance_cooling_sp_' + zonename + '',
Program_Line_14='if People_Occupant_Count_' + zonename + ' > 0',
Program_Line_15='if aPMV_H_SP_' + zonename + ' < 0',
Program_Line_16='set PMV_H_SP_act_' + zonename + ' = aPMV_H_SP_' + zonename + '',
Program_Line_17='else',
Program_Line_18='set PMV_H_SP_act_' + zonename + ' = 0',
Program_Line_19='endif',
Program_Line_20='if aPMV_C_SP_' + zonename + ' > 0',
Program_Line_21='set PMV_C_SP_act_' + zonename + ' = aPMV_C_SP_' + zonename + '',
Program_Line_22='else',
Program_Line_23='set PMV_C_SP_act_' + zonename + ' = 0',
Program_Line_24='endif',
Program_Line_25='else',
Program_Line_26='set PMV_H_SP_act_' + zonename + ' = -100',
Program_Line_27='set PMV_C_SP_act_' + zonename + ' = 100',
Program_Line_28='endif',
)
if verboseMode:
print(f'Added - apply_aPMV_{zonename} Program')
for zonename in zones_with_ppl_underscore:
if 'monitor_aPMV_' + zonename in programlist:
if verboseMode:
print('Not added - monitor_aPMV_' + zonename + ' Program')
else:
building.newidfobject(
'EnergyManagementSystem:Program',
Name='monitor_aPMV_' + zonename,
Program_Line_1='set aPMV_' + zonename + ' = PMV_' + zonename + '/(1+adap_coeff_' + zonename + '*PMV_' + zonename + ')',
)
if verboseMode:
print('Added - monitor_aPMV_' + zonename + ' Program')
if 'count_aPMV_comfort_hours_' + zonename in programlist:
if verboseMode:
print('Not added - count_aPMV_comfort_hours_' + zonename + ' Program')
else:
building.newidfobject(
'EnergyManagementSystem:Program',
Name='count_aPMV_comfort_hours_' + zonename,
Program_Line_1='if aPMV_' + zonename + ' < aPMV_H_SP_noTol_' + zonename + '',
Program_Line_2='set comfhour_' + zonename + ' = 0',
Program_Line_3='set discomfhour_cold_' + zonename + ' = 1*ZoneTimeStep',
Program_Line_4='set discomfhour_heat_' + zonename + ' = 0',
Program_Line_5='elseif aPMV_' + zonename + ' > aPMV_C_SP_noTol_' + zonename + '',
Program_Line_6='set comfhour_' + zonename + ' = 0',
Program_Line_7='set discomfhour_cold_' + zonename + ' = 0',
Program_Line_8='set discomfhour_heat_' + zonename + ' = 1*ZoneTimeStep',
Program_Line_9='else',
Program_Line_10='set comfhour_' + zonename + ' = 1*ZoneTimeStep',
Program_Line_11='set discomfhour_cold_' + zonename + ' = 0',
Program_Line_12='set discomfhour_heat_' + zonename + ' = 0',
Program_Line_13='endif',
Program_Line_14='if People_Occupant_Count_' + zonename + ' > 0',
Program_Line_15='set occupied_hour_' + zonename + ' = 1*ZoneTimeStep',
Program_Line_16='else',
Program_Line_17='set occupied_hour_' + zonename + ' = 0',
Program_Line_18='endif',
Program_Line_19='set discomfhour_' + zonename + ' = discomfhour_cold_' + zonename + ' + discomfhour_heat_' + zonename + '',
)
if verboseMode:
print('Added - count_aPMV_comfort_hours_' + zonename + ' Program')
programlist = ([program.Name
for program
in building.idfobjects['EnergyManagementSystem:Program']])
pcmlist = ([pcm.Name
for pcm
in building.idfobjects['EnergyManagementSystem:ProgramCallingManager']])
for i in programlist:
if i in pcmlist:
if verboseMode:
print('Not added - ' + i + ' Program Calling Manager')
else:
building.newidfobject(
'EnergyManagementSystem:ProgramCallingManager',
Name=i,
EnergyPlus_Model_Calling_Point="BeginTimestepBeforePredictor",
Program_Name_1=i
)
if verboseMode:
print('Added - ' + i + ' Program Calling Manager')
# EMS:OutputVariable
outputvariablelist = [
outvar.Name
for outvar
in building.idfobjects['EnergyManagementSystem:OutputVariable']
]
EMSOutputVariableZone_dict = {
# 'Adaptive Predicted Mean Vote': ['aPMV', '', 'Averaged'],
# 'Adaptive Predicted Mean Vote Heating Setpoint': ['aPMV_H_SP', '', 'Averaged'],
# 'Adaptive Predicted Mean Vote Cooling Setpoint': ['aPMV_C_SP', '', 'Averaged'],
# 'Adaptive Predicted Mean Vote Heating Setpoint No Tolerance': ['aPMV_H_SP_noTol', '', 'Averaged'],
# 'Adaptive Predicted Mean Vote Cooling Setpoint No Tolerance': ['aPMV_C_SP_noTol', '', 'Averaged'],
'Adaptive Coefficient': ['adap_coeff', '', 'Averaged'],
'aPMV': ['aPMV', '', 'Averaged'],
'aPMV Heating Setpoint': ['aPMV_H_SP', '', 'Averaged'],
'aPMV Cooling Setpoint': ['aPMV_C_SP', '', 'Averaged'],
'aPMV Heating Setpoint No Tolerance': ['aPMV_H_SP_noTol', '', 'Averaged'],
'aPMV Cooling Setpoint No Tolerance': ['aPMV_C_SP_noTol', '', 'Averaged'],
'Comfortable Hours': ['comfhour', 'H', 'Summed'],
'Discomfortable Hot Hours': ['discomfhour_heat', 'H', 'Summed'],
'Discomfortable Cold Hours': ['discomfhour_cold', 'H', 'Summed'],
'Discomfortable Total Hours': ['discomfhour', 'H', 'Summed'],
'Occupied hours': ['occupied_hour', 'H', 'Summed'],
# 'Zone Floor Area': ['ZoneFloorArea', 'm2', 'Averaged'],
# 'Zone Air Volume': ['ZoneAirVolume', 'm3', 'Averaged'],
}
for i in EMSOutputVariableZone_dict:
for zonename in zones_with_ppl_underscore:
if i + '_' + zonename in outputvariablelist:
if verboseMode:
print('Not added - ' + i + '_'
+ zonename + ' Output Variable')
else:
building.newidfobject(
'EnergyManagementSystem:OutputVariable',
Name=i + '_' + zonename,
EMS_Variable_Name=EMSOutputVariableZone_dict[i][0] + '_'
+ zonename,
Type_of_Data_in_Variable=EMSOutputVariableZone_dict[i][2],
Update_Frequency='ZoneTimestep',
EMS_Program_or_Subroutine_Name='',
Units=EMSOutputVariableZone_dict[i][1]
)
if verboseMode:
print('Added - ' + i + '_'
+ zonename + ' Output Variable')
# Output:Variable
EMSoutputvariablenamelist = [
outputvariable.Name
for outputvariable
in building.idfobjects['EnergyManagementSystem:OutputVariable']
]
for freq in outputs_freq:
outputnamelist = (
[
output.Variable_Name
for output
in building.idfobjects['Output:Variable']
if output.Reporting_Frequency == freq.capitalize()
]
)
for outputvariable in EMSoutputvariablenamelist:
if outputvariable in outputnamelist:
if verboseMode:
print('Not added - ' + outputvariable + ' Reporting Frequency ' + freq.capitalize() + ' Output:Variable data')
elif outputvariable.startswith("WIP"):
if verboseMode:
print('Not added - ' + outputvariable + ' Output:Variable data because its WIP')
else:
building.newidfobject(
'Output:Variable',
Key_Value='*',
Variable_Name=outputvariable,
Reporting_Frequency=freq.capitalize(),
Schedule_Name=''
)
if verboseMode:
print('Added - ' + outputvariable + ' Reporting Frequency ' + freq.capitalize() + ' Output:Variable data')
if other_PMV_related_outputs:
addittionaloutputs = [
# 'Zone Thermostat Operative Temperature',
'Zone Operative Temperature',
'Zone Thermal Comfort Clothing Surface Temperature',
'Zone Thermal Comfort Clothing Value',
'Zone Thermal Comfort Control Fanger High Setpoint PMV',
'Zone Thermal Comfort Control Fanger Low Setpoint PMV',
'Zone Thermal Comfort Fanger Model PMV',
'Zone Thermal Comfort Fanger Model PPD',
'Zone Thermal Comfort Mean Radiant Temperature',
# 'Zone Mean Air Humidity Ratio',
'Zone Air Relative Humidity',
'Zone Mean Air Temperature',
'Cooling Coil Total Cooling Rate',
'Heating Coil Heating Rate',
'Facility Total HVAC Electric Demand Power',
'Facility Total HVAC Electricity Demand Rate',
'AFN Surface Venting Window or Door Opening Factor',
'AFN Zone Infiltration Air Change Rate',
'AFN Zone Infiltration Volume',
'AFN Zone Ventilation Air Change Rate',
'AFN Zone Ventilation Volume',
]
for addittionaloutput in addittionaloutputs:
if addittionaloutput in outputnamelist:
if verboseMode:
print('Not added - ' + addittionaloutput + ' Reporting Frequency ' + freq.capitalize() + ' Output:Variable data')
else:
building.newidfobject(
'Output:Variable',
Key_Value='*',
Variable_Name=addittionaloutput,
Reporting_Frequency=freq.capitalize(),
Schedule_Name=''
)
if verboseMode:
print('Added - ' + addittionaloutput + ' Reporting Frequency ' + freq.capitalize() + ' Output:Variable data')
for i in ['PMV_H_SP', 'PMV_C_SP']:
for zone in zones_with_ppl_underscore:
building.newidfobject(
'Output:Variable',
Key_Value=f'{i}_{zone}',
Variable_Name='Schedule Value',
Reporting_Frequency=freq.capitalize(),
Schedule_Name=''
)
if verboseMode:
print(f'Added - {i}_' + zone + ' Reporting Frequency ' + freq.capitalize() + ' Output:Variable data')
air_velocity_schs = list(set([i.Air_Velocity_Schedule_Name for i in building.idfobjects['people']]))
for i in air_velocity_schs:
if i in outputnamelist:
if verboseMode:
print('Not added - ' + i + ' Reporting Frequency ' + freq.capitalize() + ' Output:Variable data')
else:
building.newidfobject(
'Output:Variable',
Key_Value=i,
Variable_Name='Schedule Value',
Reporting_Frequency=freq.capitalize(),
Schedule_Name=''
)
if verboseMode:
print(f'Added - {i}' + ' Reporting Frequency ' + freq.capitalize() + ' Output:Variable data')
outputcontrolfiles = [i for i in building.idfobjects['OutputControl:Files']]
if len(outputcontrolfiles) == 0:
building.newidfobject(
'OutputControl:Files',
Output_CSV='Yes',
Output_MTR='Yes',
Output_ESO='Yes'
)
if verboseMode:
print(f'Added - OutputControl:Files object')
else:
outputcontrolfiles[0].Output_CSV='Yes'
outputcontrolfiles[0].Output_MTR='Yes'
outputcontrolfiles[0].Output_ESO='Yes'
if verboseMode:
print(f'Not added - OutputControl:Files object - Output CSV, MTR and ESO fields set to Yes')
return building
[docs]
def set_zones_always_occupied(
building,
verboseMode: bool = True
):
"""
This function sets the schedule for zones to always be occupied.
It checks if an "On" schedule is already present in the model; if not, it adds one.
:param building: the building eppy.modeleditor.IDF class instance
:param verboseMode: True to print on screen the actions carried out
"""
sch_comp_objs = [i.Name for i in building.idfobjects['schedule:compact']]
if 'On' in sch_comp_objs:
if verboseMode:
print(f"On Schedule already was in the model")
else:
building.newidfobject(
'Schedule:Compact',
Name='On',
Schedule_Type_Limits_Name="Any Number",
Field_1='Through: 12/31',
Field_2='For: AllDays',
Field_3='Until: 24:00,1'
)
if verboseMode:
print(f"On Schedule has been added")
for i in [j for j in building.idfobjects['people']]:
i.Number_of_People_Schedule_Name = 'On'
return
[docs]
def generate_df_from_args(
building: besos.IDF_class,
adap_coeff_cooling: Union[float, dict] = 0.293,
adap_coeff_heating: Union[float, dict] = -0.293,
pmv_cooling_sp: Union[float, dict] = -0.5,
pmv_heating_sp: Union[float, dict] = 0.5,
tolerance_cooling_sp_cooling_season: Union[float, dict] = -0.1,
tolerance_cooling_sp_heating_season: Union[float, dict] = -0.1,
tolerance_heating_sp_cooling_season: Union[float, dict] = 0.1,
tolerance_heating_sp_heating_season: Union[float, dict] = 0.1,
dflt_for_adap_coeff_cooling: float = 0.4,
dflt_for_adap_coeff_heating: float = -0.4,
dflt_for_pmv_cooling_sp: float = 0.5,
dflt_for_pmv_heating_sp: float = -0.5,
dflt_for_tolerance_cooling_sp_cooling_season: float = -0.1,
dflt_for_tolerance_cooling_sp_heating_season: float = -0.1,
dflt_for_tolerance_heating_sp_cooling_season: float = 0.1,
dflt_for_tolerance_heating_sp_heating_season: float = 0.1,
) -> pandas.DataFrame:
"""
Maps the arguments input by the user in a pandas.DataFrame instance.
If some occupied zones are not defined in the arguments, default values will be applied
to them. In case some zone entered is not among occupied zones in the idf,
it will be omitted.
:param building: The besos.IDF_class. You can make it by using besos.eppy_funcs.get_building
:param adap_coeff_cooling: A dictionary containing all the zone names in the key field,
and the value for the adaptive coefficient (Lambda, λ) at the cooling season, for example:
{'zonename1': 0.1, 'zonename2': 0.5}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param adap_coeff_heating: A dictionary containing all the zone names in the key field,
and the value for the adaptive coefficient (Lambda, λ) at the heating season, for example:
{'zonename1': -0.1, 'zonename2': -0.5}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param pmv_cooling_sp: A dictionary containing all the zone names in the key field,
and the value for the cooling PMV setpoint, for example:
{'zonename1': 0.5, 'zonename2': 0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param pmv_heating_sp: A dictionary containing all the zone names in the key field,
and the value for the heating PMV setpoint, for example:
{'zonename1': -0.5, 'zonename2': -0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param tolerance_cooling_sp_cooling_season: A dictionary containing all the zone names
in the key field, and the value for the cooling PMV setpoint tolerance in cooling season;
this value will be summed to the resulting aPMV setpoint, therefore, in this case should be
a negative number, for example: {'zonename1': -0.1, 'zonename2': -0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param tolerance_cooling_sp_heating_season: A dictionary containing all the zone names
in the key field, and the value for the cooling PMV setpoint tolerance in heating season;
this value will be summed to the resulting aPMV setpoint, therefore, in this case should be
a negative number, for example: {'zonename1': -0.1, 'zonename2': -0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param tolerance_heating_sp_cooling_season: A dictionary containing all the zone names
in the key field, and the value for the heating PMV setpoint tolerance in cooling season;
this value will be summed to the resulting aPMV setpoint, therefore, in this case should be
a positive number, for example: {'zonename1': 0.1, 'zonename2': 0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param tolerance_heating_sp_heating_season: A dictionary containing all the zone names
in the key field, and the value for the heating PMV setpoint tolerance in heating season;
this value will be summed to the resulting aPMV setpoint, therefore, in this case should be
a positive number, for example: {'zonename1': 0.1, 'zonename2': 0.2}.
Float types are also accepted, but these will be applied to all occupied zones in the idf.
:param dflt_for_adap_coeff_cooling: Float default value applied to the
adap_coeff_cooling argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_adap_coeff_heating: Float default value applied to the
adap_coeff_heating argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_pmv_cooling_sp: Float default value applied to the pmv_cooling_sp argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_pmv_heating_sp: Float default value applied to the pmv_heating_sp argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_tolerance_cooling_sp_cooling_season: Float default value applied to the
tolerance_cooling_sp_cooling_season argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_tolerance_cooling_sp_heating_season: Float default value applied to the
tolerance_cooling_sp_heating_season argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_tolerance_heating_sp_cooling_season: Float default value applied to the
tolerance_heating_sp_cooling_season argument,
for those occupied zones not specified in the dictionary keys.
:param dflt_for_tolerance_heating_sp_heating_season: Float default value applied to the
tolerance_heating_sp_heating_season argument,
for those occupied zones not specified in the dictionary keys.
:return: pandas.DataFrame
"""
import pandas as pd
import warnings
try:
ppl_temp = [[people.Zone_or_ZoneList_Name, people.Name] for people in building.idfobjects['People']]
except eppy.bunch_subclass.BadEPFieldError:
print('Zone_or_ZoneList_Name field not found in People object.')
try:
ppl_temp = [[people.Zone_or_ZoneList_or_Space_or_SpaceList_Name, people.Name] for people in building.idfobjects['People']]
except eppy.bunch_subclass.BadEPFieldError:
print('Zone_or_ZoneList_or_Space_or_SpaceList_Name field not found in People object.')
try:
ppl_temp = [[people.Zone_Name, people.Name] for people in building.idfobjects['People']]
except eppy.bunch_subclass.BadEPFieldError:
print('Zone_Name field not found in People object.')
zones_with_ppl_colon = [ppl[0] for ppl in ppl_temp]
data_adap_coeff_cooling = {}
data_adap_coeff_heating = {}
data_pmv_cooling_sp = {}
data_pmv_heating_sp = {}
data_tolerance_cooling_sp_cooling_season = {}
data_tolerance_cooling_sp_heating_season = {}
data_tolerance_heating_sp_cooling_season = {}
data_tolerance_heating_sp_heating_season = {}
for i, j, k, l in [
(adap_coeff_cooling, data_adap_coeff_cooling, 'adap_coeff_cooling', dflt_for_adap_coeff_cooling),
(adap_coeff_heating, data_adap_coeff_heating, 'adap_coeff_heating', dflt_for_adap_coeff_heating),
(pmv_cooling_sp, data_pmv_cooling_sp, 'pmv_cooling_sp', dflt_for_pmv_cooling_sp),
(pmv_heating_sp, data_pmv_heating_sp, 'pmv_heating_sp', dflt_for_pmv_heating_sp),
(tolerance_cooling_sp_cooling_season, data_tolerance_cooling_sp_cooling_season, 'tolerance_cooling_sp_cooling_season', dflt_for_tolerance_cooling_sp_cooling_season),
(tolerance_cooling_sp_heating_season, data_tolerance_cooling_sp_heating_season, 'tolerance_cooling_sp_heating_season', dflt_for_tolerance_cooling_sp_heating_season),
(tolerance_heating_sp_cooling_season, data_tolerance_heating_sp_cooling_season, 'tolerance_heating_sp_cooling_season', dflt_for_tolerance_heating_sp_cooling_season),
(tolerance_heating_sp_heating_season, data_tolerance_heating_sp_heating_season, 'tolerance_heating_sp_heating_season', dflt_for_tolerance_heating_sp_heating_season),
]:
if type(i) is dict:
# setting default value in case the zone is missing
# 1 making lists of the zones entered by the user in the dictionary keys
j.update({'zone list': [x for x in i]})
# 2 making lists for the zones that do not match the existing occupied zones in the idf
j.update({'dropped keys': []})
# 3 iterating through the zones to drop the dictionary entry
# if the zone is not found among idf's occupied zones
for zone in j['zone list']:
if zone not in zones_with_ppl_colon:
i.pop(zone)
j['dropped keys'].append(zone)
# 1.4 warning the user in case some dictionary entry has been dropped
if len(j['dropped keys']) > 0:
warnings.warn(
f'the following zones you entered at the {k} argument were not found, '
f'and therefore have been removed: {j["dropped keys"]}'
)
# 4 making dictionaries to store the zones in which default values have been set
j.update({'default values': {}})
# 5 iterating through occupied zones in the idf which were missing in the dictionary entries
# specified by the user in the arguments
for zone in zones_with_ppl_colon:
if zone not in j['zone list']:
i.update({zone: l})
j['default values'].update({zone: l})
# 6 warning the user in case some default value has been set
if len(j['default values']) > 0:
warnings.warn(
f'the following zones you entered at the {k} argument were not found, '
f'and therefore, considering these are occupied, default values have been set: '
f'{j["default values"]}'
)
# 7 individual pd.Series for each argument
j.update({'series': pd.Series(i, name=k)})
elif type(i) is float or int:
j.update({'series': pd.Series(i, name=k, index=zones_with_ppl_colon)})
# concatenating series into dataframe
df_arguments = pd.concat(
[
data_adap_coeff_cooling['series'],
data_adap_coeff_heating['series'],
data_pmv_cooling_sp['series'],
data_pmv_heating_sp['series'],
data_tolerance_cooling_sp_cooling_season['series'],
data_tolerance_cooling_sp_heating_season['series'],
data_tolerance_heating_sp_cooling_season['series'],
data_tolerance_heating_sp_heating_season['series'],
],
axis=1
)
df_arguments['underscore_zonename'] = [i.replace(':', '_') for i in df_arguments.index]
return df_arguments
[docs]
def change_adaptive_coeff(building, df_arguments):
ppl_temp = [[people.Zone_or_ZoneList_Name, people.Name] for people in building.idfobjects['People']]
zones_with_ppl_colon = [ppl[0] for ppl in ppl_temp]
for i in zones_with_ppl_colon:
zonename = df_arguments.loc[i, 'underscore_zonename']
program = [p
for p
in building.idfobjects['EnergyManagementSystem:Program']
if 'set_zone_input_data' in p.Name
and zonename.lower() in p.Name.lower()
][0]
program.Program_Line_1 = f'set adap_coeff_cooling_{zonename} = {df_arguments.loc[i, "adap_coeff_cooling"]}',
program.Program_Line_2 = f'set adap_coeff_heating_{zonename} = {df_arguments.loc[i, "adap_coeff_heating"]}',
# program.Program_Line_3 = f'set pmv_cooling_sp_{zonename} = {df_arguments.loc[i, "pmv_cooling_sp"]}',
# program.Program_Line_4 = f'set pmv_heating_sp_{zonename} = {df_arguments.loc[i, "pmv_heating_sp"]}',
# program.Program_Line_5 = f'set tolerance_cooling_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_cooling_season"]}',
# program.Program_Line_6 = f'set tolerance_cooling_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_heating_season"]}',
# program.Program_Line_7 = f'set tolerance_heating_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_cooling_season"]}',
# program.Program_Line_8 = f'set tolerance_heating_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_heating_season"]}',
return
[docs]
def change_pmv_setpoints(building, df_arguments):
ppl_temp = [[people.Zone_or_ZoneList_Name, people.Name] for people in building.idfobjects['People']]
zones_with_ppl_colon = [ppl[0] for ppl in ppl_temp]
for i in zones_with_ppl_colon:
zonename = df_arguments.loc[i, 'underscore_zonename']
program = [p
for p
in building.idfobjects['EnergyManagementSystem:Program']
if 'set_zone_input_data' in p.Name
and zonename.lower() in p.Name.lower()
][0]
# program.Program_Line_1 = f'set adap_coeff_cooling_{zonename} = {df_arguments.loc[i, "adap_coeff_cooling"]}',
# program.Program_Line_2 = f'set adap_coeff_heating_{zonename} = {df_arguments.loc[i, "adap_coeff_heating"]}',
program.Program_Line_3 = f'set pmv_cooling_sp_{zonename} = {df_arguments.loc[i, "pmv_cooling_sp"]}',
program.Program_Line_4 = f'set pmv_heating_sp_{zonename} = {df_arguments.loc[i, "pmv_heating_sp"]}',
# program.Program_Line_5 = f'set tolerance_cooling_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_cooling_season"]}',
# program.Program_Line_6 = f'set tolerance_cooling_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_heating_season"]}',
# program.Program_Line_7 = f'set tolerance_heating_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_cooling_season"]}',
# program.Program_Line_8 = f'set tolerance_heating_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_heating_season"]}',
return
[docs]
def change_pmv_heating_setpoint(building, df_arguments):
ppl_temp = [[people.Zone_or_ZoneList_Name, people.Name] for people in building.idfobjects['People']]
zones_with_ppl_colon = [ppl[0] for ppl in ppl_temp]
for i in zones_with_ppl_colon:
zonename = df_arguments.loc[i, 'underscore_zonename']
program = [p
for p
in building.idfobjects['EnergyManagementSystem:Program']
if 'set_zone_input_data' in p.Name
and zonename.lower() in p.Name.lower()
][0]
# program.Program_Line_1 = f'set adap_coeff_cooling_{zonename} = {df_arguments.loc[i, "adap_coeff_cooling"]}',
# program.Program_Line_2 = f'set adap_coeff_heating_{zonename} = {df_arguments.loc[i, "adap_coeff_heating"]}',
# program.Program_Line_3 = f'set pmv_cooling_sp_{zonename} = {df_arguments.loc[i, "pmv_cooling_sp"]}',
program.Program_Line_4 = f'set pmv_heating_sp_{zonename} = {df_arguments.loc[i, "pmv_heating_sp"]}',
# program.Program_Line_5 = f'set tolerance_cooling_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_cooling_season"]}',
# program.Program_Line_6 = f'set tolerance_cooling_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_heating_season"]}',
# program.Program_Line_7 = f'set tolerance_heating_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_cooling_season"]}',
# program.Program_Line_8 = f'set tolerance_heating_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_heating_season"]}',
return
[docs]
def change_pmv_cooling_setpoint(building, df_arguments):
ppl_temp = [[people.Zone_or_ZoneList_Name, people.Name] for people in building.idfobjects['People']]
zones_with_ppl_colon = [ppl[0] for ppl in ppl_temp]
for i in zones_with_ppl_colon:
zonename = df_arguments.loc[i, 'underscore_zonename']
program = [p
for p
in building.idfobjects['EnergyManagementSystem:Program']
if 'set_zone_input_data' in p.Name
and zonename.lower() in p.Name.lower()
][0]
# program.Program_Line_1 = f'set adap_coeff_cooling_{zonename} = {df_arguments.loc[i, "adap_coeff_cooling"]}',
# program.Program_Line_2 = f'set adap_coeff_heating_{zonename} = {df_arguments.loc[i, "adap_coeff_heating"]}',
program.Program_Line_3 = f'set pmv_cooling_sp_{zonename} = {df_arguments.loc[i, "pmv_cooling_sp"]}',
# program.Program_Line_4 = f'set pmv_heating_sp_{zonename} = {df_arguments.loc[i, "pmv_heating_sp"]}',
# program.Program_Line_5 = f'set tolerance_cooling_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_cooling_season"]}',
# program.Program_Line_6 = f'set tolerance_cooling_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_cooling_sp_heating_season"]}',
# program.Program_Line_7 = f'set tolerance_heating_sp_cooling_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_cooling_season"]}',
# program.Program_Line_8 = f'set tolerance_heating_sp_heating_season_{zonename} = {df_arguments.loc[i, "tolerance_heating_sp_heating_season"]}',
return
# class map_idf_objects:
# def __init__(self, building):
# self.peoplelist = ([zone.Name for zone in building.idfobjects['Zone']])
# self.zonelist = ([zone.Name for zone in building.idfobjects['Zone']])
# self.sensorlist = ([sensor.Name for sensor in building.idfobjects['EnergyManagementSystem:Sensor']])
#
# def apply_aPMV_setpoints(
# building,
# outputs_freq: list = ['hourly'],
# other_PMV_related_outputs: bool = True,
# adap_coeff_cooling: float = 0.293,
# adap_coeff_heating: float = -0.293,
# pmv_cooling_sp: float = -0.5,
# pmv_heating_sp: float = 0.5,
# cooling_season_start: any = 120,
# cooling_season_end: any = 210,
# tolerance_heating_sp: float = 0.1,
# tolerance_cooling_sp: float = 0.1,
# dflt_for_adap_coeff_cooling: float = 0.4,
# dflt_for_adap_coeff_heating: float = -0.4,
# dflt_for_pmv_cooling_sp: float = 0.5,
# dflt_for_pmv_heating_sp: float = -0.5,
# dflt_for_tolerance_cooling_sp: float = -0.1,
# dflt_for_tolerance_heating_sp: float = 0.1,
# verboseMode: bool = True,
# ):
# from besos import eppy_funcs as ef
#
# building = ef.get_building(building=building)
#
# add_apmv_ems_code(
# building=building,
# outputs_freq=outputs_freq,
# other_PMV_related_outputs=other_PMV_related_outputs,
# adap_coeff_cooling=adap_coeff_cooling,
# adap_coeff_heating=adap_coeff_heating,
# pmv_cooling_sp=pmv_cooling_sp,
# pmv_heating_sp=pmv_heating_sp,
# tolerance_cooling_sp=tolerance_cooling_sp,
# tolerance_heating_sp=tolerance_heating_sp,
# cooling_season_start=cooling_season_start,
# cooling_season_end=cooling_season_end,
# dflt_for_adap_coeff_cooling=dflt_for_adap_coeff_cooling,
# dflt_for_adap_coeff_heating=dflt_for_adap_coeff_heating,
# dflt_for_pmv_cooling_sp=dflt_for_pmv_cooling_sp,
# dflt_for_pmv_heating_sp=dflt_for_pmv_heating_sp,
# dflt_for_tolerance_cooling_sp=dflt_for_tolerance_cooling_sp,
# dflt_for_tolerance_heating_sp=dflt_for_tolerance_heating_sp,
# verboseMode=verboseMode
# )
# return building
#
#
# class apply_aPMV_setpoints:
# def __init__(
# self,
# idf,
# building,
# outputs_freq: list = ['hourly'],
# other_PMV_related_outputs: bool = True,
# adap_coeff_cooling: float = 0.293,
# adap_coeff_heating: float = -0.293,
# pmv_cooling_sp: float = -0.5,
# pmv_heating_sp: float = 0.5,
# cooling_season_start: any = 120,
# cooling_season_end: any = 210,
# tolerance: float = 0.1,
# dflt_for_adap_coeff_cooling: float = 0.4,
# dflt_for_adap_coeff_heating: float = -0.4,
# dflt_for_pmv_cooling_sp: float = 0.5,
# dflt_for_pmv_heating_sp: float = -0.5,
# verboseMode: bool = True,
#
# ):
# from besos import eppy_funcs as ef
#
# self.building = ef.get_building(building=idf)
#
# add_apmv_ems_code(
# building=building,
# outputs_freq=outputs_freq,
# other_PMV_related_outputs=other_PMV_related_outputs,
# adap_coeff_cooling=adap_coeff_cooling,
# adap_coeff_heating=adap_coeff_heating,
# pmv_cooling_sp=pmv_cooling_sp,
# pmv_heating_sp=pmv_heating_sp,
# cooling_season_start=cooling_season_start,
# cooling_season_end=cooling_season_end,
# tolerance=tolerance,
# dflt_for_adap_coeff_cooling=dflt_for_adap_coeff_cooling,
# dflt_for_adap_coeff_heating=dflt_for_adap_coeff_heating,
# dflt_for_pmv_cooling_sp=dflt_for_pmv_cooling_sp,
# dflt_for_pmv_heating_sp=dflt_for_pmv_heating_sp,
# verboseMode=verboseMode
# )
#
# def add_apmv_ems_code(
# building,
# outputs_freq: list = ['hourly'],
# other_PMV_related_outputs: bool = True,
# adap_coeff_cooling: float = 0.293,
# adap_coeff_heating: float = -0.293,
# pmv_cooling_sp: float = -0.5,
# pmv_heating_sp: float = 0.5,
# cooling_season_start: any = 120,
# cooling_season_end: any = 210,
# tolerance: float = 0.1,
# dflt_for_adap_coeff_cooling: float = 0.4,
# dflt_for_adap_coeff_heating: float = -0.4,
# dflt_for_pmv_cooling_sp: float = 0.5,
# dflt_for_pmv_heating_sp: float = -0.5,
# verboseMode: bool = True,
# ):
# add_apmv_ems_code(
# building=building,
# outputs_freq=outputs_freq,
# other_PMV_related_outputs=other_PMV_related_outputs,
# adap_coeff_cooling=adap_coeff_cooling,
# adap_coeff_heating=adap_coeff_heating,
# pmv_cooling_sp=pmv_cooling_sp,
# pmv_heating_sp=pmv_heating_sp,
# cooling_season_start=cooling_season_start,
# cooling_season_end=cooling_season_end,
# tolerance=tolerance,
# dflt_for_adap_coeff_cooling=dflt_for_adap_coeff_cooling,
# dflt_for_adap_coeff_heating=dflt_for_adap_coeff_heating,
# dflt_for_pmv_cooling_sp=dflt_for_pmv_cooling_sp,
# dflt_for_pmv_heating_sp=dflt_for_pmv_heating_sp,
# verboseMode=verboseMode
# )
[docs]
def add_vrf_system(
building,
SupplyAirTempInputMethod: str = 'supply air temperature',
eer: float = 2,
cop: float = 2.1,
VRFschedule: str = 'On 24/7',
verboseMode: bool = True,
):
import accim.sim.accim_Main_single_idf as accim_Main
EnergyPlus_version = f'{building.idd_version[0]}.{building.idd_version[1]}'
z = accim_Main.accimJob(
idf_class_instance=building,
ScriptType='vrf_ac',
EnergyPlus_version=EnergyPlus_version,
TempCtrl='pmv',
verboseMode=verboseMode
)
z.setComfFieldsPeople(EnergyPlus_version=EnergyPlus_version, TempCtrl='pmv', verboseMode=verboseMode)
z.setPMVsetpoint(verboseMode=verboseMode)
z.addBaseSchedules(verboseMode=verboseMode)
z.setAvailSchOn(verboseMode=verboseMode)
z.addVRFsystemSch(verboseMode=verboseMode)
z.addCurveObj(verboseMode=verboseMode)
z.addDetHVACobj(
EnergyPlus_version=EnergyPlus_version,
verboseMode=verboseMode,
SupplyAirTempInputMethod=SupplyAirTempInputMethod,
eer=eer,
cop=cop,
VRFschedule=VRFschedule
)
# todo calculate number of occupied hours from occupancy schedules