energy_system_modelling_workflow/helpers/idf_helper.py

"""
TestOccupancyFactory test and validate the city model structure occupancy parameters
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Soroush Samareh Abolhassani - soroush.samarehabolhassani@mail.concordia.ca
"""
from geomeppy import IDF
import esoreader
from pathlib import Path


class IdfHelper:
  idf_surfaces = {
    'Wall': 'wall',
    'Ground': 'floor',
    'Roof': 'roof'
  }

  def __init__(self, idf_file_path, idd_file_path, epw_file_path, eso_file_path):
    self._idd_file_path = str(idd_file_path)
    self._idf_file_path = str(idf_file_path)
    self._epw_file_path = str(epw_file_path)
    self._eso_file_path = str(eso_file_path)
    IDF.setiddname(self._idd_file_path)
    self._idf = IDF(self._idf_file_path)
    self._idf.epw = self._epw_file_path
    self._eso_file_path = str((Path.cwd() / 'eplusout.eso').resolve())

  def add_zone(self, building_name):

    self._idf.newidfobject(key='ZONE', Name=building_name, Ceiling_Height='autocalculate', Volume='autocalculate',
                           Floor_Area='autocalculate', Part_of_Total_Floor_Area='yes', )
    self._idf.newidfobject("HVACTEMPLATE:ZONE:IDEALLOADSAIRSYSTEM", Zone_Name=building_name,
                           Template_Thermostat_Name='', Outdoor_Air_Method="DetailedSpecification", )

  def add_heating_system(self):
    self._idf.intersect_match()
    self._idf.set_default_constructions()
    stat = self._idf.newidfobject(
      "HVACTEMPLATE:THERMOSTAT",
      Name="Zone Stat",
      Constant_Heating_Setpoint=20,
      Constant_Cooling_Setpoint=25,
    )
    for zone in self._idf.idfobjects["ZONE"]:
      self._idf.newidfobject("HVACTEMPLATE:ZONE:IDEALLOADSAIRSYSTEM",
                             Zone_Name=zone.Name,
                             Template_Thermostat_Name=stat.Name
                             )

  @staticmethod
  def _matrix_to_list(points):
    points_list = []
    for point in points:
      point_tuple = (point[0], point[1], point[2])
      points_list.append(point_tuple)
    print(points_list)
    return points_list

  @staticmethod
  def _matrix_to_2d_list(points):
    points_list = []
    for point in points:
      point_tuple = (point[0], point[1])
      points_list.append(point_tuple)
    points_list.reverse()
    return points_list

  def add_block(self, building):
    _points = IdfHelper._matrix_to_2d_list(building.foot_print.points)
    self._idf.add_block(name=building.name, coordinates=_points,
                        height=building.max_height, num_stories=building.storeys_above_ground)

  def add_surfaces(self, building):
    for surface in building.surfaces:
      wall = self._idf.newidfobject('BUILDINGSURFACE:DETAILED', Name=surface.name,
                                    Surface_Type=self.idf_surfaces[surface.type], Zone_Name=building.name)
      wall.setcoords(IdfHelper._matrix_to_list(surface.ground_points))

  def run(self, window_ratio=0.35, display_render=False):

    self._idf.set_wwr(window_ratio)
    # self._idf.translate_to_origin()

    if display_render:
      self._idf.view_model()
    else:
      self._idf.to_obj('city.obj')
    # Run
    self._idf.newidfobject("OUTPUT:METER", Key_Name="Heating:DistrictHeating", Reporting_Frequency="hourly", )
    self._idf.newidfobject("OUTPUT:METER", Key_Name="Cooling:DistrictCooling", Reporting_Frequency="hourly", )
    self._idf.run()
    """
    dd, data = esoreader.read(self._eso_file_path)
    list_values = [v for v in data.values()]
    heating = [(float(x)) / 3600000.0 for x in list_values[0]]
    cooling = [(float(x)) / 3600000.0 for x in list_values[1]]
    print("text")
    return heating, cooling
    """