Merge pull request #363 from Dlubal-Software/heet-memberSpring

OndraMichal · web-flow · commit c0dd8d5c17ff · 2024-05-10T14:49:31.000+02:00
Heet member spring
diff --git a/RFEM/BasicObjects/member.py b/RFEM/BasicObjects/member.py
@@ -1727,6 +1727,63 @@ def CouplingHingeHinge(
         # Add Member to client model
         model.clientModel.service.set_member(clientObject)
 
+    @staticmethod
+    def Spring(no: int = 1,
+               start_node_no: int = 1,
+               end_node_no: int = 2,
+               line: int = None,
+               spring_type: int = None,
+               comment: str = '',
+               params: dict = None,
+               model = Model):
+        """
+        Args:
+            no (int): Member Tag
+            start_node_no (int): Tag of Start Node
+            end_node_no (int): Tag of End Node
+            line (int, optional): Assigned Line
+            spring_type (int, optional): Assign Member Spring Type
+            comment (str, optional): Comment
+            params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
+            model (RFEM Class, optional): Model to be edited
+        """
+
+        # Client model | Member
+        clientObject = model.clientModel.factory.create('ns0:member')
+
+        # Clears object atributes | Sets all atributes to None
+        clearAttributes(clientObject)
+
+        # Member No.
+        clientObject.no = no
+
+        # Member Type
+        clientObject.type = MemberType.TYPE_SPRING.name
+
+        # Assigned Line number or Node numbers
+        if line is None:
+            clientObject.node_start = start_node_no
+            clientObject.node_end = end_node_no
+        else:
+            clientObject.line = line
+
+        # Spring Type
+        clientObject.member_type_spring = spring_type
+
+        # Comment
+        clientObject.comment = comment
+
+        # Adding optional parameters via dictionary
+        if params:
+            for key in params:
+                clientObject[key] = params[key]
+
+        # Delete None attributes for improved performance
+        deleteEmptyAttributes(clientObject)
+
+        # Add Member to client model
+        model.clientModel.service.set_member(clientObject)
+
     @staticmethod
     def DeleteMember(members_no: str = '1 2', model = Model):
 
diff --git a/RFEM/TypesForMembers/memberSpring.py b/RFEM/TypesForMembers/memberSpring.py
@@ -0,0 +1,153 @@
+from RFEM.initModel import Model, clearAttributes, deleteEmptyAttributes,ConvertToDlString
+from RFEM.enums import MemberSpringType, PartialActivityAlongType, MemberSpringSelfWeightDefinition
+
+class MemberSpring():
+
+    def __init__(self,
+                 no: int = 1,
+                 member: str = "",
+                 definition_type = MemberSpringType.PARTIAL_ACTIVITY,
+                 parameters: list = [[PartialActivityAlongType.PARTIAL_ACTIVITY_TYPE_COMPLETE, 0.0], [PartialActivityAlongType.PARTIAL_ACTIVITY_TYPE_COMPLETE, 0.0]],
+                 axial_stiffness: float = 0.0,
+                 self_weight: list = [MemberSpringSelfWeightDefinition.MASS_PER_LENGTH, 1],
+                 name: str = None,
+                 comment: str = '',
+                 params: dict = None,
+                 model = Model):
+
+        '''
+        Args:
+            no (int): Member Spring Tag
+            members (str): Assigned Members
+            definition_type (enum): Member Spring Type Enumeration
+            parameters (list of lists): List of Parameters for Spring Nonlinearity
+                for definition_type == 'PARTIAL_ACTIVITY':
+                    parameters = [negative zone, positive zone]
+                    for negative/positive zone[0] == PartialActivityAlongType.PARTIAL_ACTIVITY_TYPE_COMPLETE:
+                        negative/positive zone = [negative/positive zone type (enum), slippage (float)]
+                    for negative/positive zone[0] == PartialActivityAlongType.PARTIAL_ACTIVITY_TYPE_FIXED:
+                        negative/positive zone = [negative/positive zone type (enum), slippage (float), displacement (float)]  (Note: Displacement must be greater than slippage)
+                    for negative/positive zone[0] == PartialActivityAlongType.PARTIAL_ACTIVITY_TYPE_FAILURE_FROM_FORCE/PARTIAL_ACTIVITY_TYPE_YIELDING_FROM_FORCE:
+                        negative/positive zone = [negative/positive zone type (enum), slippage (float), force (float)]
+                for definition_type == 'DIAGRAM':
+                    parameters = [[symmetric(bool), LineReleaseDiagram Enumeration(start), LineReleaseDiagram Enumeration(end)], [[displacement, force],...]]
+            axial_stiffness (float): Axial Stiffness
+            self_weight (list): Self Weight Parameters List
+                for self_weight[0] == 'MASS':
+                    self_weight = [MemberSpringSelfWeightDefinition.MASS, mass (float)]
+                for self_weight[0] == 'MASS_PER_LENGTH':
+                    self_weight = [MemberSpringSelfWeightDefinition.MASS_PER_LENGTH, mass_per_length (float)]
+                for self_weight[0] == 'SPECIFIC_WEIGHT':
+                    self_weight = [MemberSpringSelfWeightDefinition.SPECIFIC_WEIGHT, specific_weight (float), section_area (float)]
+            name (str, option): User Defined Design Support Name
+            comment (str, optional): Comment
+            params (dict, optional): Any WS Parameter relevant to the object and its value in form of a dictionary
+            model (RFEM Class, optional): Model to be edited
+        '''
+
+        # Client model | Member Hinge
+        clientObject = model.clientModel.factory.create('ns0:member_spring')
+
+        # Clears object atributes | Sets all atributes to None
+        clearAttributes(clientObject)
+
+        # Member Spring No.
+        clientObject.no = no
+
+        # Assigned Member
+        clientObject.assigned_to = ConvertToDlString(member)
+
+        # Member Spring Type
+        clientObject.definition_type = definition_type.name
+
+        # Spring Nonlinearity
+        if definition_type.name == 'PARTIAL_ACTIVITY':
+
+            # Negative Zone
+            clientObject.partial_activity_along_x_negative_type = parameters[0][0].name
+
+            if parameters[0][0].name == "PARTIAL_ACTIVITY_TYPE_COMPLETE":
+                clientObject.partial_activity_along_x_negative_slippage = parameters[0][1]
+
+            elif parameters[0][0].name == "PARTIAL_ACTIVITY_TYPE_FIXED":
+                clientObject.partial_activity_along_x_negative_slippage = parameters[0][1]
+                clientObject.partial_activity_along_x_negative_displacement = parameters[0][2]
+
+            elif parameters[0][0].name == ("PARTIAL_ACTIVITY_TYPE_FAILURE_FROM_FORCE" or "PARTIAL_ACTIVITY_TYPE_YIELDING_FROM_FORCE"):
+                clientObject.partial_activity_along_x_negative_slippage = parameters[0][1]
+                clientObject.partial_activity_along_x_negative_force = parameters[0][2]
+
+            # Positive Zone
+            clientObject.partial_activity_along_x_positive_type = parameters[1][0].name
+
+            if parameters[1][0].name == "PARTIAL_ACTIVITY_TYPE_COMPLETE":
+                clientObject.partial_activity_along_x_positive_slippage = parameters[1][1]
+
+            elif parameters[1][0].name == "PARTIAL_ACTIVITY_TYPE_FIXED":
+                clientObject.partial_activity_along_x_positive_slippage = parameters[1][1]
+                clientObject.partial_activity_along_x_positive_displacement = parameters[1][1]
+
+            elif parameters[1][0].name == ("PARTIAL_ACTIVITY_TYPE_FAILURE_FROM_FORCE" or "PARTIAL_ACTIVITY_TYPE_YIELDING_FROM_FORCE"):
+                clientObject.partial_activity_along_x_positive_slippage = parameters[1][1]
+                clientObject.partial_activity_along_x_positive_force = parameters[1][2]
+
+        elif definition_type.name == 'DIAGRAM':
+
+            clientObject.diagram_along_x_symmetric = parameters[0][0]
+            clientObject.diagram_along_x_is_sorted = True
+
+            if parameters[0][0]:
+                clientObject.diagram_along_x_start = parameters[0][1].name
+                clientObject.diagram_along_x_end = parameters[0][1].name
+
+            else:
+                clientObject.diagram_along_x_start = parameters[0][1].name
+                clientObject.diagram_along_x_end = parameters[0][2].name
+
+            clientObject.diagram_along_x_table = Model.clientModel.factory.create('ns0:member_spring.diagram_along_x_table')
+
+            for i,j in enumerate(parameters[1]):
+                msdx = Model.clientModel.factory.create('ns0:member_spring_diagram_along_x_table_row')
+                msdx.no = i+1
+                msdx.row = Model.clientModel.factory.create('ns0:member_spring_diagram_along_x_table')
+                clearAttributes(msdx.row)
+                msdx.row.displacement = parameters[1][i][0]
+                msdx.row.force = parameters[1][i][1]
+
+                clientObject.diagram_along_x_table.member_spring_diagram_along_x_table.append(msdx)
+
+        # Axial Stiffness
+        clientObject.axial_stiffness = axial_stiffness
+
+        # Self Weight
+        clientObject.self_weight_definition = self_weight[0].name
+
+        if self_weight[0].name == 'MASS':
+            clientObject.mass = self_weight[1]
+
+        elif self_weight[0].name == 'MASS_PER_LENGTH':
+            clientObject.mass_per_length = self_weight[1]
+
+        elif self_weight[0].name == 'SPECIFIC_WEIGHT':
+            clientObject.specific_weight = self_weight[1]
+            clientObject.section_area = self_weight[2]
+
+        # User Defined Name
+        if name:
+            clientObject.user_defined_name_enabled = True
+            clientObject.name = name
+
+        # Comment
+        clientObject.comment = comment
+
+        # Adding optional parameters via dictionary
+        if params:
+            for key in params:
+                clientObject[key] = params[key]
+
+        # Delete None attributes for improved performance
+        deleteEmptyAttributes(clientObject)
+
+        # Add Member Spring to client model
+        model.clientModel.service.set_member_spring(clientObject)
+
diff --git a/RFEM/enums.py b/RFEM/enums.py
@@ -6,8 +6,8 @@ class MemberType(Enum):
     Member Type
     '''
     TYPE_BEAM, TYPE_BUCKLING, TYPE_CABLE, TYPE_COMPRESSION, TYPE_COUPLING_HINGE_HINGE,\
-    TYPE_COUPLING_HINGE_RIGID, TYPE_COUPLING_RIGID_HINGE, TYPE_COUPLING_RIGID_RIGID,\
-    TYPE_DEFINABLE_STIFFNESS, TYPE_RIB, TYPE_RIGID, TYPE_TENSION, TYPE_TRUSS, TYPE_TRUSS_ONLY_N, TYPE_RESULT_BEAM = range(15)
+    TYPE_COUPLING_HINGE_RIGID, TYPE_COUPLING_RIGID_HINGE, TYPE_COUPLING_RIGID_RIGID, TYPE_SPRING,\
+    TYPE_DEFINABLE_STIFFNESS, TYPE_RIB, TYPE_RIGID, TYPE_TENSION, TYPE_TRUSS, TYPE_TRUSS_ONLY_N, TYPE_RESULT_BEAM = range(16)
 
 
 class NodalSupportType(Enum):
@@ -2626,18 +2626,36 @@ class MaterialStiffnessModificationType(Enum):
 
 class PoissonRatioEditableGroupType(Enum):
     '''
-    Poisson Ratio Editable Group Type
+    Poisson Ratio Editable Group Type Enumeration
     '''
     POISSON_RATIOS_GROUP_MAJOR_2D, POISSON_RATIOS_GROUP_MAJOR_3D, POISSON_RATIOS_GROUP_MINOR_2D, POISSON_RATIOS_GROUP_MINOR_3D = range(4)
 
 class DesignSupportOrientationZType(Enum):
     '''
-    Design Support Orientation Z Type
+    Design Support Orientation Z Type Enumeration
     '''
     DESIGN_SUPPORT_ORIENTATION_ZAXIS_BOTH, DESIGN_SUPPORT_ORIENTATION_ZAXIS_NEGATIVE, DESIGN_SUPPORT_ORIENTATION_ZAXIS_POSITIVE = range(3)
 
 class DesignSupportOrientationYType(Enum):
     '''
-    Design Support Orientation Y Type
+    Design Support Orientation Y Type Enumeration
     '''
     DESIGN_SUPPORT_ORIENTATION_YAXIS_BOTH, DESIGN_SUPPORT_ORIENTATION_YAXIS_NEGATIVE, DESIGN_SUPPORT_ORIENTATION_YAXIS_POSITIVE = range(3)
+
+class MemberSpringType(Enum):
+    '''
+    Member Spring Type Enumeration
+    '''
+    PARTIAL_ACTIVITY, DIAGRAM = range(2)
+
+class MemberSpringDiagramType(Enum):
+    '''
+    Member Spring Diagram Type Enumeration
+    '''
+    DIAGRAM_ENDING_TYPE_CONTINUOUS, DIAGRAM_ENDING_TYPE_STOP, DIAGRAM_ENDING_TYPE_FAILURE, DIAGRAM_ENDING_TYPE_YIELDING = range(4)
+
+class MemberSpringSelfWeightDefinition(Enum):
+    '''
+    Member Spring Self Weight Definition Enumeration
+    '''
+    MASS, MASS_PER_LENGTH, SPECIFIC_WEIGHT = range(3)
diff --git a/UnitTests/test_member.py b/UnitTests/test_member.py
@@ -338,3 +338,23 @@ def test_member_couplingHingeHinge():
 
     assert round(member.analytical_length, 5) == 5.19615
     assert member.type == "TYPE_COUPLING_HINGE_HINGE"
+
+def test_member_spring():
+
+    Model.clientModel.service.delete_all()
+    Model.clientModel.service.begin_modification()
+
+    Material(1, 'S235')
+    Section(1, 'IPE 300', 1)
+
+    Node(1, 0, 0, 0)
+    Node(2, 3, 3, 3)
+
+    Member.Spring(1, 1, 2)
+
+    Model.clientModel.service.finish_modification()
+
+    member = Model.clientModel.service.get_member(1)
+
+    assert round(member.analytical_length, 5) == 5.19615
+    assert member.type == "TYPE_SPRING"
diff --git a/UnitTests/test_memberSpring.py b/UnitTests/test_memberSpring.py
@@ -0,0 +1,46 @@
+import sys
+import os
+PROJECT_ROOT = os.path.abspath(os.path.join(
+                  os.path.dirname(__file__),
+                  os.pardir)
+)
+sys.path.append(PROJECT_ROOT)
+from RFEM.enums import MemberSpringType, PartialActivityAlongType, MemberSpringSelfWeightDefinition, MemberSpringDiagramType
+from RFEM.initModel import Model
+from RFEM.BasicObjects.material import Material
+from RFEM.BasicObjects.node import Node
+from RFEM.BasicObjects.member import Member
+from RFEM.TypesForMembers.memberSpring import MemberSpring
+
+if Model.clientModel is None:
+    Model()
+
+def test_MemberSpring():
+
+    Model.clientModel.service.delete_all()
+    Model.clientModel.service.begin_modification()
+
+    Material(1, 'S235')
+
+    Node(1, 0, 0, 0)
+    Node(2, 10, 0, 0)
+    Node(3, 20, 0, 0)
+
+    Member.Spring(1, 1, 2)
+
+    MemberSpring(1, '1', MemberSpringType.PARTIAL_ACTIVITY, [[PartialActivityAlongType.PARTIAL_ACTIVITY_TYPE_COMPLETE, 0.1], \
+        [PartialActivityAlongType.PARTIAL_ACTIVITY_TYPE_FIXED, 0.15, 0.25]], 110, [MemberSpringSelfWeightDefinition.MASS_PER_LENGTH, 5], 'Spring 1')
+    MemberSpring(2, '', MemberSpringType.DIAGRAM, [[True, MemberSpringDiagramType.DIAGRAM_ENDING_TYPE_FAILURE], \
+        [[0.01, 1000], [0.02, 1100], [0.035, 500]]], 20, [MemberSpringSelfWeightDefinition.SPECIFIC_WEIGHT, 1500, 0.012], 'Spring 2')
+
+    Member.Spring(2, 2, 3, spring_type=2)
+
+    Model.clientModel.service.finish_modification()
+
+    ms1 = Model.clientModel.service.get_member_spring(1)
+    assert ms1.assigned_to == '1'
+    assert ms1.mass_per_length == 5
+
+    ms2 = Model.clientModel.service.get_member_spring(2)
+    assert ms2.name == 'Spring 2'
+    assert ms2.axial_stiffness == 20
