pyHarm.Substructures.FactorySubstructure
========================================

.. py:module:: pyHarm.Substructures.FactorySubstructure

.. autoapi-nested-parse::

   "
   This module is responsible for the creation of the ABCSubstructure instances used in pyHarm.



Attributes
----------

.. autoapisummary::

   pyHarm.Substructures.FactorySubstructure.SubstructureDico


Functions
---------

.. autoapisummary::

   pyHarm.Substructures.FactorySubstructure.generate_substructure


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

.. py:data:: SubstructureDico

   List of available ABCSubstructure subclasses available for creation.

   :type: dict[str,ABCSubstructure]

.. py:function:: generate_substructure(nh, name, data) -> pyHarm.Substructures.ABCSubstructure.ABCSubstructure

   Factory function that creates an ABCSubstructure object.

   :param nh: number of harmonics.
   :type nh: int
   :param name: type of substructure to instantiate.
   :type name: str
   :param data: dictionary containing the definition of the substructure.
   :type data: dict

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