424 lines
12 KiB
Python
424 lines
12 KiB
Python
"""
|
|
ThermalBoundary module
|
|
SPDX - License - Identifier: LGPL - 3.0 - or -later
|
|
Copyright © 2022 Concordia CERC group
|
|
Project Coder Guille Gutierrez guillermo.gutierrezmorote@concordia.ca
|
|
Code contributors: Pilar Monsalvete Alvarez de Uribarri pilar.monsalvete@concordia.ca
|
|
"""
|
|
import uuid
|
|
from typing import List, Union
|
|
from helpers.configuration_helper import ConfigurationHelper as ch
|
|
from city_model_structure.building_demand.layer import Layer
|
|
from city_model_structure.building_demand.thermal_opening import ThermalOpening
|
|
from city_model_structure.building_demand.thermal_zone import ThermalZone
|
|
from city_model_structure.building_demand.surface import Surface
|
|
|
|
|
|
class ThermalBoundary:
|
|
"""
|
|
ThermalBoundary class
|
|
"""
|
|
def __init__(self, parent_surface, opaque_area, windows_areas):
|
|
self._parent_surface = parent_surface
|
|
self._opaque_area = opaque_area
|
|
self._windows_areas = windows_areas
|
|
self._id = None
|
|
self._thermal_zones = None
|
|
self._thermal_openings = None
|
|
self._layers = None
|
|
self._outside_solar_absorptance = None
|
|
self._outside_thermal_absorptance = None
|
|
self._outside_visible_absorptance = None
|
|
self._u_value = None
|
|
self._shortwave_reflectance = None
|
|
self._construction_name = None
|
|
self._hi = ch().convective_heat_transfer_coefficient_interior
|
|
self._he = ch().convective_heat_transfer_coefficient_exterior
|
|
self._refurbishment_measure = None
|
|
self._thickness = None
|
|
self._virtual_internal_surface = None
|
|
self._inside_emissivity = None
|
|
self._alpha_coefficient = None
|
|
self._radiative_coefficient = None
|
|
self._window_ratio = None
|
|
self._calculated = False
|
|
|
|
@property
|
|
def id(self):
|
|
"""
|
|
Get thermal zone id, an universally unique identifier randomly generated
|
|
:return: str
|
|
"""
|
|
if self._id is None:
|
|
self._id = uuid.uuid4()
|
|
return self._id
|
|
|
|
@property
|
|
def parent_surface(self) -> Surface:
|
|
"""
|
|
Get the surface that belongs to the thermal boundary
|
|
:return: Surface
|
|
"""
|
|
return self._parent_surface
|
|
|
|
@property
|
|
def thermal_zones(self) -> List[ThermalZone]:
|
|
"""
|
|
Get the thermal zones delimited by the thermal boundary
|
|
:return: [ThermalZone]
|
|
"""
|
|
return self._thermal_zones
|
|
|
|
@thermal_zones.setter
|
|
def thermal_zones(self, value):
|
|
"""
|
|
Get the thermal zones delimited by the thermal boundary
|
|
:param value: [ThermalZone]
|
|
"""
|
|
self._thermal_zones = value
|
|
|
|
# todo: do I need these two??
|
|
@property
|
|
def azimuth(self):
|
|
"""
|
|
Get the thermal boundary azimuth in radians
|
|
:return: float
|
|
"""
|
|
return self.parent_surface.azimuth
|
|
|
|
@property
|
|
def inclination(self):
|
|
"""
|
|
Get the thermal boundary inclination in radians
|
|
:return: float
|
|
"""
|
|
return self.parent_surface.inclination
|
|
|
|
@property
|
|
def opaque_area(self):
|
|
"""
|
|
Get the thermal boundary area in square meters
|
|
:return: float
|
|
"""
|
|
return float(self._opaque_area)
|
|
|
|
@property
|
|
def thickness(self):
|
|
"""
|
|
Get the thermal boundary thickness in meters
|
|
:return: float
|
|
"""
|
|
if self._thickness is None:
|
|
self._thickness = 0.0
|
|
if self.layers is not None:
|
|
for layer in self.layers:
|
|
if not layer.material.no_mass:
|
|
self._thickness += layer.thickness
|
|
return self._thickness
|
|
|
|
@property
|
|
def outside_solar_absorptance(self) -> Union[None, float]:
|
|
"""
|
|
Get thermal boundary outside solar absorptance
|
|
:return: None or float
|
|
"""
|
|
return self._outside_solar_absorptance
|
|
|
|
@outside_solar_absorptance.setter
|
|
def outside_solar_absorptance(self, value):
|
|
"""
|
|
Set thermal boundary outside solar absorptance
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._outside_solar_absorptance = float(value)
|
|
self._shortwave_reflectance = 1.0 - float(value)
|
|
|
|
@property
|
|
def outside_thermal_absorptance(self) -> Union[None, float]:
|
|
"""
|
|
Get thermal boundary outside thermal absorptance
|
|
:return: float
|
|
"""
|
|
return self._outside_thermal_absorptance
|
|
|
|
@outside_thermal_absorptance.setter
|
|
def outside_thermal_absorptance(self, value):
|
|
"""
|
|
Set thermal boundary outside thermal absorptance
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._outside_thermal_absorptance = float(value)
|
|
|
|
@property
|
|
def outside_visible_absorptance(self) -> Union[None, float]:
|
|
"""
|
|
Get thermal boundary outside visible absorptance
|
|
:return: None or float
|
|
"""
|
|
return self._outside_visible_absorptance
|
|
|
|
@outside_visible_absorptance.setter
|
|
def outside_visible_absorptance(self, value):
|
|
"""
|
|
Set thermal boundary outside visible absorptance
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._outside_visible_absorptance = float(value)
|
|
|
|
@property
|
|
def thermal_openings(self) -> Union[None, List[ThermalOpening]]:
|
|
"""
|
|
Get thermal boundary thermal openings
|
|
:return: [ThermalOpening]
|
|
"""
|
|
if self._thermal_openings is None:
|
|
if self.window_ratio is not None:
|
|
if self.window_ratio == 0:
|
|
self._thermal_openings = []
|
|
else:
|
|
thermal_opening = ThermalOpening()
|
|
if self.window_ratio == 1:
|
|
_area = self.opaque_area
|
|
else:
|
|
_area = self.opaque_area * self.window_ratio / (1-self.window_ratio)
|
|
thermal_opening.area = _area
|
|
self._thermal_openings = [thermal_opening]
|
|
else:
|
|
if len(self.windows_areas) > 0:
|
|
self._thermal_openings = []
|
|
for window_area in self.windows_areas:
|
|
thermal_opening = ThermalOpening()
|
|
thermal_opening.area = window_area
|
|
self._thermal_openings.append(thermal_opening)
|
|
else:
|
|
self._thermal_openings = []
|
|
return self._thermal_openings
|
|
|
|
@property
|
|
def construction_name(self) -> Union[None, str]:
|
|
"""
|
|
Get construction name
|
|
:return: None or str
|
|
"""
|
|
return self._construction_name
|
|
|
|
@construction_name.setter
|
|
def construction_name(self, value):
|
|
"""
|
|
Set construction name
|
|
:param value: str
|
|
"""
|
|
if value is not None:
|
|
self._construction_name = str(value)
|
|
|
|
@property
|
|
def layers(self) -> List[Layer]:
|
|
"""
|
|
Get thermal boundary layers
|
|
:return: [Layers]
|
|
"""
|
|
return self._layers
|
|
|
|
@layers.setter
|
|
def layers(self, value):
|
|
"""
|
|
Set thermal boundary layers
|
|
:param value: [Layer]
|
|
"""
|
|
self._layers = value
|
|
|
|
@property
|
|
def type(self):
|
|
"""
|
|
Get thermal boundary surface type
|
|
:return: str
|
|
"""
|
|
return self.parent_surface.type
|
|
|
|
@property
|
|
def window_ratio(self) -> Union[None, float]:
|
|
"""
|
|
Get thermal boundary window ratio
|
|
It returns the window ratio calculated as the total windows' areas in a wall divided by
|
|
the total (opaque + transparent) area of that wall if windows are defined in the geometry imported.
|
|
If not, it returns the window ratio imported from an external source (e.g. construction library, manually assigned).
|
|
If none of those sources are available, it returns None.
|
|
:return: float
|
|
"""
|
|
if self.windows_areas is not None:
|
|
if not self._calculated:
|
|
_calculated = True
|
|
if len(self.windows_areas) == 0:
|
|
self._window_ratio = 0
|
|
else:
|
|
total_window_area = 0
|
|
for window_area in self.windows_areas:
|
|
total_window_area += window_area
|
|
self._window_ratio = total_window_area / (self.opaque_area + total_window_area)
|
|
return self._window_ratio
|
|
|
|
@window_ratio.setter
|
|
def window_ratio(self, value):
|
|
"""
|
|
Set thermal boundary window ratio
|
|
:param value: str
|
|
"""
|
|
if self._calculated:
|
|
raise ValueError('Window ratio cannot be assigned when the windows are defined in the geometry.')
|
|
self._window_ratio = float(value)
|
|
|
|
@property
|
|
def windows_areas(self) -> [float]:
|
|
"""
|
|
Get windows areas
|
|
:return: [float]
|
|
"""
|
|
return self._windows_areas
|
|
|
|
@property
|
|
def u_value(self) -> Union[None, float]:
|
|
"""
|
|
Get thermal boundary U-value in W/m2K
|
|
internal and external convective coefficient in W/m2K values, can be configured at configuration.ini
|
|
:return: None or float
|
|
"""
|
|
if self._u_value is None:
|
|
h_i = self.hi
|
|
h_e = self.he
|
|
r_value = 1.0/h_i + 1.0/h_e
|
|
try:
|
|
for layer in self.layers:
|
|
if layer.material.no_mass:
|
|
r_value += float(layer.material.thermal_resistance)
|
|
else:
|
|
r_value = r_value + float(layer.material.conductivity) / float(layer.thickness)
|
|
self._u_value = 1.0/r_value
|
|
except TypeError:
|
|
raise Exception('Constructions layers are not initialized') from TypeError
|
|
return self._u_value
|
|
|
|
@u_value.setter
|
|
def u_value(self, value):
|
|
"""
|
|
Set thermal boundary U-value in W/m2K
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._u_value = float(value)
|
|
|
|
@property
|
|
def shortwave_reflectance(self) -> Union[None, float]:
|
|
"""
|
|
Get thermal boundary shortwave reflectance
|
|
:return: None or float
|
|
"""
|
|
return self._shortwave_reflectance
|
|
|
|
@shortwave_reflectance.setter
|
|
def shortwave_reflectance(self, value):
|
|
"""
|
|
Set thermal boundary shortwave reflectance
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._shortwave_reflectance = float(value)
|
|
self._outside_solar_absorptance = 1.0 - float(value)
|
|
|
|
@property
|
|
def hi(self) -> Union[None, float]:
|
|
"""
|
|
Get internal convective heat transfer coefficient (W/m2K)
|
|
:return: None or float
|
|
"""
|
|
return self._hi
|
|
|
|
@hi.setter
|
|
def hi(self, value):
|
|
"""
|
|
Set internal convective heat transfer coefficient (W/m2K)
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._hi = value
|
|
|
|
@property
|
|
def he(self) -> Union[None, float]:
|
|
"""
|
|
Get external convective heat transfer coefficient (W/m2K)
|
|
:return: None or float
|
|
"""
|
|
return self._he
|
|
|
|
@he.setter
|
|
def he(self, value):
|
|
"""
|
|
Set external convective heat transfer coefficient (W/m2K)
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._he = value
|
|
|
|
@property
|
|
def virtual_internal_surface(self) -> Surface:
|
|
"""
|
|
Get the internal surface of the thermal boundary
|
|
:return: Surface
|
|
"""
|
|
if self._virtual_internal_surface is None:
|
|
self._virtual_internal_surface = self.parent_surface.inverse
|
|
return self._virtual_internal_surface
|
|
|
|
@property
|
|
def inside_emissivity(self) -> Union[None, float]:
|
|
"""
|
|
Get the short wave emissivity factor of the thermal boundary's internal surface (-)
|
|
:return: None or float
|
|
"""
|
|
return self._inside_emissivity
|
|
|
|
@inside_emissivity.setter
|
|
def inside_emissivity(self, value):
|
|
"""
|
|
Set short wave emissivity factor of the thermal boundary's internal surface (-)
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._inside_emissivity = float(value)
|
|
|
|
@property
|
|
def alpha_coefficient(self) -> Union[None, float]:
|
|
"""
|
|
Get the long wave emissivity factor of the thermal boundary's internal surface (-)
|
|
:return: None or float
|
|
"""
|
|
return self._alpha_coefficient
|
|
|
|
@alpha_coefficient.setter
|
|
def alpha_coefficient(self, value):
|
|
"""
|
|
Set long wave emissivity factor of the thermal boundary's internal surface (-)
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._alpha_coefficient = float(value)
|
|
|
|
@property
|
|
def radiative_coefficient(self) -> Union[None, float]:
|
|
"""
|
|
Get the radiative coefficient of the thermal boundary's external surface (-)
|
|
:return: None or float
|
|
"""
|
|
return self._radiative_coefficient
|
|
|
|
@radiative_coefficient.setter
|
|
def radiative_coefficient(self, value):
|
|
"""
|
|
Set radiative coefficient of the thermal boundary's external surface (-)
|
|
:param value: float
|
|
"""
|
|
if value is not None:
|
|
self._radiative_coefficient = float(value)
|