hub/city_model_structure/thermal_zone.py

"""
ThermalZone module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
"""
from typing import List, TypeVar
from city_model_structure.usage_zone import UsageZone
from city_model_structure.surface import Surface
from helpers.configuration_helper import ConfigurationHelper

ThermalBoundary = TypeVar('ThermalBoundary')


class ThermalZone:
  """
  ThermalZone class
  """
  def __init__(self, surfaces):
    self._surfaces = surfaces
    self._floor_area = None
    self._bounded = None
    self._heated = ConfigurationHelper().heated
    self._cooled = ConfigurationHelper().cooled
    self._additional_thermal_bridge_u_value = ConfigurationHelper().additional_thermal_bridge_u_value
    self._effective_thermal_capacity = None
    self._indirectly_heated_area_ratio = ConfigurationHelper().indirectly_heated_area_ratio
    self._infiltration_rate_system_on = ConfigurationHelper().infiltration_rate_system_on
    self._infiltration_rate_system_off = None
    self._usage_zones = None

  @property
  def heated(self):
    """
    Get thermal zone heated flag
    :return: Boolean
    """
    return self._heated

  @property
  def cooled(self):
    """
    Get thermal zone cooled flag
    :return: Boolean
    """
    return self._cooled

  @property
  def floor_area(self):
    """
    Get thermal zone floor area in square meters
    :return: float
    """
    if self._floor_area is None:
      self._floor_area = 0
      for s in self._surfaces:
        if s.type == 'Ground':
          self._floor_area += s.area
    return self._floor_area

  @property
  def bounded(self) -> List[ThermalBoundary]:
    """
    Get thermal boundaries bounding with the thermal zone
    :return: [ThermalBoundary]
    """
    return self._bounded

  @bounded.setter
  def bounded(self, value):
    """
    Set thermal boundaries bounding with the thermal zone
    :param value: [ThermalBoundary]
    :return: None
    """
    self._bounded = value

  @property
  def surfaces(self) -> List[Surface]:
    # todo: This property should be erased
    """
    Get thermal zone surfaces
    :return: [Surface]
    """
    return self._surfaces

  @property
  def additional_thermal_bridge_u_value(self):
    """
    Get thermal zone additional thermal bridge u value W/m2K
    :return: float
    """
    return self._additional_thermal_bridge_u_value

  @additional_thermal_bridge_u_value.setter
  def additional_thermal_bridge_u_value(self, value):
    """
    Set thermal zone additional thermal bridge u value W/m2K
    :param value: float
    :return: None
    """
    self._additional_thermal_bridge_u_value = value

  @property
  def effective_thermal_capacity(self):
    """
    Get thermal zone effective thermal capacity
    :return: float
    """
    return self._effective_thermal_capacity

  @effective_thermal_capacity.setter
  def effective_thermal_capacity(self, value):
    """
    Set thermal zone effective thermal capacity
    :param value: float
    :return: None
    """
    self._effective_thermal_capacity = value

  @property
  def indirectly_heated_area_ratio(self):
    """
    Get thermal zone indirectly heated area ratio
    :return: float
    """
    return self._indirectly_heated_area_ratio

  @indirectly_heated_area_ratio.setter
  def indirectly_heated_area_ratio(self, value):
    """
    Set thermal zone indirectly heated area ratio
    :param value: float
    :return: None
    """
    self._indirectly_heated_area_ratio = value

  @property
  def infiltration_rate_system_on(self):
    """
    Get thermal zone infiltration rate system on in air changes per hour
    :return: float
    """
    return self._infiltration_rate_system_on

  @infiltration_rate_system_on.setter
  def infiltration_rate_system_on(self, value):
    """
    Set thermal zone infiltration rate system on in air changes per hour
    :param value: float
    :return: None
    """
    self._infiltration_rate_system_on = value

  @property
  def infiltration_rate_system_off(self):
    """
    Get thermal zone infiltration rate system off in air changes per hour
    :return: float
    """
    return self._infiltration_rate_system_off

  @infiltration_rate_system_off.setter
  def infiltration_rate_system_off(self, value):
    """
    Set thermal zone infiltration rate system on in air changes per hour
    :param value: float
    :return: None
    """
    self._infiltration_rate_system_off = value

  @property
  def usage_zones(self) -> List[UsageZone]:
    """
    Get thermal zone usage zones
    :return: [UsageZone]
    """
    return self._usage_zones

  @usage_zones.setter
  def usage_zones(self, values):
    """
    Set thermal zone usage zones
    :param values: [UsageZone]
    :return: None
    """
    self._usage_zones = values