pyHarm.KinematicConditions.GODisplacement
=========================================

.. py:module:: pyHarm.KinematicConditions.GODisplacement


Classes
-------

.. autoapisummary::

   pyHarm.KinematicConditions.GODisplacement.GODisplacement


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

.. py:class:: GODisplacement(nh: int, nti: int, name: str, data: dict, CS: pyHarm.CoordinateSystem.CoordinateSystem)

   Bases: :py:obj:`pyHarm.KinematicConditions.ABCKinematic.ABCKinematic`


   Kinematic condition that imposes a displacement or any time derivative of displacement to a specific dof.

   .. attribute:: amp

      amplitude to impose.

      :type: float

   .. attribute:: ho

      harmonic loaded.

      :type: int

   .. attribute:: dto

      order of the time derivative.

      :type: int

   .. attribute:: phi

      phase lag to impose on the harmonic (0 = pure cosinus loading).

      :type: float


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


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

      :type: str


   .. py:attribute:: default

      dictionary containing the default parameters of the kinematic condition

      :type: dict


   .. py:method:: __post_init__()


   .. py:method:: _loadingdofs()


   .. py:method:: complete_x(x)

      Returns a vector x_add of same size of x that completes the vector of displacement x = x + x_add such that the kinematic condition is verified.

      :param x: displacement vector.
      :type x: np.ndarray
      :param om: angular frequency.
      :type om: float

      :returns: vector of displacement to add to the displacement vetor in order to impose the kinematic condition.
      :rtype: (np.ndarray)



   .. py:method:: dxbdxom(xg)

      Computes the derivative of the kinematicaly constrained dofs with respect to the displacement.

      :param xg: full size displacement vector.
      :type xg: np.ndarray

      :returns: vector of displacement contributions to add to the displacement vetor in order to impose the kinematic condition.
      :rtype: (np.ndarray)



   .. py:method:: complete_R(R, x)

      Computes the transfer of residual of the kinematicaly constrained dofs with respect to the displacement.

      :param R: residual vector.
      :type R: np.ndarray
      :param x: displacement vector.
      :type x: np.ndarray

      :returns: vector of residual contributions to add to the residual vetor in order to impose the kinematic condition.
      :rtype: (np.ndarray)



   .. py:method:: complete_J(Jx, Jom, x)

      Computes the transfer of jacobian of the kinematicaly constrained dofs with respect to the displacement.

      :param Jx: jacobian matrix with respect to displacement.
      :type Jx: np.ndarray
      :param Jom: jacobian matrix with respect to angular frequency.
      :type Jom: np.ndarray
      :param x: displacement vector.
      :type x: np.ndarray

      :returns: tuple containing the jacobians contributions to add to the jacobians in order to impose the kinematic condition.
      :rtype: (tuple[np.ndarray,np.ndarray])



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

      Using adim parameters, modifies the kinematic conditions accordingly.

      :param lc: characteristic length.
      :type lc: float
      :param wc: characteristic angular frequency.
      :type wc: float