pyHarm.Reductors.StaticReductor
===============================

.. py:module:: pyHarm.Reductors.StaticReductor


Classes
-------

.. autoapisummary::

   pyHarm.Reductors.StaticReductor.StaticReductor


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

.. py:class:: StaticReductor(data: dict, expl_dofs: pandas.DataFrame, *args)

   Bases: :py:obj:`pyHarm.Reductors.ABCReductor.ABCReductor`


   This reductor applies a provided static transformation matrix in order to reduce the system.

   Attributes :
       phi (np.ndarray): transformation matrix


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


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

      :type: str


   .. py:method:: __post_init__(*args)

      A post init method to be customized if needed when building new class.



   .. py:method:: update_reductor(xpred: numpy.ndarray, J_f: numpy.ndarray, *args) -> tuple[numpy.ndarray, numpy.ndarray, pandas.DataFrame]

      Does nothing as the transformation is taken as static.

      :returns: same displacement vector given as input after passing through the reductor
                np.ndarray: same jacobian matrix given as input after passing through the reductor
                pd.DataFrame: same explicit dof DataFrame after passing through the reductor
      :rtype: np.ndarray



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

      Inverse transforms the displacement vector.

      :param q: vector of transformed displacement.
      :type q: np.ndarray

      :returns: vector of original displacement.
      :rtype: np.ndarray



   .. py:method:: reduce_vector_x(x: numpy.ndarray) -> numpy.ndarray

      Transforms the displacement vector.

      :param x: vector of displacement.
      :type x: np.ndarray

      :returns: vector of transformed displacement.
      :rtype: np.ndarray



   .. py:method:: reduce_vector(R: numpy.ndarray) -> numpy.ndarray

      Transforms the residual vector.

      :param R: vector of residuals.
      :type R: np.ndarray

      :returns: vector of transformed residuals.
      :rtype: np.ndarray



   .. py:method:: reduce_matrix(dJdxom: numpy.ndarray, *args) -> numpy.ndarray

      From original matrix, performs the transformation to get the transformed matrix.

      :param dJdxom: full size jacobian matrix with respect to displacement and angular frequency.
      :type dJdxom: np.ndarray

      :returns: transformed jacobian matrix with respect to displacement and angular frequency.
      :rtype: np.ndarray



   .. py:method:: _get_output_expl_dofs()

      This is not well implemented => this has to be redone !!.

      :returns: reduced explicit dof DataFrame after passing through the reducer.
      :rtype: pd.DataFrame