pyHarm.Reductors.FactoryReductors
=================================

.. py:module:: pyHarm.Reductors.FactoryReductors

.. autoapi-nested-parse::

   Module that contains the factory of reducers.

   .. attribute:: Reductor_dico

      Dictionary containing available ABCReductors as values and their factoryu keyword as key.

      :type: dict



Attributes
----------

.. autoapisummary::

   pyHarm.Reductors.FactoryReductors.Reductor_dico


Functions
---------

.. autoapisummary::

   pyHarm.Reductors.FactoryReductors.generateReductor


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

.. py:data:: Reductor_dico

   Dictionary containing availabe ABCReductors as values and their factoryu keyword as key.

   :type: dict

.. py:function:: generateReductor(data: dict, expl_dofs: pandas.DataFrame) -> pyHarm.Reductors.ABCReductor.ABCReductor

   Factory function that creates a ABCReductor object.

   :param expl_dofs: explicit dofs DataFrame built by the ABCSystem.
   :type expl_dofs: pd.DataFrame
   :param data: dictionary containing the inputs that are needed to create a system.
   :type data: dict

   :returns: Instance of the required ABCReductor class.
   :rtype: ABCReductor