SpringBasedElement Class Reference

Class that handles the storage and manipulation of a spring-based element's information (mechanical and geometrical parameters, etc) and the initialisation in the model. More...

Inheritance diagram for SpringBasedElement:

Public Member Functions
def	__init__ (self, int iNode_ID, int jNode_ID, A, E, Iy_mod, int geo_transf_ID, mat_ID_i=-1, mat_ID_j=-1, ele_ID=-1)
	Constructor of the class. More...
def	CreateMember (self)
	Method that initialises the member by calling the OpenSeesPy commands through various functions. More...
def	Record (self, str spring_or_element, str name_txt, str data_dir, force_rec=True, def_rec=True, time_rec=True)
	Implementation of the homonym abstract method. More...
def	RecordNodeDef (self, str name_txt, str data_dir, time_rec=True)
	Implementation of the homonym abstract method. More...
def	ReInit (self, ele_ID=-1)
	Implementation of the homonym abstract method. More...
def	ShowInfo (self, plot=False, block=False)
	Implementation of the homonym abstract method. More...
def	UpdateStoredData (self)
	Implementation of the homonym abstract method. More...
def	Record (self, ele_ID, str name_txt, str data_dir, force_rec=True, def_rec=True, time_rec=True)
	Abstract method that records the forces, deformation and time of the member associated with the class. More...
def	RecordNodeDef (self, int iNode_ID, int jNode_ID, str name_txt, str data_dir, time_rec=True)
	Abstract method that records the deformation and time of the member's nodes associated with the class. More...

Public Attributes
	A
	data
	E
	ele_orientation
	element_array
	element_ID
	geo_transf_ID
	Initialized
	iNode_ID
	iNode_ID_spring
	iSpring_ID
	Iy_mod
	jNode_ID
	jNode_ID_spring
	jSpring_ID
	mat_ID_i
	mat_ID_j
	section_name_tag

Detailed Description

Class that handles the storage and manipulation of a spring-based element's information (mechanical and geometrical parameters, etc) and the initialisation in the model.

Parameters

MemberModel

Parent abstract class.

Definition at line 659 of file MemberModel.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
		int	iNode_ID,
		int	jNode_ID,
			A,
			E,
			Iy_mod,
		int	geo_transf_ID,
			mat_ID_i = -1,
			mat_ID_j = -1,
			ele_ID = -1
	)

Constructor of the class.

Parameters

iNode_ID	(int): ID of the first end node.
jNode_ID	(int): ID of the second end node.
A	(float): Area of the member.
E	(float): Young modulus.
Iy_mod	(float): Second moment of inertia (strong axis).
geo_transf_ID	(int): A geometric transformation (for more information, see OpenSeesPy documentation).
mat_ID_i	(int, optional): ID of the material model for the spring in the node i (if present). Defaults to -1.
mat_ID_j	(int, optional): ID of the material model for the spring in the node j (if present). Defaults to -1.
ele_ID	(int, optional): Optional ID of the element. Defaults to -1, e.g. use IDConvention to define it.

Exceptions

NegativeValue	ID needs to be a positive integer.
NegativeValue	ID needs to be a positive integer.
NegativeValue	A needs to be positive.
NegativeValue	E needs to be positive.
NegativeValue	Iy_mod needs to be positive.
NegativeValue	ID needs to be a positive integer.
NegativeValue	ID needs to be a positive integer, if different from -1.
NegativeValue	ID needs to be a positive integer, if different from -1.
NameError	at least one spring needs to be defined.
NegativeValue	ID needs to be a positive integer, if different from -1.

Reimplemented in SpringBasedElementSteelIShape, and SpringBasedElementModifiedIMKSteelIShape.

