pyHarm.Systems.System
=====================

.. py:module:: pyHarm.Systems.System


Classes
-------

.. autoapisummary::

   pyHarm.Systems.System.System


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

.. py:class:: System(idata: dict, logger: Optional[logging.Logger] = None)

   Bases: :py:obj:`pyHarm.Systems.ABCSystem.ABCSystem`


   Subclass of ABCSystem that is in charge of assembling the residual and jacobians contributions coming from the ABCElements.



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


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

      :type: str


   .. py:method:: Residual(q: numpy.ndarray) -> numpy.ndarray

      Method that computes the residual vector of the whole system when given a reduced size displacement vector.

      :param q: reduced size displacement vector (no kinematic conditions).
      :type q: np.ndarray

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



   .. py:method:: Jacobian(q: numpy.ndarray) -> tuple[numpy.ndarray]

      Method that computes the jacobian matrices of the whole system when given a reduced size displacement vector.

      :param q: reduced size displacement vector (no kinematic conditions).
      :type q: np.ndarray

      :returns: reduced size jacobian matrices.
      :rtype: tuple(np.ndarray)