pyHarm.Elements.FactoryElements
===============================

.. py:module:: pyHarm.Elements.FactoryElements

.. autoapi-nested-parse::

   This module is the factory of the ABCElement excluding the Substructure kind.

   .. attribute:: L_Elem

      List of available ABCElement subclasses available for creation.

      :type: list[ABCElement]

   .. attribute:: ElementDictionary

      Dictionary of available ABCElement as values and their factory_keyword as key.

      :type: dict[str, ABCElement]



Attributes
----------

.. autoapisummary::

   pyHarm.Elements.FactoryElements.L_Elem
   pyHarm.Elements.FactoryElements.ElementDictionary


Functions
---------

.. autoapisummary::

   pyHarm.Elements.FactoryElements.generateElement


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

.. py:data:: L_Elem

   List of available ABCElement subclasses available for creation.

   :type: list[ABCElement]

.. py:data:: ElementDictionary

   Dictionary of available ABCElement as values and their factory_keyword as key.

   :type: dict[str, ABCElement]

.. py:function:: generateElement(nh, nti, name, data, dict_CS: dict[str, pyHarm.CoordinateSystem.CoordinateSystem]) -> pyHarm.Elements.ABCElement.ABCElement

   Factory function that creates an ABCElement object.

   :param nh: number of harmonics.
   :type nh: int
   :param nti: number of time steps.
   :type nti: int
   :param name: type of kinematic condition to instantiate.
   :type name: str
   :param data: dictionary containing the definition of the element.
   :type data: dict
   :param dict_CS: dictionary containing all the local and global coordinate systems.
   :type dict_CS: dict[str,CoordinateSystem]

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