Definition at line 665 of file MemberModel.py.

    def __init__(self, iNode_ID: int, jNode_ID: int, A, E, Iy_mod, geo_transf_ID: int, mat_ID_i = -1, mat_ID_j = -1, ele_ID = -1):
        """
        Constructor of the class.
 
        @param iNode_ID (int): ID of the first end node.
        @param jNode_ID (int): ID of the second end node.
        @param A (float): Area of the member.
        @param E (float): Young modulus.
        @param Iy_mod (float): Second moment of inertia (strong axis).
        @param geo_transf_ID (int): A geometric transformation (for more information, see OpenSeesPy documentation).
        @param mat_ID_i (int, optional): ID of the material model for the spring in the node i (if present). Defaults to -1.
        @param mat_ID_j (int, optional): ID of the material model for the spring in the node j (if present). Defaults to -1.
        @param ele_ID (int, optional): Optional ID of the element. Defaults to -1, e.g. use IDConvention to define it.
 
        @exception NegativeValue: ID needs to be a positive integer.
        @exception NegativeValue: ID needs to be a positive integer.
        @exception NegativeValue: A needs to be positive.
        @exception NegativeValue: E needs to be positive.
        @exception NegativeValue: Iy_mod needs to be positive.
        @exception NegativeValue: ID needs to be a positive integer.
        @exception NegativeValue: ID needs to be a positive integer, if different from -1.
        @exception NegativeValue: ID needs to be a positive integer, if different from -1.
        @exception NameError: at least one spring needs to be defined.
        @exception NegativeValue: ID needs to be a positive integer, if different from -1.
        """
        # Check
        if iNode_ID < 1: raise NegativeValue()
        if jNode_ID < 1: raise NegativeValue()
        if A < 0: raise NegativeValue()
        if E < 0: raise NegativeValue()
        if Iy_mod < 0: raise NegativeValue()
        if geo_transf_ID < 1: raise NegativeValue()
        if mat_ID_i != -1 and mat_ID_i < 0: raise NegativeValue()
        if mat_ID_j != -1 and mat_ID_j < 0: raise NegativeValue()
        if mat_ID_i == -1 and mat_ID_j == -1: raise NameError("No springs defined for element ID = {}".format(IDConvention(iNode_ID, jNode_ID)))
        if ele_ID != -1 and ele_ID < 0: raise NegativeValue()
 
        # Arguments
        self.iNode_ID = iNode_ID
        self.jNode_ID = jNode_ID
        self.A = A
        self.E = E
        self.Iy_mod = Iy_mod
        self.geo_transf_ID = geo_transf_ID
        self.mat_ID_i = mat_ID_i 
        self.mat_ID_j = mat_ID_j 
 
        # Initialized the parameters that are dependent from others
        self.section_name_tag = "None"
        self.Initialized = False
        self.ReInit(ele_ID)
 
 

Member Function Documentation

CreateMember()

def CreateMember

(

self

)

Method that initialises the member by calling the OpenSeesPy commands through various functions.

Definition at line 799 of file MemberModel.py.

    def CreateMember(self):
        """
        Method that initialises the member by calling the OpenSeesPy commands through various functions.
        """
        self.element_array = [[self.element_ID, self.iNode_ID_spring, self.jNode_ID_spring]]
        if self.mat_ID_i != -1:
            # Define zero length element i
            node(self.iNode_ID_spring, *nodeCoord(self.iNode_ID))
            self.iSpring_ID = IDConvention(self.iNode_ID, self.iNode_ID_spring)
            RotationalSpring(self.iSpring_ID, self.iNode_ID, self.iNode_ID_spring, self.mat_ID_i)
            self.element_array.append([self.iSpring_ID, self.iNode_ID, self.iNode_ID_spring])
        if self.mat_ID_j != -1:
            # Define zero length element j
            node(self.jNode_ID_spring, *nodeCoord(self.jNode_ID))
            self.jSpring_ID = IDConvention(self.jNode_ID, self.jNode_ID_spring)
            RotationalSpring(self.jSpring_ID, self.jNode_ID, self.jNode_ID_spring, self.mat_ID_j)
            self.element_array.append([self.jSpring_ID, self.jNode_ID, self.jNode_ID_spring])
        
        # Define element
        element("elasticBeamColumn", self.element_ID, self.iNode_ID_spring, self.jNode_ID_spring, self.A, self.E, self.Iy_mod, self.geo_transf_ID)
 
        # Update class
        self.Initialized = True
        self.UpdateStoredData()
 
 

Record()

