moved piping to distribution_element module

Author: Crowder44

src/bim2fem/ifcplus/api/distribution_element.py

@@ -13,16 +13,359 @@
 import ifcopenshell.api.type
 import numpy as np
 import ifcopenshell.util.representation
+from typing import Literal
+import ifcopenshell.api.system
+import ifcopenshell.api.root
+import ifcopenshell.api.spatial
+import bim2fem.ifcplus.api.placement
+import bim2fem.ifcplus.api.geometry
+import bim2fem.ifcplus.api.profile
+import ifcopenshell.api.geometry
+import bim2fem.ifcplus.util.geometry
+import ifcopenshell.api.material
+import numpy as np
+import bim2fem.ifcplus.api.system
+import ifcopenshell.util.representation
+
+
+ELBOW_RADIUS_TYPE = Literal["LONG", "SHORT"]
+
+
+def create_elbow(
+    horizontal_curve: bim2fem.ifcplus.util.geometry.HorizontalCurve,
+    nominal_diameter: float,
+    thickness: float,
+    material: ifcopenshell.entity_instance,
+    elbow: ifcopenshell.entity_instance | None = None,
+    name: str | None = None,
+    spatial_element: ifcopenshell.entity_instance | None = None,
+    distribution_system: ifcopenshell.entity_instance | None = None,
+    place_object_relative_to_parent: bool = False,
+    add_shape_representation_to_ports: bool = False,
+) -> ifcopenshell.entity_instance:
+
+    ifc4_file = material.file
+
+    if elbow is None:
+        elbow = ifcopenshell.api.root.create_entity(
+            file=ifc4_file,
+            ifc_class="IfcPipeFitting",
+            name=name,
+            predefined_type="JUNCTION",
+        )
+
+    if isinstance(spatial_element, ifcopenshell.entity_instance):
+        ifcopenshell.api.spatial.assign_container(
+            file=ifc4_file,
+            products=[elbow],
+            relating_structure=spatial_element,
+        )
+        bim2fem.ifcplus.api.placement.edit_object_placement(
+            product=elbow,
+            place_object_relative_to_parent=True,
+        )
+
+    if isinstance(distribution_system, ifcopenshell.entity_instance):
+        ifcopenshell.api.system.assign_system(
+            file=ifc4_file,
+            products=[elbow],
+            system=distribution_system,
+        )
+
+    outer_radius = nominal_diameter / 2 + thickness / 2
+
+    revolved_area_solid = bim2fem.ifcplus.api.geometry.add_revolved_area_solid(
+        ifc4_file=ifc4_file,
+        profile=bim2fem.ifcplus.api.profile.add_parameterized_profile(
+            ifc4_file=ifc4_file,
+            profile_class="IfcCircleHollowProfileDef",
+            dimensions=[outer_radius, thickness],
+            check_for_duplicate=True,
+            calculate_mechanical_properties=True,
+        ),
+        central_angle_of_curvature=horizontal_curve.central_angle,
+        center_of_curvature_in_object_xy_plane=(
+            horizontal_curve.radius_of_curvature,
+            0.0,
+        ),
+    )
+
+    representation_type = ifcopenshell.util.representation.guess_type(
+        items=[revolved_area_solid]
+    )
+    assert isinstance(representation_type, str)
+
+    shape_model = bim2fem.ifcplus.api.geometry.add_shape_model(
+        ifc4_file=ifc4_file,
+        shape_model_class="IfcShapeRepresentation",
+        representation_identifier="Body",
+        representation_type=representation_type,
+        items=[revolved_area_solid],
+    )
+    ifcopenshell.api.geometry.assign_representation(
+        file=ifc4_file,
+        product=elbow,
+        representation=shape_model,
+    )
+
+    object_z_axis_in_global_coordinates = bim2fem.ifcplus.util.geometry.calculate_unit_direction_vector_between_two_points(
+        p1=horizontal_curve.point_of_curvature,
+        p2=horizontal_curve.point_of_intersection,
+    )
+
+    object_x_axis_in_global_coordinates = bim2fem.ifcplus.util.geometry.calculate_unit_direction_vector_between_two_points(
+        p1=horizontal_curve.point_of_curvature,
+        p2=horizontal_curve.center_of_curvature,
+    )
+
+    object_origin_in_global_coordinates = horizontal_curve.point_of_curvature
+
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=elbow,
+        repositioned_origin=object_origin_in_global_coordinates,
+        repositioned_z_axis=object_z_axis_in_global_coordinates,
+        repositioned_x_axis=object_x_axis_in_global_coordinates,
+        place_object_relative_to_parent=place_object_relative_to_parent,
+    )
+
+    ifcopenshell.api.material.assign_material(
+        file=ifc4_file,
+        products=[elbow],
+        material=material,
+    )
+
+    port1_origin_in_object_coordinates = (0.0, 0.0, 0.0)
+    port1_z_axis_in_object_coordinates = (0.0, 0.0, 1.0)
+    port1_x_axis_in_object_coordinates = (1.0, 0.0, 0.0)
+    port1 = ifcopenshell.api.system.add_port(file=ifc4_file, element=elbow)
+    port1.FlowDirection = "SINK"
+    port1.PredefinedType = "PIPE"
+    if isinstance(distribution_system, ifcopenshell.entity_instance):
+        port1.SystemType = distribution_system.PredefinedType
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=port1,
+        place_object_relative_to_parent=False,
+    )
+    port1.ObjectPlacement.PlacementRelTo = elbow.ObjectPlacement
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=port1,
+        repositioned_origin=port1_origin_in_object_coordinates,
+        repositioned_z_axis=port1_z_axis_in_object_coordinates,
+        repositioned_x_axis=port1_x_axis_in_object_coordinates,
+        place_object_relative_to_parent=True,
+    )
+
+    radius_of_curvature = horizontal_curve.radius_of_curvature
+    central_angle = horizontal_curve.central_angle
+    port2_origin_in_object_coordinates = (
+        float(radius_of_curvature - radius_of_curvature * np.cos(central_angle)),
+        0.0,
+        float(radius_of_curvature * np.sin(central_angle)),
+    )
+    port2_z_axis_in_object_coordinates = (
+        float(np.sin(horizontal_curve.central_angle)),
+        0.0,
+        float(np.cos(horizontal_curve.central_angle)),
+    )
+    port2_x_axis_in_object_coordinates = (
+        float(np.cos(horizontal_curve.central_angle)),
+        0.0,
+        float(-1 * np.sin(horizontal_curve.central_angle)),
+    )
+    port2 = ifcopenshell.api.system.add_port(file=ifc4_file, element=elbow)
+    port2.FlowDirection = "SOURCE"
+    port2.PredefinedType = "PIPE"
+    if isinstance(distribution_system, ifcopenshell.entity_instance):
+        port2.SystemType = distribution_system.PredefinedType
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=port2,
+        place_object_relative_to_parent=False,
+    )
+    port2.ObjectPlacement.PlacementRelTo = elbow.ObjectPlacement
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=port2,
+        repositioned_origin=port2_origin_in_object_coordinates,
+        repositioned_z_axis=port2_z_axis_in_object_coordinates,
+        repositioned_x_axis=port2_x_axis_in_object_coordinates,
+        place_object_relative_to_parent=True,
+    )
+
+    if add_shape_representation_to_ports:
+        bim2fem.ifcplus.api.system.add_shape_representation_to_distribution_ports(
+            ports=[port1, port2],
+            arrow_size=nominal_diameter * 0.10,
+        )
+
+    return elbow
+
+
+def create_pipe_segment(
+    p1: tuple[float, float, float],
+    p2: tuple[float, float, float],
+    nominal_diameter: float,
+    thickness: float,
+    material: ifcopenshell.entity_instance,
+    pipe_segment: ifcopenshell.entity_instance | None = None,
+    name: str | None = None,
+    spatial_element: ifcopenshell.entity_instance | None = None,
+    distribution_system: ifcopenshell.entity_instance | None = None,
+    place_object_relative_to_parent: bool = False,
+    add_shape_representation_to_ports: bool = False,
+) -> ifcopenshell.entity_instance:
+
+    ifc4_file = material.file
+
+    if pipe_segment is None:
+        pipe_segment = ifcopenshell.api.root.create_entity(
+            file=ifc4_file,
+            ifc_class="IfcPipeSegment",
+            name=name,
+            predefined_type="NOTDEFINED",
+        )
 
