hub/city_model_structure/building_demand/usage_zone.py

"""
UsageZone module
SPDX - License - Identifier: LGPL - 3.0 - or -later
Copyright © 2020 Project Author Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
Contributors Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
"""
import uuid
from typing import List, Union
import helpers.constants as cte
from city_model_structure.building_demand.internal_gains import InternalGains
from city_model_structure.building_demand.occupancy import Occupancy
from city_model_structure.building_demand.lighting import Lighting
from city_model_structure.building_demand.appliances import Appliances


class UsageZone:
  """
  UsageZone class
  """
  def __init__(self):
    self._id = None
    self._usage = None
    self._not_detailed_source_mean_annual_internal_gains = None
    self._hours_day = None
    self._days_year = None
#    self._electrical_app_average_consumption_sqm_year = None
    self._mechanical_air_change = None
    self._occupancy = None
    self._lighting = None
    self._appliances = None
    self._internal_gains = None

  @property
  def id(self):
    """
    Get usage zone id, an universally unique identifier randomly generated
    :return: str
    """
    if self._id is None:
      self._id = uuid.uuid4()
    return self._id

  @property
  def not_detailed_source_mean_annual_internal_gains(self) -> List[InternalGains]:
    """
    Get usage zone internal gains with unknown energy source
    :return: [InternalGains]
    """
    return self._not_detailed_source_mean_annual_internal_gains

  @not_detailed_source_mean_annual_internal_gains.setter
  def not_detailed_source_mean_annual_internal_gains(self, value):
    """
    Set usage zone internal gains with unknown energy source
    :param value: [InternalGains]
    """
    self._not_detailed_source_mean_annual_internal_gains = value

  @property
  def hours_day(self) -> Union[None, float]:
    """
    Get usage zone usage hours per day
    :return: None or float
    """
    return self._hours_day

  @hours_day.setter
  def hours_day(self, value):
    """
    Set usage zone usage hours per day
    :param value: float
    """
    if value is not None:
      self._hours_day = float(value)

  @property
  def days_year(self) -> Union[None, float]:
    """
    Get usage zone usage days per year
    :return: None or float
    """
    return self._days_year

  @days_year.setter
  def days_year(self, value):
    """
    Set usage zone usage days per year
    :param value: float
    """
    if value is not None:
      self._days_year = float(value)

  @property
  def mechanical_air_change(self) -> Union[None, float]:
    """
    Get usage zone mechanical air change in air change per hour (ACH)
    :return: None or float
    """
    return self._mechanical_air_change

  @mechanical_air_change.setter
  def mechanical_air_change(self, value):
    """
    Set usage zone mechanical air change in air change per hour (ACH)
    :param value: float
    """
    if value is not None:
      self._mechanical_air_change = float(value)

  @property
  def usage(self) -> Union[None, str]:
    """
    Get usage zone usage
    :return: None or str
    """
    return self._usage

  @usage.setter
  def usage(self, value):
    """
    Set usage zone usage
    :param value: str
    """
    if value is not None:
      self._usage = str(value)

  @property
  def electrical_app_average_consumption_sqm_year(self) -> Union[None, float]:
    """
    Get average consumption of electrical appliances in Joules hour per square meter and year (J/m2yr)
    :return: None or float
    """
    return self._electrical_app_average_consumption_sqm_year

  @electrical_app_average_consumption_sqm_year.setter
  def electrical_app_average_consumption_sqm_year(self, value):
    """
    Set average consumption of electrical appliances in Joules per square meter and year (J/m2yr)
    :param value: float
    """
    if value is not None:
      self._electrical_app_average_consumption_sqm_year = float(value)

  @property
  def occupancy(self) -> Union[None, Occupancy]:
    """
    Get occupancy in the usage zone
    :return: None or Occupancy
    """
    return self._occupancy

  @occupancy.setter
  def occupancy(self, value):
    """
    Set occupancy in the usage zone
    :param value: Occupancy
    """
    self._occupancy = value

  @property
  def lighting(self) -> Union[None, Lighting]:
    """
    Get lighting information
    :return: None or Lighting
    """
    return self._lighting

  @lighting.setter
  def lighting(self, value):
    """
    Set lighting information
    :param value: Lighting
    """
    self._lighting = value

  @property
  def appliances(self) -> Union[None, Appliances]:
    """
    Get appliances information
    :return: None or Appliances
    """
    return self._appliances

  @appliances.setter
  def appliances(self, value):
    """
    Set appliances information
    :param value: Appliances
    """
    self._appliances = value

  def get_internal_gains(self) -> [InternalGains]:
    """
    Calculates and returns the list of all internal gains defined
    :return: InternalGains
    """
    if self.occupancy is not None:
      if self.occupancy.latent_internal_gain is not None:
        _internal_gain = InternalGains()
        _internal_gain.type = cte.OCCUPANCY
        _total_heat_gain = (self.occupancy.sensible_convective_internal_gain
                            + self.occupancy.sensible_radiant_internal_gain
                            + self.occupancy.latent_internal_gain)
        _internal_gain.average_internal_gain = _total_heat_gain
        _internal_gain.latent_fraction = self.occupancy.latent_internal_gain / _total_heat_gain
        _internal_gain.radiative_fraction = self.occupancy.sensible_radiant_internal_gain / _total_heat_gain
        _internal_gain.convective_fraction = self.occupancy.sensible_convective_internal_gain / _total_heat_gain
        _internal_gain.schedule = self.occupancy.occupancy_schedule
        self._internal_gains = [_internal_gain]
    if self.lighting is not None:
      _internal_gain = InternalGains()
      _internal_gain.type = cte.LIGHTING
      _internal_gain.average_internal_gain = self.lighting.lighting_density
      _internal_gain.latent_fraction = self.lighting.latent_fraction
      _internal_gain.radiative_fraction = self.lighting.radiant_fraction
      _internal_gain.convective_fraction = self.lighting.convective_fraction
      _internal_gain.schedule = self.lighting.schedule
      if self._internal_gains is not None:
        self._internal_gains.append(_internal_gain)
      else:
        self._internal_gains = [_internal_gain]
    if self.appliances is not None:
      _internal_gain = InternalGains()
      _internal_gain.type = cte.APPLIANCES
      _internal_gain.average_internal_gain = self.appliances.lighting_density
      _internal_gain.latent_fraction = self.appliances.latent_fraction
      _internal_gain.radiative_fraction = self.appliances.radiant_fraction
      _internal_gain.convective_fraction = self.appliances.convective_fraction
      _internal_gain.schedule = self.appliances.schedule
      if self._internal_gains is not None:
        self._internal_gains.append(_internal_gain)
      else:
        self._internal_gains = [_internal_gain]
    return self._internal_gains