Source code for abaqus.Constraint.RigidBody

from abaqusConstants import *
from .Constraint import Constraint
from ..Region.Region import Region


class RigidBody(Constraint):
    """The RigidBody object constrains all the degrees of freedom on the specified regions to
    the degree of freedom of its associated reference point. 
    The RigidBody object is derived from the ConstrainedSketchConstraint object.

    Attributes
    ----------
    suppressed: Boolean
        A Boolean specifying whether the constraint is suppressed or not. The default value is
        OFF.

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

    .. code-block:: python

        import interaction
        mdb.models[name].constraints[name]

    The corresponding analysis keywords are:

    - RIGID BODY

    """

    # A Boolean specifying whether the constraint is suppressed or not. The default value is 
    # OFF. 
    suppressed: Boolean = OFF

    def __init__(self, name: str, refPointRegion: Region, bodyRegion: str = None, tieRegion: str = None,
                 pinRegion: str = None, surfaceRegion: str = None, refPointAtCOM: Boolean = OFF,
                 isothermal: Boolean = OFF):
        """This method creates a RigidBody object.

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

        .. code-block:: python

            mdb.models[name].RigidBody
        
        Parameters
        ----------
        name
            A String specifying the constraint repository key. 
        refPointRegion
            A Region object specifying the reference point. 
        bodyRegion
            None or a Region object specifying the elements constrained to the movement of the 
            reference point. The default value is None. 
        tieRegion
            None or a Region object specifying the nodes tied to the movement of the reference 
            point. The default value is None. 
        pinRegion
            None or a Region object specifying the nodes pinned to the movement of the reference 
            point. The default value is None. 
        surfaceRegion
            None or a Region object specifying the analytic surface constrained to the movement of 
            the reference point. The default value is None. 
        refPointAtCOM
            A Boolean specifying whether the analysis product should recompute the reference point 
            position to be at the center of mass. The default value is OFF. 
        isothermal
            A Boolean specifying whether the temperature degree of freedom should be constrained. 
            The default value is OFF. 

        Returns
        -------
            A RigidBody object.
        """
        super().__init__()
        pass

    def setValues(self, bodyRegion: str = None, tieRegion: str = None, pinRegion: str = None,
                  surfaceRegion: str = None, refPointAtCOM: Boolean = OFF, isothermal: Boolean = OFF):
        """This method modifies the RigidBody object.
        
        Parameters
        ----------
        bodyRegion
            None or a Region object specifying the elements constrained to the movement of the 
            reference point. The default value is None. 
        tieRegion
            None or a Region object specifying the nodes tied to the movement of the reference 
            point. The default value is None. 
        pinRegion
            None or a Region object specifying the nodes pinned to the movement of the reference 
            point. The default value is None. 
        surfaceRegion
            None or a Region object specifying the analytic surface constrained to the movement of 
            the reference point. The default value is None. 
        refPointAtCOM
            A Boolean specifying whether the analysis product should recompute the reference point 
            position to be at the center of mass. The default value is OFF. 
        isothermal
            A Boolean specifying whether the temperature degree of freedom should be constrained. 
            The default value is OFF. 
        """
        pass