Source code for abaqus.EngineeringFeature.NonstructuralMass

from abaqusConstants import *
from .Inertia import Inertia
from ..Region.Region import Region


class NonstructuralMass(Inertia):
    """The NonstructuralMass object defines the mass contribution from nonstructural features
    into the model. 
    The NonstructuralMass object is derived from the Inertia object. 

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

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

    .. code-block:: python

        import part
        mdb.models[name].parts[name].engineeringFeatures.inertias[name]
        import assembly
        mdb.models[name].rootAssembly.engineeringFeatures.inertias[name]

    The corresponding analysis keywords are:

    - NONSTRUCTURAL MASS

    """

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

    def __init__(self, name: str, region: Region, units: SymbolicConstant, magnitude: float,
                 distribution: SymbolicConstant = MASS_PROPORTIONAL):
        """This method creates a NonstructuralMass object.

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

        .. code-block:: python

            mdb.models[name].parts[name].engineeringFeatures.NonstructuralMass
            mdb.models[name].rootAssembly.engineeringFeatures.NonstructuralMass
        
        Parameters
        ----------
        name
            A String specifying the repository key. 
        region
            A Region object specifying the region to which the mass is applied. 
        units
            A SymbolicConstant specifying the units used to specify the nonstructural mass. Possible 
            values are TOTAL_MASS, MASS_PER_VOLUME, MASS_PER_AREA, and MASS_PER_LENGTH. 
        magnitude
            A Float specifying the mass magnitude. 
        distribution
            A SymbolicConstant specifying the distribution of the nonstructural mass. Possible 
            values are MASS_PROPORTIONAL and VOLUME_PROPORTIONAL. The default value is 
            MASS_PROPORTIONAL.The *distribution* argument applies only when *units*=TOTAL_MASS. 

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

    def setValues(self, distribution: SymbolicConstant = MASS_PROPORTIONAL):
        """This method modifies the NonstructuralMass object.
        
        Parameters
        ----------
        distribution
            A SymbolicConstant specifying the distribution of the nonstructural mass. Possible 
            values are MASS_PROPORTIONAL and VOLUME_PROPORTIONAL. The default value is 
            MASS_PROPORTIONAL.The *distribution* argument applies only when *units*=TOTAL_MASS. 
        """
        pass