First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,46 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of IfcOpenShell.
+#
+# IfcOpenShell is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# IfcOpenShell is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+from typing import Optional
+
+import ifcopenshell.api
+
+
+def add_structural_load(
+    file: ifcopenshell.file, name: Optional[str] = None, ifc_class: str = "IfcStructuralLoadLinearForce"
+) -> ifcopenshell.entity_instance:
+    """Adds a new structural load
+
+    Structural loads may be actions or reactions. A simple load might be a
+    static and be linear, planar, or a single point. Alternatively, loads
+    may be defined as a configuration of multiple loads.
+
+    :param name: The name of the load
+    :param ifc_class: The subtype of IfcStructuralLoad to create. Consult
+        the IFC documentation to see all the types of loads.
+    :return: The newly created load entity, depending on the ifc_class
+        specified.
+
+    Example:
+
+    .. code:: python
+
+        # Create a simple linear load
+        ifcopenshell.api.structural.add_structural_load(model)
+    """
+    return file.create_entity(ifc_class, Name=name)