def Record	(		self,
		str	spring_or_element,
		str	name_txt,
		str	data_dir,
			force_rec = True,
			def_rec = True,
			time_rec = True
	)

Implementation of the homonym abstract method.

See parent class MemberModel for detailed information.

Reimplemented from MemberModel.

Definition at line 825 of file MemberModel.py.

    def Record(self, spring_or_element: str, name_txt: str, data_dir: str, force_rec=True, def_rec=True, time_rec=True):
        """
        Implementation of the homonym abstract method.
        See parent class MemberModel for detailed information.
        """
        if spring_or_element == "element":
            super().Record(self.element_ID, name_txt, data_dir, force_rec=force_rec, def_rec=def_rec, time_rec=time_rec)
        elif spring_or_element == "spring_i":
            if self.mat_ID_i == -1:
                print("Spring i recorded not present in element ID = {}".format(self.element_ID))
            else:
                super().Record(self.iSpring_ID, name_txt, data_dir, force_rec=force_rec, def_rec=def_rec, time_rec=time_rec)
        elif spring_or_element == "spring_j":
            if self.mat_ID_j == -1:
                print("Spring j recorded not present in element ID = {}".format(self.element_ID))
            else:
                super().Record(self.jSpring_ID, name_txt, data_dir, force_rec=force_rec, def_rec=def_rec, time_rec=time_rec)
        else:
            print("No recording option with: '{}' with element ID: {}".format(spring_or_element, self.element_ID))
    
 

RecordNodeDef()

def RecordNodeDef	(		self,
		str	name_txt,
		str	data_dir,
			time_rec = True
	)

Implementation of the homonym abstract method.

See parent class MemberModel for detailed information.

Reimplemented from MemberModel.

Definition at line 846 of file MemberModel.py.

    def RecordNodeDef(self, name_txt: str, data_dir: str, time_rec=True):
        """
        Implementation of the homonym abstract method.
        See parent class MemberModel for detailed information.
        """
        super().RecordNodeDef(self.iNode_ID, self.jNode_ID, name_txt, data_dir, time_rec=time_rec)
 
 

ReInit()

def ReInit	(		self,
			ele_ID = -1
	)

Implementation of the homonym abstract method.

See parent class DataManagement for detailed information.

Parameters

ele_ID

(int, optional): Optional ID of the element. Defaults to -1, e.g. use IDConvention to define it.

Definition at line 718 of file MemberModel.py.

    def ReInit(self, ele_ID = -1):
        """
        Implementation of the homonym abstract method.
        See parent class DataManagement for detailed information.
        
        @param ele_ID (int, optional): Optional ID of the element. Defaults to -1, e.g. use IDConvention to define it.
        """
        # Members
        if self.section_name_tag != "None": self.section_name_tag = self.section_name_tag + " (modified)"
        # orientation:
        self.ele_orientation = NodesOrientation(self.iNode_ID, self.jNode_ID)
        if self.ele_orientation == "zero_length": raise ZeroLength(IDConvention(self.iNode_ID, self.jNode_ID))
        
        if self.mat_ID_i != -1:
            self.iNode_ID_spring = OffsetNodeIDConvention(self.iNode_ID, self.ele_orientation, "i")
        else:
            self.iNode_ID_spring = self.iNode_ID
        
        if self.mat_ID_j != -1:
            self.jNode_ID_spring = OffsetNodeIDConvention(self.jNode_ID, self.ele_orientation, "j")
        else:
            self.jNode_ID_spring = self.jNode_ID
                
        # element ID
        self.element_ID = IDConvention(self.iNode_ID_spring, self.jNode_ID_spring) if ele_ID == -1 else ele_ID
 
        # Data storage for loading/saving
        self.UpdateStoredData()
 
 

ShowInfo()

def ShowInfo	(		self,
			plot = False,
			block = False
	)

Implementation of the homonym abstract method.

See parent class DataManagement for detailed information.

Parameters

plot	(bool, optional): Option to show the plot of the material model. Defaults to False.
block	(bool, optional): Option to wait the user command 'plt.show()' (avoiding the stop of the program everytime that a plot should pop up). Defaults to False.

