ifctrano 0.1.8__py3-none-any.whl → 0.1.9__py3-none-any.whl

ifctrano/base.py

@@ -3,12 +3,15 @@ from typing import Tuple, Literal, List, Annotated, Sequence
 import ifcopenshell.geom
 import numpy as np
 from numpy import ndarray
-from pydantic import BaseModel, BeforeValidator, ConfigDict
+from pydantic import BaseModel, BeforeValidator, ConfigDict, model_validator
+
+from ifctrano.exceptions import VectorWithNansError
 
 settings = ifcopenshell.geom.settings()  # type: ignore
 Coordinate = Literal["x", "y", "z"]
 AREA_TOLERANCE = 0.5
 ROUNDING_FACTOR = 5
+CLASH_CLEARANCE = 0.5
 
 
 class BaseModelConfig(BaseModel):
@@ -61,6 +64,13 @@ class Sign(BaseModel):
 
 
 class Vector(BasePoint):
+
+    @model_validator(mode="after")
+    def _validator(self) -> "Vector":
+        if any(np.isnan(v) for v in self.to_list()):
+            raise VectorWithNansError("Vector cannot have NaN values")
+        return self
+
     def __mul__(self, other: "Vector") -> "Vector":
 
         array = np.cross(self.to_array(), other.to_array())
@@ -69,6 +79,15 @@ class Vector(BasePoint):
     def dot(self, other: "Vector") -> float:
         return np.dot(self.to_array(), other.to_array())  # type: ignore
 
+    def angle(self, other: "Vector") -> int:
+        dot_product = np.dot(self.to_xy(), other.to_xy())
+        cross_product = np.cross(self.to_xy(), other.to_xy())
+        angle_rad = np.arctan2(cross_product, dot_product)
+        angle_deg = np.degrees(angle_rad)
+        if angle_deg < 0:
+            angle_deg += 360
+        return int(angle_deg)
+
     def project(self, other: "Vector") -> "Vector":
         a = self.dot(other) / other.dot(other)
         return Vector(x=a * other.x, y=a * other.y, z=a * other.z)
@@ -82,6 +101,9 @@ class Vector(BasePoint):
     def to_array(self) -> np.ndarray:  # type: ignore
         return np.array([self.x, self.y, self.z])
 
+    def to_xy(self) -> np.ndarray:  # type: ignore
+        return np.array([self.x, self.y])
+
     def get_normal_index(self) -> int:
         normal_index_list = [abs(v) for v in self.to_list()]
         return normal_index_list.index(max(normal_index_list))

ifctrano/bounding_box.py

@@ -25,7 +25,7 @@ from ifctrano.base import (
     AREA_TOLERANCE,
     ROUNDING_FACTOR,
 )
-from ifctrano.exceptions import BoundingBoxFaceError
+from ifctrano.exceptions import BoundingBoxFaceError, VectorWithNansError
 
 logger = getLogger(__name__)
 
@@ -175,7 +175,14 @@ class OrientedBoundingBox(BaseModel):
                         distance = abs(polygon_1.length - polygon_2.length)
                         area = intersection.area
                         direction_vector = (other.centroid - self.centroid).norm()
