dlubal.api 2.12.11__py3-none-any.whl

examples/rfem/demo_limits.py

@@ -0,0 +1,373 @@
+from dlubal.api import rfem
+
+material_no = 1
+cross_section_no = 1
+thickness_no = 1
+
+
+def create_material() -> list:
+    return [
+        rfem.structure_core.Material(
+            no = material_no,
+            name = 'S420MC 1.0980'
+        )
+    ]
+
+
+def create_cross_section() -> list:
+    return [
+        rfem.structure_core.CrossSection(
+            no = cross_section_no,
+            name = 'IPE 100',
+            material = material_no
+        )
+    ]
+
+
+def create_member(i: int) -> list:
+
+    origin_x = i
+    node_1_no = 2 * i - 1
+    node_2_no = 2 * i
+    line_no = i
+    member_no = i
+
+    return [
+        # nodes
+        rfem.structure_core.Node(
+            no = node_1_no,
+            coordinate_1 = origin_x,
+            coordinate_2 = 1
+        )
+        , rfem.structure_core.Node(
+            no = node_2_no,
+            coordinate_1 = origin_x,
+            coordinate_2 = 5
+        )
+
+        # lines
+        , rfem.structure_core.Line(
+            no = line_no,
+            definition_nodes = [node_1_no, node_2_no]
+        )
+
+        # members
+        , rfem.structure_core.Member(
+            no = member_no,
+            line = line_no,
+            cross_section_start = cross_section_no
+        )
+    ]
+
+
+def create_members(count: int):
+
+    objects = []
+
+    objects.extend(create_material())
+    objects.extend(create_cross_section())
+
+    for i in range(1, count + 1):
+        objects.extend(create_member(i))
+
+    rfem_app.create_object_list(objects)
+
+
+def create_one_member(no: int):
+    rfem_app.create_object_list(create_member(no))
+
+
+def create_thickness() -> list:
+    return [
+        rfem.structure_core.Thickness(
+            no = thickness_no,
+            material = material_no
+        )
+    ]
+
+
+def create_surface(i: int) -> list:
+
+    origin_x = 2 * i - 1
+
+    node_1_no = 4 * i - 3
+    node_2_no = 4 * i - 2
+    node_3_no = 4 * i - 1
+    node_4_no = 4 * i
+
+    line_1_no = 4 * i - 3
+    line_2_no = 4 * i - 2
+    line_3_no = 4 * i - 1
+    line_4_no = 4 * i
+
+    surface_no = i
+
+    return [
+        # nodes
+        rfem.structure_core.Node(
+            no = node_1_no,
+            coordinate_1 = origin_x,
+            coordinate_2 = 1
+        )
+        , rfem.structure_core.Node(
+            no = node_2_no,
+            coordinate_1 = origin_x,
+            coordinate_2 = 5
+        )
+        , rfem.structure_core.Node(
+            no = node_3_no,
+            coordinate_1 = origin_x + 1,
+            coordinate_2 = 1
+        )
+        , rfem.structure_core.Node(
+            no = node_4_no,
+            coordinate_1 = origin_x + 1,
+            coordinate_2 = 5
+        )
+
+        # lines
+        , rfem.structure_core.Line(
+            no = line_1_no,
+            definition_nodes = [node_1_no, node_2_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_2_no,
+            definition_nodes = [node_2_no, node_4_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_3_no,
+            definition_nodes = [node_4_no, node_3_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_4_no,
+            definition_nodes = [node_3_no, node_1_no]
+        )
+
+        # surfaces
+        , rfem.structure_core.Surface(
+            no = surface_no,
+            boundary_lines = [line_1_no, line_2_no, line_3_no, line_4_no],
+            thickness = thickness_no
+        )
+    ]
+
+
+def create_surfaces(count: int):
+    objects = []
+
+    objects.extend(create_material())
+    objects.extend(create_thickness())
+
+    for i in range(1, count + 1):
+        objects.extend(create_surface(i))
+
+    rfem_app.create_object_list(objects)
+
+
+def create_solid(i: int) -> list:
+
+    origin_x = 2 * i - 1
+
+    node_1_no = 8 * i - 7
+    node_2_no = 8 * i - 6
+    node_3_no = 8 * i - 5
+    node_4_no = 8 * i - 4
+    node_5_no = 8 * i - 3
+    node_6_no = 8 * i - 2
+    node_7_no = 8 * i - 1
+    node_8_no = 8 * i
+
+    line_1_no = 12 * i - 11
+    line_2_no = 12 * i - 10
+    line_3_no = 12 * i - 9
+    line_4_no = 12 * i - 8
+    line_5_no = 12 * i - 7
+    line_6_no = 12 * i - 6
+    line_7_no = 12 * i - 5
+    line_8_no = 12 * i - 4
+    line_9_no = 12 * i - 3
+    line_10_no = 12 * i - 2
+    line_11_no = 12 * i - 1
+    line_12_no = 12 * i
+
+    surface_1_no = 6 * i - 5
+    surface_2_no = 6 * i - 4
+    surface_3_no = 6 * i - 3
+    surface_4_no = 6 * i - 2
+    surface_5_no = 6 * i - 1
+    surface_6_no = 6 * i
+
+    solid_no = i
+
+    return [
+        # nodes
+        rfem.structure_core.Node(
+            no = node_1_no,
+            coordinate_1 = origin_x,
+            coordinate_2 = 1
+        )
+        , rfem.structure_core.Node(
+            no = node_2_no,
+            coordinate_1 = origin_x,
+            coordinate_2 = 5
+        )
+        , rfem.structure_core.Node(
+            no = node_3_no,
+            coordinate_1 = origin_x + 1,
+            coordinate_2 = 1
+        )
+        , rfem.structure_core.Node(
+            no = node_4_no,
+            coordinate_1 = origin_x + 1,
+            coordinate_2 = 5
+        )
+
+        , rfem.structure_core.Node(
+            no = node_5_no,
+            coordinate_1 = origin_x,
+            coordinate_2 = 1,
+            coordinate_3 = -2
+        )
+        , rfem.structure_core.Node(
+            no = node_6_no,
+            coordinate_1 = origin_x,
+            coordinate_2 = 5,
+            coordinate_3 = -2
+        )
+        , rfem.structure_core.Node(
+            no = node_7_no,
+            coordinate_1 = origin_x + 1,
+            coordinate_2 = 1,
+            coordinate_3 = -2
+        )
+        , rfem.structure_core.Node(
+            no = node_8_no,
+            coordinate_1 = origin_x + 1,
+            coordinate_2 = 5,
+            coordinate_3 = -2
+        )
+
+        # lines
+        , rfem.structure_core.Line(
+            no = line_1_no,
+            definition_nodes = [node_1_no, node_2_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_2_no,
+            definition_nodes = [node_2_no, node_4_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_3_no,
+            definition_nodes = [node_4_no, node_3_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_4_no,
+            definition_nodes = [node_3_no, node_1_no]
+        )
+
+        , rfem.structure_core.Line(
+            no = line_5_no,
+            definition_nodes = [node_5_no, node_6_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_6_no,
+            definition_nodes = [node_6_no, node_8_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_7_no,
+            definition_nodes = [node_8_no, node_7_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_8_no,
+            definition_nodes = [node_7_no, node_5_no]
+        )
+
+        , rfem.structure_core.Line(
+            no = line_9_no,
+            definition_nodes = [node_1_no, node_5_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_10_no,
+            definition_nodes = [node_2_no, node_6_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_11_no,
+            definition_nodes = [node_3_no, node_7_no]
+        )
+        , rfem.structure_core.Line(
+            no = line_12_no,
+            definition_nodes = [node_4_no, node_8_no]
+        )
+
+        # solids
+        , rfem.structure_core.Solid(
+            no = solid_no,
+            boundary_surfaces = [surface_1_no, surface_2_no, surface_3_no, surface_4_no, surface_5_no, surface_6_no],
+            material = material_no
+        )
+
+        # surfaces
+        , rfem.structure_core.Surface(
+            no = surface_1_no,
+            type = rfem.structure_core.Surface.TYPE_WITHOUT_THICKNESS,
+            boundary_lines = [line_1_no, line_2_no, line_3_no, line_4_no],
+        )
+        , rfem.structure_core.Surface(
+            no = surface_2_no,
+            type = rfem.structure_core.Surface.TYPE_WITHOUT_THICKNESS,
+            boundary_lines = [line_5_no, line_6_no, line_7_no, line_8_no],
+        )
+        , rfem.structure_core.Surface(
+            no = surface_3_no,
+            type = rfem.structure_core.Surface.TYPE_WITHOUT_THICKNESS,
+            boundary_lines = [line_1_no, line_9_no, line_5_no, line_10_no],
+        )
+        , rfem.structure_core.Surface(
+            no = surface_4_no,
+            type = rfem.structure_core.Surface.TYPE_WITHOUT_THICKNESS,
+            boundary_lines = [line_2_no, line_10_no, line_6_no, line_12_no],
+        )
+        , rfem.structure_core.Surface(
+            no = surface_5_no,
+            type = rfem.structure_core.Surface.TYPE_WITHOUT_THICKNESS,
+            boundary_lines = [line_3_no, line_11_no, line_7_no, line_12_no],
+        )
+        , rfem.structure_core.Surface(
+            no = surface_6_no,
+            type = rfem.structure_core.Surface.TYPE_WITHOUT_THICKNESS,
+            boundary_lines = [line_4_no, line_9_no, line_8_no, line_11_no],
+        )
+    ]
+
+
+def create_solids(count: int):
+    objects = []
+
+    objects.extend(create_material())
+
+    for i in range(1, count + 1):
+        objects.extend(create_solid(i))
+
+    rfem_app.create_object_list(objects)
+
+
+with rfem.Application() as rfem_app:
+
+    rfem_app.delete_all_objects()
+
+    # create_members(11) # under limit
+    # create_members(12) # on limit
+    create_members(13) # over limit
+
+    # create_members(12) # on limit
+    # create_one_member(15) # over limit
+
+    # create_surfaces(1) # under limit
+    # create_surfaces(2) # on limit
+    # create_surfaces(3) # over limit
+
+    # create_solids(1) # under limit
+    # create_solids(2) # on limit
+    # create_solids(3) # over limit
+
+    # rfem_app.calculate_all(skip_warnings=True)

examples/rfem/design_configuration.py

@@ -0,0 +1,87 @@
+from dlubal.api import rfem, common
+import google.protobuf.json_format as pbjson
+
+# Connect to the RFEM application
+with rfem.Application() as rfem_app:
+
+    # --- Steel Design | ULS Configuration ---
+
+    # Retrieve Design ULS Configuration TreeTable
+    steel_uls_config: rfem.steel_design_objects.SteelDesignUlsConfiguration = rfem_app.get_object(
+        obj=rfem.steel_design_objects.SteelDesignUlsConfiguration(no=1)
+    )
+    settings_ec3_uls = steel_uls_config.settings_ec3
+    print(f"\nSETTINGS_EC3_ULS:\n{settings_ec3_uls}")
+
+    # Retrieve a specific value from the configuration
+    # Path to the specific value
+    elastic_design_path=[
+        "options",
+        "options_elastic_design_root",
+        "options_elastic_design"
+    ]
+    # Get specific value
+    elastic_design_val = common.get_tree_value(
+        tree=settings_ec3_uls,
+        path=elastic_design_path
+    )
+    print(f"\nElastic Design: {elastic_design_val}")
+
+    # Modify the value
+    # Create empty TreeTable and set only the values that we want to change
+    settings_ec3_uls_updated = rfem.steel_design_objects.SteelDesignUlsConfiguration.SettingsEc3TreeTable()
+    common.set_tree_value(
+        tree=settings_ec3_uls_updated,
+        path=elastic_design_path,
+        value=True
+    )
+
+    # Apply the updated configuration to the model
+    rfem_app.update_object(
+        obj=rfem.steel_design_objects.SteelDesignUlsConfiguration(
+            no=1,
+            settings_ec3=settings_ec3_uls_updated
+        )
+    )
+
+
+    # --- Steel Design | SLS Configuration ---
+
+    # Retrieve Design SLS Configuration TreeTable
+    steel_sls_config: rfem.steel_design_objects.SteelDesignSlsConfiguration = rfem_app.get_object(
+        obj=rfem.steel_design_objects.SteelDesignSlsConfiguration(no=1)
+    )
+    settings_ec3_sls = steel_sls_config.settings_ec3
+    print(f"\nSETTINGS_EC3_SLS:\n{settings_ec3_sls}")
+
+    # Retrieve a specific value from the configuration
+    # Path to the specific value
+    beam_rel_deflection_limit_path=[
+        "serviceability_limits",
+        "sl_check_limit_characteristic",
+        "sl_check_deformation_z_or_resulting_axis_characteristic",
+        "l_", # Beam | Relative limit
+    ]
+    # Get specific value
+    beam_rel_deflection_limit_val = common.get_tree_value(
+        tree=settings_ec3_sls,
+        path=beam_rel_deflection_limit_path
+    )
+    print(f"\nBeam | Relative deflection limit: L/{beam_rel_deflection_limit_val}")
+
+    # Modify the value
+    # Create empty TreeTable and set only the values that we want to change
+    settings_ec3_sls_updated =rfem.steel_design_objects.SteelDesignSlsConfiguration.SettingsEc3TreeTable()
+    common.set_tree_value(
+        tree=settings_ec3_sls_updated,
+        path=beam_rel_deflection_limit_path,
+        value=250
+    )
+
+    # Apply the updated configuration to the model
+    rfem_app.update_object(
+        obj=rfem.steel_design_objects.SteelDesignSlsConfiguration(
+            no=1,
+            settings_ec3=settings_ec3_sls_updated
+        )
+    )

examples/rfem/design_results.py

@@ -0,0 +1,58 @@
+from dlubal.api import rfem
+
+with rfem.Application() as rfem_app:
+
+    calculation_info = rfem_app.calculate_all(
+        skip_warnings=False
+    )
+
+    if calculation_info.succeeded:
+
+        # --- Retriev results from the active model (already calculated) ---
+
+        # 1. get_results: Returns all results of the specified type directly from the database.
+        #    This is the full dataset, including all possible columns and data. Use this for custom analytics,
+        #    advanced filtering, or to access values not shown in the GUI summary.
+        design_ratios_df = rfem_app.get_results(
+            results_type=rfem.results.ResultsType.STEEL_DESIGN_MEMBERS_DESIGN_RATIOS
+        ).data
+        print(f"\n\nSteel Design | Design Ratios | Raw Data")
+        print(design_ratios_df)
+
+
+        # 2. get_result_table: Returns a specific result table as it appears in the desktop GUI in default state.
+        #    Only the most important values are included, mirroring what end users see for quick review or export.
+        design_ratios_by_member_df = rfem_app.get_result_table(
+            table = rfem.results.ResultTable.STEEL_DESIGN_MEMBERS_DESIGN_RATIOS_BY_MEMBER_TABLE,
+            loading = None
+        ).data
+        print(f"\n\nSteel Design | Design Ratios by Member | Table:")
+        print(design_ratios_by_member_df)
+
+
+        # 1. get_results: Returns all results of the specified type directly from the database.
+        #    This is the full dataset, including all possible columns and data. Use this for custom analytics,
+        #    advanced filtering, or to access values not shown in the GUI summary.
+        design_check_details = rfem_app.get_results(
+            results_type=rfem.results.ResultsType.STEEL_DESIGN_DESIGN_CHECK_DETAILS,
+            filters=[
+                rfem.results.ResultsFilter(
+                    column_id='design_check_details_id', filter_expression="13"
+                )
+            ]
+        ).data
+        print(f"\n\nSteel Design | Details:")
+        print(design_check_details)
+
+    else:
+        # 2. get_result_table: Returns a specific result table as it appears in the desktop GUI in default state.
+        #    Only the most important values are included, mirroring what end users see for quick review or export.
+        errors_warning_df = rfem_app.get_result_table(
+            table = rfem.results.ResultTable.ERRORS_AND_WARNINGS_TABLE,
+            loading = None
+        ).data
+        print(f"\n\nErrors and Warnings | Table:")
+        print(errors_warning_df)
+
+
+

examples/rfem/design_settings.py

@@ -0,0 +1,37 @@
+from dlubal.api import rfem, common
+
+# Connect to the RFEM application
+with rfem.Application() as rfem_app:
+
+    # Step 1: Retrieve the global settings tree table for Steel Design (active model)
+    design_settings: rfem.GlobalSettingsTreeTable = rfem_app.get_design_settings(
+        addon=rfem.DesignAddons.STEEL_DESIGN
+    )
+    print(f"DESIGN SETTINGS:\n{design_settings}")
+
+    # Step 2: Retrieve a specific value
+    # Path to access specific value
+    member_slendernesses_path = [
+        'member_slendernesses',
+        'member_slendernesses_tension_ec3'
+    ]
+    # Get and print specific value
+    member_slendernesses_val = common.get_tree_value(
+        tree=design_settings,
+        path=member_slendernesses_path
+    )
+    print(f"\nMember slendernesses: {member_slendernesses_val}")
+
+    # Step 3: Modify the value and save the updated design settings
+    # Set a new value
+    common.set_tree_value(
+        tree=design_settings,
+        path=member_slendernesses_path,
+        value=280,
+    )
+    # Apply the updated design settings to the model
+    rfem_app.set_design_settings(
+        addon=rfem.DesignAddons.STEEL_DESIGN,
+        global_settings_tree_table=design_settings
+    )
+

examples/rfem/excel.py

@@ -0,0 +1,86 @@
+import os
+import xlwings as xw
+from dlubal.api import rfem
+
+def open_work_book():
+    """Open excel file."""
+
+    dirname = os.path.join(os.getcwd(), os.path.dirname(__file__))
+    path = os.path.join(dirname,'src/Nodes.xlsx')
+
+    wb = xw.Book(path)
+
+    return wb
+
+def close_work_book(wb):
+    """Close excel file."""
+
+    wb.save()
+    app = wb.app
+    wb.close()
+    app.kill()
+
+def get_node_from_excel(work_book) -> dict:
+    """Retrieve node from excel file."""
+
+    input_sheet = work_book.sheets('Nodes')
+
+    node1 = {'no' : int(input_sheet["A2"].value),
+              'x' : input_sheet["B2"].value,
+              'y' : input_sheet["C2"].value,
+              'z' : input_sheet["D2"].value}
+
+    return node1
+
+def write_node_to_excel(node, work_book) -> None:
+    """Write data to excel file."""
+
+    input_sheet = work_book.sheets('Nodes')
+
+    input_sheet["A3"].value = node.no
+    input_sheet["B3"].value = node.coordinate_1
+    input_sheet["C3"].value = node.coordinate_2
+    input_sheet["D3"].value = node.coordinate_3
+    if node.comment:
+        input_sheet["E3"].value = node.comment
+
+
+if __name__ == "__main__":
+    """Main routine."""
+
+    with rfem.Application() as rfem_app:
+
+        # Step 1: Create a new model
+        rfem_app.close_all_models(save_changes=False)
+        rfem_app.create_model(name='excel')
+
+        # Step 2: Clear existing objects
+        rfem_app.delete_all_objects()
+
+        # Step 3: Get data for node from excel
+        work_book = open_work_book()
+
+        # Step 4: Create nodes in RFEM
+        node1 = get_node_from_excel(work_book)
+
+        rfem_app.create_object_list(objs = [
+            rfem.structure_core.Node(
+                no = node1['no'],
+                coordinate_1 = node1['x'],
+                coordinate_2 = node1['y'],
+                coordinate_3 = node1['z']),
+            rfem.structure_core.Node(
+                no = 2,
+                coordinate_1 = 1,
+                coordinate_2 = 2,
+                coordinate_3 = 4,
+                comment = 'Node 2')])
+
+        # Step 4: Get node 2 from RFEM
+        node2 = rfem_app.get_object(
+            obj = rfem.structure_core.Node(
+                no = 2))
+        write_node_to_excel(node2, work_book)
+
+        # Step 5: Save and close excel file
+        close_work_book(work_book)