feat(components): Support Merging Thermal Bridges

- Support Merging Thermal Bridges
- Black formatting all

Author: ed-p-may

PHX/from_HBJSON/cleanup.py

@@ -58,6 +58,7 @@
 
 logger = logging.getLogger()
 
+
 def _dup_face(_hb_face: face.Face) -> face.Face:
     """Duplicate a Honeybee Face and all it's properties.
 
@@ -376,17 +377,17 @@ def merge_foundations(_hb_rooms: List[room.Room]) -> Dict[str, PhFoundation]:
     # -- Group by Identifier
     foundation_groups = {}
     for rm in _hb_rooms:
-        foundations = rm.properties.ph.ph_foundations # type: ignore
+        foundations = rm.properties.ph.ph_foundations  # type: ignore
         for foundation in foundations:
             foundation_groups[foundation.identifier] = foundation
 
     # -- Warn if more than 3 of them
     if len(foundation_groups) > 3:
-        name = _hb_rooms[0].properties.ph.ph_bldg_segment.display_name # type: ignore
+        name = _hb_rooms[0].properties.ph.ph_bldg_segment.display_name  # type: ignore
         msg = (
             f"\tWarning: WUFI-Passive only allows 3 Foundation types. "
             f" {len(foundation_groups)} found on the Building Segment '"
-            f"{name}'?" 
+            f"{name}'?"
         )
         print(msg)
 
@@ -429,11 +430,15 @@ def merge_rooms(
     # -- Try and merge the Faces to simplify the geometry
     if _merge_faces:
         logger.debug(f"Merging Faces with tolerance: {_tolerance}")
-        face_groups = face_tools.group_hb_faces(exposed_faces, _tolerance, _angle_tolerance_degrees)
+        face_groups = face_tools.group_hb_faces(
+            exposed_faces, _tolerance, _angle_tolerance_degrees
+        )
         merged_faces = []
         for face_group in face_groups:
             const_name = face_group[0].properties.energy.construction.display_name
-            logger.debug(f"Merging {len(face_group)} Faces with Construction: {const_name}")
+            logger.debug(
+                f"Merging {len(face_group)} Faces with Construction: {const_name}"
+            )
             merged_faces.extend(
                 merge_hb_faces(face_group, _tolerance, _angle_tolerance_degrees)
             )

PHX/from_HBJSON/cleanup_merge_faces.py

@@ -142,10 +142,10 @@ def merge_hb_faces(
     _faces: List[Face], _tolerance: float, _angle_tolerance_degrees: float
 ) -> List[Face]:
     """Merge a group of HB-Faces into the fewest number of faces possible."""
-    
+
     if not _faces:
         logger.debug("No faces in group. Skipping merge.")
-        return [] 
+        return []
 
     if len(_faces) == 1:
         logger.debug(f"Single face: {_faces[0].display_name} in group. Skipping merge.")
@@ -159,7 +159,9 @@ def merge_hb_faces(
 
     # -------------------------------------------------------------------------
     # -- Merge the HB-Faces' Polygons together
-    merged_polygon2Ds = polygon2d_tools.merge_lbt_face_polygons(face3Ds(_faces), _tolerance)
+    merged_polygon2Ds = polygon2d_tools.merge_lbt_face_polygons(
+        face3Ds(_faces), _tolerance
+    )
 
     # -------------------------------------------------------------------------
     # -- Create new LBT-Face3D, and HB-Faces from the Polygon2Ds
@@ -214,7 +216,9 @@ def merge_hb_shades(
 
     # -------------------------------------------------------------------------
     # -- Merge the HB-Face's Polygons together
-    merged_polygon2Ds = polygon2d_tools.merge_lbt_face_polygons(face3Ds(_faces), _tolerance)
+    merged_polygon2Ds = polygon2d_tools.merge_lbt_face_polygons(
+        face3Ds(_faces), _tolerance
+    )
 
     # -------------------------------------------------------------------------
     # -- Create new LBT-Face3D, and HB-Faces from the Polygon2Ds

PHX/from_HBJSON/create_assemblies.py

@@ -38,7 +38,9 @@ def _conductivity_from_r_value(_r_value: float, _thickness: float) -> float:
     return conductivity
 
 
-def create_phx_color_from_hbph_color(_hbph_color: Optional[color.PhColor]) -> constructions.PhxColor:
+def create_phx_color_from_hbph_color(
+    _hbph_color: Optional[color.PhColor],
+) -> constructions.PhxColor:
     """Create a new PHX-Color from a Honeybee-PH-Utils PhColor.
 
     Arguments:
