Source code for abaqus.Interaction.FluidExchange

from abaqusConstants import *
from .Interaction import Interaction


class FluidExchange(Interaction):
    """The FluidExchange object is used to define fluid exchange between two fluid cavities or
    between a fluid cavity and its environment. 
    The FluidExchange object is derived from the Interaction object. 

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

    .. code-block:: python

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

    The corresponding analysis keywords are:

    - FLUID EXCHANGE

    """

    def __init__(self, name: str, createStepName: str, firstCavity: str, interactionProperty: str,
                 definition: SymbolicConstant = TO_ENVIRONMENT, secondCavity: str = '',
                 exchangeArea: float = 1):
        """This method creates an FluidExchange object.

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

        .. code-block:: python

            mdb.models[name].FluidExchange
        
        Parameters
        ----------
        name
            A String specifying the repository key. 
        createStepName
            A String specifying the name of the step in which the FluidExchange object is created. 
        firstCavity
            A String specifying the first FluidCavity object associated with this interaction. This 
            will be the only cavity specified if *definition*=TO_ENVIRONMENT. 
        interactionProperty
            A String specifying the FluidExchangeProperty object associated with this interaction. 
        definition
            A SymbolicConstant specifying the type of fluid exchange to be defined. Possible values 
            are TO_ENVIRONMENT and BETWEEN_CAVITIES. The default value is TO_ENVIRONMENT. 
        secondCavity
            A String specifying the second FluidCavity object associated with this interaction. This 
            argument is applicable only when *definition*=BETWEEN_CAVITIES. 
        exchangeArea
            A Float specifying the effective exchange area. The default value is 1.0. 

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

    def setValues(self, definition: SymbolicConstant = TO_ENVIRONMENT, secondCavity: str = '',
                  exchangeArea: float = 1):
        """This method modifies the FluidExchange object.
        
        Parameters
        ----------
        definition
            A SymbolicConstant specifying the type of fluid exchange to be defined. Possible values 
            are TO_ENVIRONMENT and BETWEEN_CAVITIES. The default value is TO_ENVIRONMENT. 
        secondCavity
            A String specifying the second FluidCavity object associated with this interaction. This 
            argument is applicable only when *definition*=BETWEEN_CAVITIES. 
        exchangeArea
            A Float specifying the effective exchange area. The default value is 1.0. 
        """
        pass