city_retrofit/unittests/test_usage_factory.py

"""
TestUsageFactory test and validate the city model structure usage parameters
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
"""
from pathlib import Path
from unittest import TestCase

from imports.geometry_factory import GeometryFactory
from imports.usage_factory import UsageFactory
from imports.geometry.helpers.geometry_helper import GeometryHelper
from imports.construction_factory import ConstructionFactory


class TestUsageFactory(TestCase):
  """
  TestUsageFactory TestCase
  """
  def setUp(self) -> None:
    """
    Configure test environment
    :return:
    """
    self._example_path = (Path(__file__).parent / 'tests_data').resolve()

  def _get_citygml(self, file):
    file_path = (self._example_path / file).resolve()
    _city = GeometryFactory('citygml', file_path).city
    self.assertIsNotNone(_city, 'city is none')
    return _city

  def test_city_with_usage(self):
    """
    Enrich the city with the usage information and verify it
    :return: None
    """
    # case 1: HFT
    file = 'pluto_building.gml'
    city = self._get_citygml(file)
    for building in city.buildings:
      building.function = GeometryHelper.pluto_to_function[building.function]
    ConstructionFactory('nrel', city).enrich()
    UsageFactory('hft', city).enrich()
    for building in city.buildings:
      self.assertIsNot(len(building.usage_zones), 0, 'no building usage_zones defined')
      for usage_zone in building.usage_zones:
        self.assertIsNotNone(usage_zone.usage, 'usage is none')
        self.assertIsNotNone(usage_zone.internal_gains, 'usage is none')
        self.assertIsNotNone(usage_zone.cooling_setpoint, 'usage is none')
        self.assertIsNotNone(usage_zone.heating_setback, 'usage is none')
        self.assertIsNotNone(usage_zone.heating_setpoint, 'usage is none')
        self.assertIsNotNone(usage_zone.occupancy_density, 'usage is none')
        self.assertIsNotNone(usage_zone.hours_day, 'usage is none')
        self.assertIsNotNone(usage_zone.days_year, 'usage is none')
        self.assertIsNotNone(usage_zone.dhw_average_volume_pers_day, 'usage is none')
        self.assertIsNotNone(usage_zone.dhw_preparation_temperature, 'usage is none')
        self.assertIsNotNone(usage_zone.electrical_app_average_consumption_sqm_year, 'usage is none')
        self.assertIsNotNone(usage_zone.is_heated, 'thermal_zone heated is none')
        self.assertIsNotNone(usage_zone.is_cooled, 'thermal_zone cooled is none')


    # case 2: CA
    file = 'one_building_in_kelowna.gml'
    city = self._get_citygml(file)
    ConstructionFactory('nrel', city).enrich()
    UsageFactory('ca', city).enrich()
    for building in city.buildings:
      self.assertIsNot(len(building.usage_zones), 0, 'no building usage_zones defined')
      for usage_zone in building.usage_zones:
        self.assertIsNotNone(usage_zone.usage, 'usage is none')
        self.assertIsNotNone(usage_zone.internal_gains, 'usage is none')
        self.assertIsNotNone(usage_zone.cooling_setpoint, 'usage is none')
        self.assertIsNotNone(usage_zone.heating_setback, 'usage is none')
        self.assertIsNotNone(usage_zone.heating_setpoint, 'usage is none')
        self.assertIsNotNone(usage_zone.occupancy_density, 'usage is none')
        self.assertIsNotNone(usage_zone.hours_day, 'usage is none')
        self.assertIsNotNone(usage_zone.days_year, 'usage is none')