pyHarm.Elements.NodeToNodeElements.GeneralOrderForcing
======================================================

.. py:module:: pyHarm.Elements.NodeToNodeElements.GeneralOrderForcing


Classes
-------

.. autoapisummary::

   pyHarm.Elements.NodeToNodeElements.GeneralOrderForcing.GeneralOrderForcing


Functions
---------

.. autoapisummary::

   pyHarm.Elements.NodeToNodeElements.GeneralOrderForcing.GOFResidual
   pyHarm.Elements.NodeToNodeElements.GeneralOrderForcing.GOFJacobian


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

.. py:function:: GOFResidual(x, om, loadvec, Pdir, Pslave, dto, nabo, amp)

.. py:function:: GOFJacobian(x, om, loadvec, Pdir, Pslave, dto, nabo, amp)

.. py:class:: GeneralOrderForcing(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.NodeToNodeElement.NodeToNodeElement`


   This element is the general polynomial external forcing.

   A forcing is an element that cannot be applied in between substructures (only considers the first entry in "connect" keyword).

   .. attribute:: dto

      order of the time derivative.

      :type: int

   .. attribute:: ho

      order of the harmonic where the forcing is applied.

      :type: int

   .. attribute:: phi

      phase lag to apply between the cosine and sine term (0 = pure cosinus forcing).

      :type: float

   .. attribute:: amp

      amplitude of the forcing.

      :type: float


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


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

      :type: str


   .. py:method:: __post_init__()


   .. py:method:: __flag_update__()


   .. py:method:: generateIndices(expl_dofs: pandas.DataFrame)

      From the explicit dof DataFrame, generates the index of dofs concerned by the connector.

      :param expl_dofs: explicit dof DataFrame from the studied system.
      :type expl_dofs: pd.DataFrame

      .. attribute:: indices

         index of the dofs that the connector needs.

         :type: np.ndarray

      .. attribute:: Pdir

         a slice of first dimension is a transformation matrix to a direction in local coordinate system.

         :type: np.ndarray

      .. attribute:: Pslave

         selection array that selects the slave dofs of the connector.

         :type: np.ndarray

      .. attribute:: Pmaster

         selection array that selects the master dofs of the connector.

         :type: np.ndarray



   .. py:method:: _loadingdofs(expl_dofs: pandas.DataFrame)


   .. py:method:: _evalResidual(x, om)


   .. py:method:: _evalJacobian(x, om)


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

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

      .. attribute:: amp

         modified amplitude according to the characteristic parameters.

         :type: float

      .. attribute:: flag_adim

         True if equations are to be adimensionalized

         :type: bool



   .. py:method:: evalResidual(xg, om)

      Computes the residual.

      :param xg: full displacement vector.
      :type xg: np.ndarray
      :param om: angular frequency value.
      :type om: float

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



   .. py:method:: evalJacobian(xg, om)

      Computes the jacobians.

      :param xg: full displacement vector.
      :type xg: np.ndarray
      :param om: angular frequency value.
      :type om: float

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