-                        orientation = direction_vector.project(face.normal).norm()
+                        try:
+                            orientation = direction_vector.project(face.normal).norm()
+                        except VectorWithNansError as e:
+                            logger.error(
+                                "Orientation vector was not properly computed when computing the intersection between"
+                                f"two elements. Error: {e}"
+                            )
+                            continue
                         extend_surfaces.append(
                             ExtendCommonSurface(
                                 distance=distance, area=area, orientation=orientation

ifctrano/building.py

@@ -1,16 +1,17 @@
+import re
 from pathlib import Path
-from typing import List
+from typing import List, Tuple, Any, Optional
 
 import ifcopenshell
 from ifcopenshell import file, entity_instance
-from pydantic import validate_call, Field, model_validator
+from pydantic import validate_call, Field, model_validator, field_validator
 from trano.elements import InternalElement  # type: ignore
 from trano.elements.library.library import Library  # type: ignore
 from trano.elements.types import Tilt  # type: ignore
 from trano.topology import Network  # type: ignore
 
-from ifctrano.base import BaseModelConfig, Libraries
-from ifctrano.exceptions import IfcFileNotFoundError
+from ifctrano.base import BaseModelConfig, Libraries, Vector
+from ifctrano.exceptions import IfcFileNotFoundError, NoIfcSpaceFoundError
 from ifctrano.space_boundary import (
     SpaceBoundaries,
     initialize_tree,
@@ -28,6 +29,26 @@ class IfcInternalElement(BaseModelConfig):
     element: entity_instance
     area: float
 
+    def __hash__(self) -> int:
+        return hash(
+            (
+                *sorted([space.global_id for space in self.spaces]),
+                self.element.GlobalId,
+                self.area,
+            )
+        )
+
+    def __eq__(self, other: "IfcInternalElement") -> bool:  # type: ignore
+        return hash(self) == hash(other)
+
+    def description(self) -> Tuple[Any, Any, str, float]:
+        return (
+            *sorted([space.global_id for space in self.spaces]),
+            self.element.GlobalId,
+            self.element.is_a(),
+            self.area,
+        )
+
 
 class InternalElements(BaseModelConfig):
     elements: List[IfcInternalElement] = Field(default_factory=list)
@@ -35,6 +56,9 @@ class InternalElements(BaseModelConfig):
     def internal_element_ids(self) -> List[str]:
         return list({e.element.GlobalId for e in self.elements})
 
+    def description(self) -> List[Tuple[Any, Any, str, float]]:
+        return sorted([element.description() for element in self.elements])
+
 
 class Building(BaseModelConfig):
     name: str
@@ -43,8 +67,18 @@ class Building(BaseModelConfig):
     parent_folder: Path
     internal_elements: InternalElements = Field(default_factory=InternalElements)
 
+    @field_validator("name")
+    @classmethod
+    def _name_validator(cls, name: str) -> str:
+        name = name.replace(" ", "_")
+        name = re.sub(r"[^a-zA-Z0-9_]", "", name)
+        return name.lower()
+
     @classmethod
-    def from_ifc(cls, ifc_file_path: Path) -> "Building":
+    def from_ifc(
+        cls, ifc_file_path: Path, selected_spaces_global_id: Optional[List[str]] = None
+    ) -> "Building":
+        selected_spaces_global_id = selected_spaces_global_id or []
         if not ifc_file_path.exists():
             raise IfcFileNotFoundError(
                 f"File specified {ifc_file_path} does not exist."
@@ -52,6 +86,12 @@ class Building(BaseModelConfig):
         ifc_file = ifcopenshell.open(str(ifc_file_path))
         tree = initialize_tree(ifc_file)
         spaces = get_spaces(ifc_file)
+        if selected_spaces_global_id:
+            spaces = [
+                space for space in spaces if space.GlobalId in selected_spaces_global_id
+            ]
+        if not spaces:
+            raise NoIfcSpaceFoundError("No IfcSpace found in the file.")
         space_boundaries = [
             SpaceBoundaries.from_space_entity(ifc_file, tree, space) for space in spaces
         ]
@@ -93,26 +133,38 @@ class Building(BaseModelConfig):
                                 boundary_.common_surface.orientation
                                 * common_surface.orientation
                             ).is_a_zero()
-                        ):
+                        ) and boundary.common_surface.orientation.dot(
+                            boundary_.common_surface.orientation
+                        ) < 0:
                             elements.append(  # noqa: PERF401
                                 IfcInternalElement(
                                     spaces=[space_1, space_2],
                                     element=boundary_.entity,
-                                    area=common_surface.area,
+                                    area=min(
+                                        common_surface.area,
+                                        boundary.common_surface.area,
+                                        boundary_.common_surface.area,
+                                    ),
                                 )
                             )
-        return InternalElements(elements=elements)
+        return InternalElements(elements=list(set(elements)))
 
     @validate_call
-    def create_model(self, library: Libraries = "Buildings") -> str:
+    def create_model(
+        self,
+        library: Libraries = "Buildings",
+        north_axis: Optional[Vector] = None,
+    ) -> str:
+        north_axis = north_axis or Vector(x=0, y=1, z=0)
         network = Network(name=self.name, library=Library.from_configuration(library))
         spaces = {
             space_boundary.space.global_id: space_boundary.model(
-                self.internal_elements.internal_element_ids()
+                self.internal_elements.internal_element_ids(), north_axis
             )
             for space_boundary in self.space_boundaries
         }
-        network.add_boiler_plate_spaces(list(spaces.values()))
+        spaces = {k: v for k, v in spaces.items() if v}
+        network.add_boiler_plate_spaces(list(spaces.values()), create_internal=False)
         for internal_element in self.internal_elements.elements:
             space_1 = internal_element.spaces[0]
             space_2 = internal_element.spaces[1]