pyHarm.KinematicConditions.FactoryKinematic
===========================================

.. py:module:: pyHarm.KinematicConditions.FactoryKinematic

.. autoapi-nested-parse::

   Module that contains the factory of the ABCKinematic subclasses.

   .. attribute:: Kinematic_dico

      Dictionary containing ABCKinematic as values and their factory_keyword attribute as key.

      :type: dict



Attributes
----------

.. autoapisummary::

   pyHarm.KinematicConditions.FactoryKinematic.Kinematic_dico


Functions
---------

.. autoapisummary::

   pyHarm.KinematicConditions.FactoryKinematic.generateKinematic


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

.. py:data:: Kinematic_dico

   Dictionary containing ABCKinematic as values and their factory_keyword attribute as key.

   :type: dict

.. py:function:: generateKinematic(nh, nti, name, data, dict_CS: dict[str, pyHarm.CoordinateSystem.CoordinateSystem]) -> pyHarm.KinematicConditions.ABCKinematic.ABCKinematic

   Factory function that creates a ABCKinematic 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 kinematic condition.
   :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 ABCKinematic class.
   :rtype: ABCKinematic