:class:`RACoupledWall`
======================


.. py:class:: ansys.rocky.app.ra_coupled_wall.RACoupledWall

   Bases: :py:obj:`ansys.rocky.app.ra_base_geometry.RABaseGeometry`, :py:obj:`ansys.rocky.app.ra_addins.ElementWithAddins`, :py:obj:`ansys.rocky.app.motion._with_movement_mixin._WithMovementMixin`


   
   Rocky API Geometry model.
















   ..
       !! processed by numpydoc !!




.. py:currentmodule:: RACoupledWall

Overview
--------

.. tab-set::


   .. tab-item:: Constructors

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~GetWrappedClass`
            - 
          * - :py:attr:`~GetClassName`
            - 


   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~HasMotionFrame`
            - Whether the boundary is linked to a motion frame.
          * - :py:attr:`~GetDisableTime`
            - Get the value of "Disable Time".
          * - :py:attr:`~SetDisableTime`
            - Set the value of "Disable Time".
          * - :py:attr:`~GetEnableTime`
            - Get the value of "Enable Time".
          * - :py:attr:`~SetEnableTime`
            - Set the value of "Enable Time".
          * - :py:attr:`~GetName`
            - Get the value of "Name".
          * - :py:attr:`~SetName`
            - Set the value of "Name".
          * - :py:attr:`~GetMaterial`
            - Get the "Material".
          * - :py:attr:`~SetMaterial`
            - Set the "Material".
          * - :py:attr:`~GetAvailableMaterials`
            - Get all available Materials.








Import detail
-------------

.. code-block:: python

    from ansys.rocky.app.ra_coupled_wall import RACoupledWall



Method detail
-------------

.. py:method:: GetWrappedClass() -> type[object]
   :classmethod:


.. py:method:: GetClassName() -> str
   :classmethod:


.. py:method:: HasMotionFrame() -> bool

   
   Whether the boundary is linked to a motion frame.

   :return:
       True if boundary is linked to a motion frame False otherwise















   ..
       !! processed by numpydoc !!

.. py:method:: GetDisableTime(unit: str | None = None) -> float

   
   Get the value of "Disable Time".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "s".















   ..
       !! processed by numpydoc !!

.. py:method:: SetDisableTime(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Disable Time".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "s".















   ..
       !! processed by numpydoc !!

.. py:method:: GetEnableTime(unit: str | None = None) -> float

   
   Get the value of "Enable Time".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "s".















   ..
       !! processed by numpydoc !!

.. py:method:: SetEnableTime(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Enable Time".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "s".















   ..
       !! processed by numpydoc !!

.. py:method:: GetName() -> str

   
   Get the value of "Name".
















   ..
       !! processed by numpydoc !!

.. py:method:: SetName(value: str) -> None

   
   Set the value of "Name".

   :param value:
       The value to set.















   ..
       !! processed by numpydoc !!

.. py:method:: GetMaterial()

   
   Get the "Material".

   :rtype: :class:`RASolidMaterial`















   ..
       !! processed by numpydoc !!

.. py:method:: SetMaterial(value) -> None

   
   Set the "Material".

   :param unicode, :class:`RASolidMaterial` value:
       Either the API object wrapping the desired entity or its name.















   ..
       !! processed by numpydoc !!

.. py:method:: GetAvailableMaterials()

   
   Get all available Materials.

   :rtype: List[:class:`RASolidMaterial`]
       A list of :class:`RASolidMaterial`.















   ..
       !! processed by numpydoc !!