@@ -57,6 +59,7 @@ def create_phx_color_from_hbph_color(_hbph_color: Optional[color.PhColor]) -> co
         new_color.blue = int(_hbph_color.b)
     return new_color
 
+
 def build_phx_material_from_hb_EnergyMaterial(
     _hb_material: EnergyMaterial,
 ) -> constructions.PhxMaterial:
@@ -78,9 +81,11 @@ def build_phx_material_from_hb_EnergyMaterial(
     new_mat.density = _hb_material.density
     new_mat.heat_capacity = _hb_material.specific_heat
 
-    _prop_ph = _hb_material.properties.ph # type: EnergyMaterialPhProperties # type: ignore
-    new_mat.percentage_of_assembly = _prop_ph.percentage_of_assembly  
-    
+    _prop_ph = (
+        _hb_material.properties.ph
+    )  # type: EnergyMaterialPhProperties # type: ignore
+    new_mat.percentage_of_assembly = _prop_ph.percentage_of_assembly
+
     try:
         hbph_color = _prop_ph.ph_color
     except AttributeError:
@@ -117,7 +122,9 @@ def build_phx_material_from_hb_EnergyMaterialNoMass(
     new_mat.density = _hb_material.mass_area_density
     new_mat.heat_capacity = _hb_material.area_heat_capacity
 
-    _prop_ph = _hb_material.properties.ph # type: EnergyMaterialPhProperties # type: ignore
+    _prop_ph = (
+        _hb_material.properties.ph
+    )  # type: EnergyMaterialPhProperties # type: ignore
     try:
         hbph_color = _prop_ph.ph_color
     except AttributeError:

PHX/from_HBJSON/create_elec_equip.py

@@ -59,7 +59,7 @@ def build_phx_elec_device(
             try:
                 setattr(phx_device, attr_name, getattr(_hbph_device, attr_name))
             except KeyError:
-                raise 
+                raise
             except Exception as e:
                 msg = f"\n\tError setting attribute '{attr_name}' on '{phx_device.__class__.__name__}'?"
                 raise Exception(msg)

PHX/from_HBJSON/create_foundations.py

@@ -9,13 +9,16 @@
 from PHX.model.enums.foundations import FoundationType
 from PHX.model import ground
 
-def create_phx_foundation_from_hbph(_hbph_foundation: PhFoundation) -> ground.PhxFoundation:
+
+def create_phx_foundation_from_hbph(
+    _hbph_foundation: PhFoundation,
+) -> ground.PhxFoundation:
     """Return a new PhxFoundation object with attributes based on a source HBPH-Foundation.
-    
+
     Arguments:
     ----------
         *
-    
+
     Returns:
     --------
         * (PhxFoundation)
@@ -30,8 +33,9 @@ def create_phx_foundation_from_hbph(_hbph_foundation: PhFoundation) -> ground.Ph
     }
     new_phx_foundation = phx_foundation_type_map[_hbph_foundation.__class__.__name__]()
     new_phx_foundation.display_name = _hbph_foundation.display_name
-    new_phx_foundation.foundation_type_num = FoundationType(_hbph_foundation.foundation_type.number)
-
+    new_phx_foundation.foundation_type_num = FoundationType(
+        _hbph_foundation.foundation_type.number
+    )
 
     # -- Pull out all the PH attributes and set the PHX ones to match.
     for attr_name in vars(_hbph_foundation).keys():
@@ -40,13 +44,17 @@ def create_phx_foundation_from_hbph(_hbph_foundation: PhFoundation) -> ground.Ph
 
         try:
             # try and set any Enums by number first...
-            setattr(new_phx_foundation, attr_name, getattr(_hbph_foundation, attr_name).number)
+            setattr(
+                new_phx_foundation, attr_name, getattr(_hbph_foundation, attr_name).number
+            )
         except AttributeError:
             # ... then just set copy over any non-Enum values
             try:
-                setattr(new_phx_foundation, attr_name, getattr(_hbph_foundation, attr_name))
+                setattr(
+                    new_phx_foundation, attr_name, getattr(_hbph_foundation, attr_name)
+                )
             except KeyError:
-                raise 
+                raise
             except Exception as e:
                 msg = f"\n\tError setting attribute '{attr_name}' on '{new_phx_foundation.__class__.__name__}'?"
                 raise Exception(msg)

PHX/from_HBJSON/create_hvac.py

@@ -305,7 +305,9 @@ def build_phx_heating_device(_htg_sys: heating.PhHeatingSystem) -> hvac.PhxHeati
     """Returns a new PHX-Heating-Device based on an input Honeybee-PH Heating System."""
 
     # -- Mapping Honeybee-PH -> PHX types
-    phx_heater_classes: Dict[str, Callable[[heating.PhHeatingSystem], hvac.PhxHeatingDevice]] = {
+    phx_heater_classes: Dict[
+        str, Callable[[heating.PhHeatingSystem], hvac.PhxHeatingDevice]
+    ] = {
         "PhHeatingDirectElectric": build_phx_heating_electric,
         "PhHeatingFossilBoiler": build_phx_heating_fossil_boiler,
         "PhHeatingWoodBoiler": build_phx_heating_wood_boiler,
@@ -330,6 +332,7 @@ def build_phx_heating_sys(_htg_sys: heating.PhHeatingSystem) -> hvac.PhxHeatingD
 # -----------------------------------------------------------------------------
 # -- Heat Pumps
 
+
 def hbph_heat_pump_has_cooling(_hbph_heat_pump: heat_pumps.PhHeatPumpSystem) -> bool:
     """Return True if the input Honeybee-PH Heat-Pump System has any type of cooling enabled."""
     return any(
@@ -342,16 +345,26 @@ def hbph_heat_pump_has_cooling(_hbph_heat_pump: heat_pumps.PhHeatPumpSystem) ->
     )
 
 
-def build_phx_heat_pump_cooling_params(_hbph_heat_pump: heat_pumps.PhHeatPumpSystem) -> hvac.PhxCoolingParams:
+def build_phx_heat_pump_cooling_params(
+    _hbph_heat_pump: heat_pumps.PhHeatPumpSystem,
+) -> hvac.PhxCoolingParams:
     """Return a new PHX Cooling Params object based on an input Honeybee-PH Heat-Pump System."""
-    
+
     new_params_obj = hvac.PhxCoolingParams()
 
-    new_params_obj.ventilation = build_phx_cooling_ventilation_params(_hbph_heat_pump.cooling_params.ventilation)
-    new_params_obj.recirculation = build_phx_cooling_recirculation_params(_hbph_heat_pump.cooling_params.recirculation)
-    new_params_obj.dehumidification = build_phx_cooling_dehumidification_params(_hbph_heat_pump.cooling_params.dehumidification)
-    new_params_obj.panel = build_phx_cooling_panel_params(_hbph_heat_pump.cooling_params.panel)
-    
+    new_params_obj.ventilation = build_phx_cooling_ventilation_params(
+        _hbph_heat_pump.cooling_params.ventilation
+    )
+    new_params_obj.recirculation = build_phx_cooling_recirculation_params(
+        _hbph_heat_pump.cooling_params.recirculation
+    )
+    new_params_obj.dehumidification = build_phx_cooling_dehumidification_params(
+        _hbph_heat_pump.cooling_params.dehumidification
+    )
+    new_params_obj.panel = build_phx_cooling_panel_params(
+        _hbph_heat_pump.cooling_params.panel
+    )
+
     return new_params_obj
 
 
@@ -363,62 +376,76 @@ def build_phx_heating_hp_annual(
     phx_obj = hvac.PhxHeatPumpAnnual()
     phx_obj = _transfer_attributes(_hbph_heat_pump, phx_obj)
     phx_obj.usage_profile.space_heating_percent = _hbph_heat_pump.percent_coverage
-    
+
     if hbph_heat_pump_has_cooling(_hbph_heat_pump):
-        phx_obj.usage_profile.cooling_percent = _hbph_heat_pump.cooling_params.percent_coverage
+        phx_obj.usage_profile.cooling_percent = (
+            _hbph_heat_pump.cooling_params.percent_coverage
+        )
         phx_obj.params_cooling = build_phx_heat_pump_cooling_params(_hbph_heat_pump)
-    
+
     return phx_obj
 
 
 def build_phx_heating_hp_monthly(
     _hbph_heat_pump: heat_pumps.PhHeatPumpSystem,
 ) -> hvac.PhxHeatPumpMonthly:
     """Returns a new Monthly PHX-Heat-Pump-Device based on an input Honeybee-PH Heat-Pump System."""
-    
+
     phx_obj = hvac.PhxHeatPumpMonthly()
     phx_obj = _transfer_attributes(_hbph_heat_pump, phx_obj)
     phx_obj.usage_profile.space_heating_percent = _hbph_heat_pump.percent_coverage
-    
+
     if hbph_heat_pump_has_cooling(_hbph_heat_pump):
-        phx_obj.usage_profile.cooling_percent = _hbph_heat_pump.cooling_params.percent_coverage
+        phx_obj.usage_profile.cooling_percent = (
+            _hbph_heat_pump.cooling_params.percent_coverage
+        )
         phx_obj.params_cooling = build_phx_heat_pump_cooling_params(_hbph_heat_pump)
-    
+
     return phx_obj
 
 
 def build_phx_heating_hp_combined(
     _hbph_heat_pump: heat_pumps.PhHeatPumpSystem,
 ) -> hvac.PhxHeatPumpCombined:
     """Returns a new Combined PHX-Heat-Pump-Device based on an input Honeybee-PH Heat-Pump System."""
-    
+
     phx_obj = hvac.PhxHeatPumpCombined()
     phx_obj = _transfer_attributes(_hbph_heat_pump, phx_obj)
     phx_obj.usage_profile.space_heating_percent = _hbph_heat_pump.percent_coverage
-    
+
     if hbph_heat_pump_has_cooling(_hbph_heat_pump):
-        phx_obj.usage_profile.cooling_percent = _hbph_heat_pump.cooling_params.percent_coverage
+        phx_obj.usage_profile.cooling_percent = (
+            _hbph_heat_pump.cooling_params.percent_coverage
+        )
         phx_obj.params_cooling = build_phx_heat_pump_cooling_params(_hbph_heat_pump)
-    
+
     return phx_obj
 
 
-def build_phx_heat_pump_device(_hbph_heat_pump: heat_pumps.PhHeatPumpSystem) -> hvac.PhxHeatPumpDevice:
+def build_phx_heat_pump_device(
+    _hbph_heat_pump: heat_pumps.PhHeatPumpSystem,
+) -> hvac.PhxHeatPumpDevice:
     """Returns a new PHX-He"at-Pump-Device based on an input Honeybee-PH Heat-Pump System."""
 
     # -- Mapping Honeybee-PH -> PHX types
-    phx_heat_pump_classes: Dict[str, Callable[[heat_pumps.PhHeatPumpSystem], hvac.PhxHeatPumpDevice]] = {
+    phx_heat_pump_classes: Dict[
+        str, Callable[[heat_pumps.PhHeatPumpSystem], hvac.PhxHeatPumpDevice]
+    ] = {
         "PhHeatPumpAnnual": build_phx_heating_hp_annual,
         "PhHeatPumpRatedMonthly": build_phx_heating_hp_monthly,
         "PhHeatPumpCombined": build_phx_heating_hp_combined,
     }
 
     # -- Get and build the right heater equipment type
-    phx_heat_pump = phx_heat_pump_classes[_hbph_heat_pump.heat_pump_class_name](_hbph_heat_pump)
+    phx_heat_pump = phx_heat_pump_classes[_hbph_heat_pump.heat_pump_class_name](
+        _hbph_heat_pump
+    )
     return phx_heat_pump
 
 
-def build_phx_heat_pump_sys(_hbph_heat_pump: heat_pumps.PhHeatPumpSystem) -> hvac.PhxHeatPumpDevice:
+def build_phx_heat_pump_sys(
+    _hbph_heat_pump: heat_pumps.PhHeatPumpSystem,
+) -> hvac.PhxHeatPumpDevice:
     """Build a new PHX-Heat-Pump-Device Device from a Honeybee-PH Heat-Pump System."""
 
     phx_htg_device = build_phx_heat_pump_device(_hbph_heat_pump)
@@ -428,7 +455,6 @@ def build_phx_heat_pump_sys(_hbph_heat_pump: heat_pumps.PhHeatPumpSystem) -> hva
     return phx_htg_device
 
 
-
 # -----------------------------------------------------------------------------
 # --- Cooling Parameters for Heat Pumps
 
@@ -453,7 +479,7 @@ def build_phx_cooling_ventilation_params(
     _hbph_cooling_params: heat_pumps.PhHeatPumpCoolingParams_Ventilation,
 ) -> hvac.PhxCoolingVentilationParams:
     """Build a new PHX Cooling Ventilation Params object from a Honeybee-PH Cooling Ventilation Params object."""
-    
+
     phx_obj = hvac.PhxCoolingVentilationParams()
     phx_obj = _transfer_cooling_attributes(_hbph_cooling_params, phx_obj)
     return phx_obj
@@ -463,7 +489,7 @@ def build_phx_cooling_recirculation_params(
     _hbph_cooling_params: heat_pumps.PhHeatPumpCoolingParams_Recirculation,
 ) -> hvac.PhxCoolingRecirculationParams:
     """Build a new PHX-Cooling-Recirculation-Params object from a Honeybee-PH Cooling-Params object."""
-    
+
     phx_obj = hvac.PhxCoolingRecirculationParams()
     phx_obj = _transfer_cooling_attributes(_hbph_cooling_params, phx_obj)
     return phx_obj
@@ -473,7 +499,7 @@ def build_phx_cooling_dehumidification_params(
     _hbph_cooling_params: heat_pumps.PhHeatPumpCoolingParams_Dehumidification,
 ) -> hvac.PhxCoolingDehumidificationParams:
     """Build a new PHX-Cooling-Dehumidification-Params object from a Honeybee-PH Cooling-Params object."""
-    
+
     phx_obj = hvac.PhxCoolingDehumidificationParams()
     phx_obj = _transfer_cooling_attributes(_hbph_cooling_params, phx_obj)
     return phx_obj
@@ -483,7 +509,7 @@ def build_phx_cooling_panel_params(
     _hbph_cooling_params: heat_pumps.PhHeatPumpCoolingParams_Panel,
 ) -> hvac.PhxCoolingPanelParams:
     """Build a new PHX-Cooling-Panel-Params object from a Honeybee-PH Cooling-Params object."""
-    
+
     phx_obj = hvac.PhxCoolingPanelParams()
     phx_obj = _transfer_cooling_attributes(_hbph_cooling_params, phx_obj)
     return phx_obj