from abaqusConstants import *


class SoretEffect:
    r"""The SoretEffect object defines temperature gradient driven mass diffusion.

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

    .. code-block:: python

        import material
        mdb.models[name].materials[name].diffusivity.soretEffect
        import odbMaterial
        session.odbs[name].materials[name].diffusivity.soretEffect

    The table data for this object are:

    - Soret effect factor, :math:`\kappa_s`.
    - Concentration.
    - Temperature, if the data depend on temperature.
    - Value of the first field variable, if the data depend on field variables.
    - Value of the second field variable.
    - Etc.

    The corresponding analysis keywords are:

    - KAPPA
    """

    def __init__(
        self, table: tuple, temperatureDependency: Boolean = OFF, dependencies: int = 0
    ):
        """This method creates a SoretEffect object.

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

        .. code-block:: python

            mdb.models[name].materials[name].diffusivity.SoretEffect
            session.odbs[name].materials[name].diffusivity.SoretEffect

        Parameters
        ----------
        table
            A sequence of sequences of Floats specifying the items described below.
        temperatureDependency
            A Boolean specifying whether the data depend on temperature. The default value is OFF.
        dependencies
            An Int specifying the number of field variable dependencies. The default value is 0.

        Returns
        -------
        SoretEffect
            A :py:class:`~abaqus.Material.Others.MassDiffusion.SoretEffect.SoretEffect` object.

        Raises
        ------
        RangeError
        """
        pass

    def setValues(self, *args, **kwargs):
        """This method modifies the SoretEffect object.

        Raises
        ------
        RangeError
        """
        pass