+    if isinstance(spatial_element, ifcopenshell.entity_instance):
+        ifcopenshell.api.spatial.assign_container(
+            file=ifc4_file,
+            products=[pipe_segment],
+            relating_structure=spatial_element,
+        )
+        bim2fem.ifcplus.api.placement.edit_object_placement(
+            product=pipe_segment,
+            place_object_relative_to_parent=True,
+        )
+
+    if isinstance(distribution_system, ifcopenshell.entity_instance):
+        ifcopenshell.api.system.assign_system(
+            file=ifc4_file,
+            products=[pipe_segment],
+            system=distribution_system,
+        )
+
+    object_z_axis_in_global_coordinates = np.array(p2) - np.array(p1)
+    angle_between_local_and_global_z_axes = (
+        bim2fem.ifcplus.util.geometry.calculate_angle_between_two_vectors(
+            vector1=tuple(object_z_axis_in_global_coordinates.tolist()),
+            vector2=(0.0, 0.0, 1.0),
+        )
+    )
+    angle_between_local_and_global_z_axes_is_zero = (
+        angle_between_local_and_global_z_axes <= 1e-4
+    )
+    angle_between_local_and_global_z_axes_is_pi = (
+        abs(angle_between_local_and_global_z_axes - np.pi) <= 1e-4
+    )
+    if (
+        angle_between_local_and_global_z_axes_is_zero
+        or angle_between_local_and_global_z_axes_is_pi
+    ):
+        object_y_axis_in_global_coordinates = np.array([0.0, 1.0, 0.0])
+    else:
+        object_y_axis_in_global_coordinates = np.cross(
+            np.array([0.0, 0.0, 1.0]), object_z_axis_in_global_coordinates
+        )
+    object_x_axis_in_global_coordinates = np.cross(
+        object_y_axis_in_global_coordinates, object_z_axis_in_global_coordinates
+    )
+
+    length = float(np.linalg.norm(object_z_axis_in_global_coordinates))
+
+    outer_radius = nominal_diameter / 2 + thickness / 2
+
+    extruded_area_solid = bim2fem.ifcplus.api.geometry.add_extruded_area_solid(
+        ifc4_file=ifc4_file,
+        profile=bim2fem.ifcplus.api.profile.add_parameterized_profile(
+            ifc4_file=ifc4_file,
+            profile_class="IfcCircleHollowProfileDef",
+            dimensions=[outer_radius, thickness],
+            check_for_duplicate=True,
+            calculate_mechanical_properties=True,
+        ),
+        extrusion_depth=length,
+    )
+
+    representation_type = ifcopenshell.util.representation.guess_type(
+        items=[extruded_area_solid]
+    )
+    assert isinstance(representation_type, str)
+
+    shape_model = bim2fem.ifcplus.api.geometry.add_shape_model(
+        ifc4_file=ifc4_file,
+        shape_model_class="IfcShapeRepresentation",
+        representation_identifier="Body",
+        representation_type=representation_type,
+        items=[extruded_area_solid],
+    )
+    ifcopenshell.api.geometry.assign_representation(
+        file=ifc4_file,
+        product=pipe_segment,
+        representation=shape_model,
+    )
+
+    object_origin_in_global_coordinates = p1
+
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=pipe_segment,
+        repositioned_origin=object_origin_in_global_coordinates,
+        repositioned_z_axis=object_z_axis_in_global_coordinates,
+        repositioned_x_axis=object_x_axis_in_global_coordinates,
+        place_object_relative_to_parent=place_object_relative_to_parent,
+    )
+
+    ifcopenshell.api.material.assign_material(
+        file=ifc4_file,
+        products=[pipe_segment],
+        material=material,
+    )
+
+    port1_origin_in_object_coordinates = (0.0, 0.0, 0.0)
+    port1_z_axis_in_object_coordinates = (0.0, 0.0, 1.0)
+    port1_x_axis_in_object_coordinates = (1.0, 0.0, 0.0)
+    port1 = ifcopenshell.api.system.add_port(file=ifc4_file, element=pipe_segment)
+    port1.FlowDirection = "SINK"
+    port1.PredefinedType = "PIPE"
+    if isinstance(distribution_system, ifcopenshell.entity_instance):
+        port1.SystemType = distribution_system.PredefinedType
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=port1,
+        place_object_relative_to_parent=False,
+    )
+    port1.ObjectPlacement.PlacementRelTo = pipe_segment.ObjectPlacement
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=port1,
+        repositioned_origin=port1_origin_in_object_coordinates,
+        repositioned_z_axis=port1_z_axis_in_object_coordinates,
+        repositioned_x_axis=port1_x_axis_in_object_coordinates,
+        place_object_relative_to_parent=True,
+    )
+
+    port2_origin_in_object_coordinates = (0.0, 0.0, length)
+    port2_z_axis_in_object_coordinates = (0.0, 0.0, 1.0)
+    port2_x_axis_in_object_coordinates = (1.0, 0.0, 0.0)
+    port2 = ifcopenshell.api.system.add_port(file=ifc4_file, element=pipe_segment)
+    port2.FlowDirection = "SOURCE"
+    port2.PredefinedType = "PIPE"
+    if isinstance(distribution_system, ifcopenshell.entity_instance):
+        port2.SystemType = distribution_system.PredefinedType
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=port2,
+        place_object_relative_to_parent=False,
+    )
+    port2.ObjectPlacement.PlacementRelTo = pipe_segment.ObjectPlacement
+    bim2fem.ifcplus.api.placement.edit_object_placement(
+        product=port2,
+        repositioned_origin=port2_origin_in_object_coordinates,
+        repositioned_z_axis=port2_z_axis_in_object_coordinates,
+        repositioned_x_axis=port2_x_axis_in_object_coordinates,
+        place_object_relative_to_parent=True,
+    )
+
+    if add_shape_representation_to_ports:
+        bim2fem.ifcplus.api.system.add_shape_representation_to_distribution_ports(
+            ports=[port1, port2],
+            arrow_size=nominal_diameter * 0.10,
+        )
 
-PREDEFINED_DISTRIBUTION_ELEMENTS = [
-    "MAKEUP_AIR_UNIT",
-    "MOTORIZED_VALVE",
-    "GENERIC_AIR_FILTER",
-    "AIR_FILTRATION_CONTAINMENT_HOUSING",
-    "HPRS_EXHAUST_FAN",
-    "STACK",
-]
+    return pipe_segment
 
 
 def create_make_up_air_unit(