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

Inheritance diagram for ForceBasedElement:

Public Member Functions
def	__init__ (self, int iNode_ID, int jNode_ID, int fiber_ID, int geo_transf_ID, new_integration_ID=-1, Ip=5, integration_type="Lobatto", max_iter=MAX_ITER_INTEGRATION, tol=TOL_INTEGRATION, 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 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, new_integration_ID, 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
	data

	element_array

	element_ID

	fiber_ID

	geo_transf_ID

	Initialized

	iNode_ID

	integration_type

	Ip

	jNode_ID

	max_iter

	new_integration_ID

	section_name_tag

	tol

Detailed Description

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

Parameters

MemberModel Parent abstract class.

Definition at line 964 of file MemberModel.py.

Constructor & Destructor Documentation

◆ init()

def __init__	(		self,
		int	iNode_ID,
		int	jNode_ID,
		int	fiber_ID,
		int	geo_transf_ID,
			new_integration_ID = `-1`,
			Ip = `5`,
			integration_type = `"Lobatto"`,
			max_iter = `MAX_ITER_INTEGRATION`,
			tol = `TOL_INTEGRATION`,
			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.
fiber_ID	(int): ID of the fiber section.
geo_transf_ID	(int): The geometric transformation (for more information, see OpenSeesPy documentation).
new_integration_ID	(int, optional): ID of the integration technique. Defaults to -1, e.g. computed in ReInit().
Ip	(int, optional): Number of integration points (min. 3). Defaults to 5.
integration_type	(str, optional): Integration type. FOr more information, see OpenSeesPy documentation. Defaults to "Lobatto".
max_iter	(int, optional): Maximal number of iteration to reach the integretion convergence. Defaults to MAX_ITER_INTEGRATION (Units).
tol	(float, optional): Tolerance for the integration convergence. Defaults to TOL_INTEGRATION (Units).
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	ID needs to be a positive integer.
NegativeValue	ID needs to be a positive integer.
NegativeValue	ID needs to be a positive integer, if different from -1.
NegativeValue	Ip needs to be a positive integer bigger than 3, if different from -1.
NegativeValue	max_iter needs to be a positive integer.
NegativeValue	tol needs to be positive.
NegativeValue	ID needs to be a positive integer, if different from -1.

Reimplemented in ForceBasedElementFibersCircRCCircShape, ForceBasedElementFibersIShapeSteelIShape, and ForceBasedElementFibersRectRCRectShape.

Definition at line 970 of file MemberModel.py.

        new_integration_ID = -1, Ip = 5, integration_type = "Lobatto", max_iter = MAX_ITER_INTEGRATION, tol = TOL_INTEGRATION, 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 fiber_ID (int): ID of the fiber section.
        @param geo_transf_ID (int): The geometric transformation (for more information, see OpenSeesPy documentation).
        @param new_integration_ID (int, optional): ID of the integration technique. Defaults to -1, e.g. computed in ReInit().
        @param Ip (int, optional): Number of integration points (min. 3). Defaults to 5.
        @param integration_type (str, optional): Integration type. FOr more information, see OpenSeesPy documentation.
            Defaults to "Lobatto".
        @param max_iter (int, optional): Maximal number of iteration to reach the integretion convergence. Defaults to MAX_ITER_INTEGRATION (Units).
        @param tol (float, optional): Tolerance for the integration convergence. Defaults to TOL_INTEGRATION (Units).
        @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: ID needs to be a positive integer.
        @exception NegativeValue: ID needs to be a positive integer.
        @exception NegativeValue: ID needs to be a positive integer, if different from -1.
        @exception NegativeValue: Ip needs to be a positive integer bigger than 3, if different from -1.
        @exception NegativeValue: max_iter needs to be a positive integer.
        @exception NegativeValue: tol needs to be positive.
        @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 fiber_ID < 1: raise NegativeValue()
        if geo_transf_ID < 1: raise NegativeValue()
        if new_integration_ID != -1 and new_integration_ID < 1: raise NegativeValue()
        if Ip != -1 and Ip < 3: raise NegativeValue()
        if max_iter < 0: raise NegativeValue()
        if tol < 0: raise NegativeValue()
        if ele_ID != -1 and ele_ID < 1: raise NegativeValue()
 
        # Arguments
        self.iNode_ID = iNode_ID
        self.jNode_ID = jNode_ID
        self.fiber_ID = fiber_ID 
        self.geo_transf_ID = geo_transf_ID
        self.Ip = Ip
        self.integration_type = integration_type
        self.max_iter = max_iter
        self.tol = tol
 
        # Initialized the parameters that are dependent from others
        self.section_name_tag = "None"
        self.Initialized = False
        self.ReInit(new_integration_ID, 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 1092 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, self.jNode_ID]]
 
        # Define integration type
        beamIntegration(self.integration_type, self.new_integration_ID, self.fiber_ID, self.Ip)
        
        # Define element
        element('forceBeamColumn', self.element_ID, self.iNode_ID, self.jNode_ID, self.geo_transf_ID, self.new_integration_ID, '-iter', self.max_iter, self.tol)
        
        # Update class
        self.Initialized = True
        self.UpdateStoredData()
 
 

◆ Record()

def Record	(		self,
		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 1109 of file MemberModel.py.

    def Record(self, 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.
        """
        super().Record(self.element_ID, name_txt, data_dir, force_rec=force_rec, def_rec=def_rec, time_rec=time_rec)
    
 

◆ 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 1117 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,
		new_integration_ID,
		ele_ID = `-1`
	)

Implementation of the homonym abstract method.

See parent class DataManagement for detailed information.

Parameters

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

Definition at line 1024 of file MemberModel.py.

    def ReInit(self, new_integration_ID, ele_ID = -1):
        """
        Implementation of the homonym abstract method.
        See parent class DataManagement for detailed information.
 
        @param new_integration_ID (int): ID of the integration technique.
        @param ele_ID (int, optional): Optional ID of the element. Defaults to -1, e.g. use IDConvention to define it.
        """
        # Precompute some members
        self.element_ID = IDConvention(self.iNode_ID, self.jNode_ID) if ele_ID == -1 else ele_ID
 
        # Arguments
        self.new_integration_ID = self.element_ID if new_integration_ID == -1 else new_integration_ID
 
        # Members
        if self.section_name_tag != "None": self.section_name_tag = self.section_name_tag + " (modified)"
        
        # 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 1066 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 ForceBasedElement member model, ID = {}".format(self.element_ID))
        print("Fiber associated, ID = {} ".format(self.fiber_ID))
        print("Integration type '{}', ID = {}".format(self.integration_type, self.new_integration_ID))
        print("Section associated {} ".format(self.section_name_tag))
        print("Number of integration points along the element Ip = {}, max iter = {}, tol = {}".format(self.Ip, self.max_iter, self.tol))
        print("Geometric transformation = {}".format(self.geo_transf_ID))
        print("")
 
        if plot:
            if self.Initialized:
                plot_member(self.element_array, "ForceBased Element, ID = {}".format(self.element_ID))
                if block:
                    plt.show()
            else:
                print("The ForceBasedElement is not initialized (element 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 1046 of file MemberModel.py.

    def UpdateStoredData(self):
        """
        Implementation of the homonym abstract method.
        See parent class DataManagement for detailed information.
        """
        self.data = [["INFO_TYPE", "ForceBasedElement"], # Tag for differentiating different data
            ["element_ID", self.element_ID],
            ["section_name_tag", self.section_name_tag],
            ["Ip", self.Ip],
            ["iNode_ID", self.iNode_ID],
            ["jNode_ID", self.jNode_ID],
            ["fiber_ID", self.fiber_ID],
            ["new_integration_ID", self.new_integration_ID],
            ["integration_type", self.integration_type],
            ["tol", self.tol],
            ["max_iter", self.max_iter],
            ["tranf_ID", self.geo_transf_ID],
            ["Initialized", self.Initialized]]
 
 

Member Data Documentation

◆ data

data

Definition at line 1051 of file MemberModel.py.

◆ element_array

element_array

Definition at line 1096 of file MemberModel.py.

◆ element_ID

element_ID

Definition at line 1033 of file MemberModel.py.

◆ fiber_ID

fiber_ID

Definition at line 1011 of file MemberModel.py.

◆ geo_transf_ID

geo_transf_ID

Definition at line 1012 of file MemberModel.py.

◆ Initialized

Initialized

Definition at line 1020 of file MemberModel.py.

◆ iNode_ID

iNode_ID

Definition at line 1009 of file MemberModel.py.

◆ integration_type

integration_type

Definition at line 1014 of file MemberModel.py.

◆ Ip

Ip

Definition at line 1013 of file MemberModel.py.

◆ jNode_ID

jNode_ID

Definition at line 1010 of file MemberModel.py.

◆ max_iter

max_iter

Definition at line 1015 of file MemberModel.py.

◆ new_integration_ID

new_integration_ID

Definition at line 1036 of file MemberModel.py.

◆ section_name_tag

section_name_tag

Definition at line 1019 of file MemberModel.py.

◆ tol

tol

Definition at line 1016 of file MemberModel.py.

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

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ CreateMember()

◆ Record()

◆ RecordNodeDef()

◆ ReInit()

◆ ShowInfo()

◆ UpdateStoredData()

Member Data Documentation

◆ data

◆ element_array

◆ element_ID

◆ fiber_ID

◆ geo_transf_ID

◆ Initialized

◆ iNode_ID

◆ integration_type

◆ Ip

◆ jNode_ID

◆ max_iter

◆ new_integration_ID

◆ section_name_tag

◆ tol

◆ init()