Definition at line 771 of file MemberModel.py.

    def ShowInfo(self, plot = False, block = False):
        """
        Implementation of the homonym abstract method.
        See parent class DataManagement for detailed information.
        
        @param plot (bool, optional): Option to show the plot of the material model. Defaults to False.
        @param block (bool, optional): Option to wait the user command 'plt.show()' (avoiding the stop of the program everytime that a plot should pop up). Defaults to False.
        """
        print("")
        print("Requested info for SpringBasedElement member model, ID = {}".format(self.element_ID))
        print("Section associated {} ".format(self.section_name_tag))
        print("Material model of the spring i, ID = {}".format(self.mat_ID_i))
        print("Material model of the spring j, ID = {}".format(self.mat_ID_j))
        print("Area A = {} mm2".format(self.A/mm2_unit))
        print("Young modulus E = {} GPa".format(self.E/GPa_unit))
        print("n modified moment of inertia Iy_mod = {} mm4".format(self.Iy_mod/mm4_unit))
        print("Geometric transformation = {}".format(self.geo_transf_ID))
        print("")
 
        if plot:
            if self.Initialized:
                plot_member(self.element_array, "SpringBased Element, ID = {}".format(self.element_ID))
                if block:
                    plt.show()
            else:
                print("The SpringBasedElement is not initialized (node and elements not created), ID = {}".format(self.element_ID))
 
 

UpdateStoredData()

def UpdateStoredData

(

self

)

Implementation of the homonym abstract method.

See parent class DataManagement for detailed information.

Definition at line 749 of file MemberModel.py.

    def UpdateStoredData(self):
        """
        Implementation of the homonym abstract method.
        See parent class DataManagement for detailed information.
        """
        self.data = [["INFO_TYPE", "SpringBasedElement"], # Tag for differentiating different data
            ["element_ID", self.element_ID],
            ["section_name_tag", self.section_name_tag],
            ["A", self.A],
            ["E", self.E],
            ["Iy_mod", self.Iy_mod],
            ["iNode_ID", self.iNode_ID],
            ["iNode_ID_spring", self.iNode_ID_spring],
            ["mat_ID_i", self.mat_ID_i],
            ["jNode_ID", self.jNode_ID],
            ["jNode_ID_spring", self.jNode_ID_spring],
            ["mat_ID_j", self.mat_ID_j],
            ["ele_orientation", self.ele_orientation],
            ["tranf_ID", self.geo_transf_ID],
            ["Initialized", self.Initialized]]
 
 

Member Data Documentation

A

A

Definition at line 705 of file MemberModel.py.

data

data

Definition at line 754 of file MemberModel.py.

E

E

Definition at line 706 of file MemberModel.py.

ele_orientation

ele_orientation

Definition at line 728 of file MemberModel.py.

element_array

element_array

Definition at line 803 of file MemberModel.py.

element_ID

element_ID

Definition at line 742 of file MemberModel.py.

geo_transf_ID

geo_transf_ID

Definition at line 708 of file MemberModel.py.

Initialized

Initialized

Definition at line 714 of file MemberModel.py.

iNode_ID

iNode_ID

Definition at line 703 of file MemberModel.py.

iNode_ID_spring

iNode_ID_spring

Definition at line 732 of file MemberModel.py.

iSpring_ID

iSpring_ID

Definition at line 807 of file MemberModel.py.

Iy_mod

Iy_mod

Definition at line 707 of file MemberModel.py.

jNode_ID

jNode_ID

Definition at line 704 of file MemberModel.py.

jNode_ID_spring

jNode_ID_spring

Definition at line 737 of file MemberModel.py.

jSpring_ID

jSpring_ID

Definition at line 813 of file MemberModel.py.

mat_ID_i

mat_ID_i

Definition at line 709 of file MemberModel.py.

mat_ID_j

mat_ID_j

Definition at line 710 of file MemberModel.py.

section_name_tag

section_name_tag

Definition at line 713 of file MemberModel.py.

---

The documentation for this class was generated from the following file:

• /media/carmine/DATA/Programmi/OpenSeesPyAssistant/MemberModel.py