pyHarm.Elements.NodeToNodeElements.DLFTElements.DLFT3D
======================================================

.. py:module:: pyHarm.Elements.NodeToNodeElements.DLFTElements.DLFT3D


Attributes
----------

.. autoapisummary::

   pyHarm.Elements.NodeToNodeElements.DLFTElements.DLFT3D.DLFTFriction3DJacobian_jax


Classes
-------

.. autoapisummary::

   pyHarm.Elements.NodeToNodeElements.DLFTElements.DLFT3D.DLFT3D


Functions
---------

.. autoapisummary::

   pyHarm.Elements.NodeToNodeElements.DLFTElements.DLFT3D.DLFTFriction3DResidual_jax


Module Contents
---------------

.. py:function:: DLFTFriction3DResidual_jax(x, om, Rlin, nbSub, Pdir, Pslave, Pmaster, mu, N0, g, eps, DFT, DTF)

   :meta private:


.. py:data:: DLFTFriction3DJacobian_jax
   :type:  Callable
   :value: None


   :meta private:

.. py:class:: DLFT3D(nh: int | list[int], nti: int, name: str, data: dict, CS: pyHarm.CoordinateSystem.CoordinateSystem, dynop: Optional[dict[str, numpy.ndarray]] = None)

   Bases: :py:obj:`pyHarm.Elements.NodeToNodeElements.DLFTElements.DLFTElement.DLFTElement`


   This element is a combination of the unilateral DFLT gap element and the DLFT friction element in the perpendicular directions.

   .. attribute:: N0

      normal force applied at contact.

      :type: float

   .. attribute:: g

      gap value.

      :type: float

   .. attribute:: eps

      penalty parameter of the DLFT method.

      :type: foat

   .. attribute:: mu

      friction coefficient.

      :type: foat


   .. py:attribute:: factory_keyword
      :type:  str
      :value: 'DLFT3D'


      keyword that is used to call the creation of this class in the system factory.

      :type: str


   .. py:method:: __post_init__()


   .. py:method:: adim(lc, wc)

      Modifies the element properties according to the characteristic length and angular frequency.

      .. attribute:: eps

         modified penalty coefficient to apply according to the characteristic parameters.

         :type: float

      .. attribute:: g

         modified gap value according to the characteristic parameters.

         :type: float

      .. attribute:: flag_adim

         True if equations are to be adimensionalized

         :type: bool



   .. py:method:: evalResidual(xg, om, Rglin=None)

      Computes the residual.

      :param xg: full displacement vector.
      :type xg: np.ndarray
      :param om: angular frequency value.
      :type om: float
      :param Rglin: Residual vector of all the linear element contributions.
      :type Rglin: np.ndarray

      :returns: residual vector.
      :rtype: np.ndarray



   .. py:method:: _evalJaco_jax(xg, om, Rglin=None)


   .. py:method:: evalJacobian(xg, om, Rglin=None, dJgdxlin=None, dJgdomlin=None)

      Computes the jacobians.

      :param xg: full displacement vector.
      :type xg: np.ndarray
      :param om: angular frequency value.
      :type om: float
      :param Rglin: Residual vector of all the linear element contributions.
      :type Rglin: np.ndarray
      :param dJgdxlin: Jacobian with respect to displacement of all the linear element contributions.
      :type dJgdxlin: np.ndarray
      :param dJgdomlin: Jacobian with respect to angular frequency of all the linear element contributions.
      :type dJgdomlin: np.ndarray

      :returns: Jacobian with respect to displacement.
                np.ndarray: Jacobian with respect to angular frequency.
      :rtype: np.ndarray