Source code for abaqus.Region.Stringer

from ..BasicGeometry.Edge import Edge
from ..BasicGeometry.EdgeArray import EdgeArray
from ..Mesh.MeshEdge import MeshEdge
from ..Mesh.MeshElementArray import MeshElementArray


class Stringer:
    """The Stringer object stores information on stringer reinforcements created on entities.

    Attributes
    ----------
    elements: MeshElementArray
        A :py:class:`~abaqus.Mesh.MeshElementArray.MeshElementArray` object.
    edges: EdgeArray
        An :py:class:`~abaqus.BasicGeometry.EdgeArray.EdgeArray` object.

    Notes
    -----
    This object can be accessed by:

    .. code-block:: python

        import part
        mdb.models[name].parts[name].stringers[name]
        import assembly
        mdb.models[name].rootAssembly.allInstances[name].stringers[name]
        mdb.models[name].rootAssembly.instances[name].stringers[name]
        mdb.models[name].rootAssembly.stringers[name]

    """

    # A MeshElementArray object. 
    elements: MeshElementArray = MeshElementArray([])

    # An EdgeArray object. 
    edges: EdgeArray = EdgeArray([])

    def __init__(self, name: str, edges: tuple[Edge] = (), elementEdges: tuple[MeshEdge] = ()):
        """This method creates a stringer from a sequence of objects in a model database. At least
        one of the optional arguments needs to be specified.

        Notes
        -----
        This function can be accessed by:

        .. code-block:: python

            mdb.models[name].parts[*name*].Stringer
        
        Parameters
        ----------
        name
            A String specifying the repository key. The default value is an empty string. 
        edges
            A sequence of Edge objects specifying the edges on which stringers should be created. 
            Applicable to three and two dimensional parts. 
        elementEdges
            A sequence of MeshEdge objects specifying the mesh edges on which stringers should be 
            created. Applicable to three and two dimensional parts. 

        Returns
        -------
            A Stringer object.
        """
        pass

    def EditStringer(self, name: str, edges: tuple[Edge] = (), elementEdges: tuple[MeshEdge] = ()):
        """This method modifies underlying entities of the selected stringer. At least one of the
        optional arguments needs to be specified.

        Notes
        -----
        This function can be accessed by:

        .. code-block:: python

            mdb.models[name].parts[*name*].Stringer
        
        Parameters
        ----------
        name
            A String specifying the repository key. The default value is an empty string. 
        edges
            A sequence of Edge objects specifying the edges on which stringers should be created. 
            Applicable to three and two dimensional parts. 
        elementEdges
            A sequence of MeshEdge objects specifying the mesh edges on which stringers should be 
            created. Applicable to three and two dimensional parts. 

        Returns
        -------
            A Stringer object.
        """
        pass