pyHarm.Elements.NodeToNodeElements.GeneralOrderElement
======================================================

.. py:module:: pyHarm.Elements.NodeToNodeElements.GeneralOrderElement


Classes
-------

.. autoapisummary::

   pyHarm.Elements.NodeToNodeElements.GeneralOrderElement.GeneralOrderElement


Functions
---------

.. autoapisummary::

   pyHarm.Elements.NodeToNodeElements.GeneralOrderElement.GOEResidual_noAFT
   pyHarm.Elements.NodeToNodeElements.GeneralOrderElement.GOEJacobian_noAFT
   pyHarm.Elements.NodeToNodeElements.GeneralOrderElement.GOEResidual_AFT
   pyHarm.Elements.NodeToNodeElements.GeneralOrderElement.GOEJacobian_AFT


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

.. py:function:: GOEResidual_noAFT(x, om, Pdir, Pslave, Pmaster, dto, xo, nabo, k)

.. py:function:: GOEJacobian_noAFT(x, om, Pdir, Pslave, Pmaster, dto, xo, nabo, k)

.. py:function:: GOEResidual_AFT(x, om, Pdir, Pslave, Pmaster, dto, xo, nabo, k, DFT, DTF)

.. py:function:: GOEJacobian_AFT(x, om, Pdir, Pslave, Pmaster, dto, xo, nabo, k, DFT, DTF)

.. py:class:: GeneralOrderElement(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 element, it can apply any required polynomial link in displacement and in derivative order.

   .. attribute:: dto

      order of the time derivative.

      :type: int

   .. attribute:: xo

      order of the power to apply to the displacement.

      :type: int

   .. attribute:: k

      linear factor to apply.

      :type: float


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


      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:: _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:: k

         modified linear coefficient to apply 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 x: full displacement vector.
      :type x: 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 x: full displacement vector.
      :type x: 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