pyHarm.Substructures.OnlyDofs
=============================

.. py:module:: pyHarm.Substructures.OnlyDofs


Classes
-------

.. autoapisummary::

   pyHarm.Substructures.OnlyDofs.OnlyDofs


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

.. py:class:: OnlyDofs(nh: int, name: str, data: dict)

   Bases: :py:obj:`pyHarm.Substructures.ABCSubstructure.ABCSubstructure`


   This class defines a substructure. Its main responsability is to create dofs and put them in an explicit pandas DataFrame.

   :param nh: number of harmonics.
   :type nh: int
   :param nti: number of time steps.
   :type nti: int
   :param name: name given to the kinematic condition.
   :type name: str
   :param data: dictionary containing all the definition information of the substructure.
   :type data: dict

   .. attribute:: nh

      number of harmonics.

      :type: int

   .. attribute:: name

      name of the substructure.

      :type: int

   .. attribute:: nnodes

      number of nodes.

      :type: int

   .. attribute:: nmodes

      number of modes.

      :type: int

   .. attribute:: ndofs

      number of dofs per node.

      :type: int

   .. attribute:: edf

      DataFrame describing the created dofs.

      :type: pd.DataFrame

   .. attribute:: connectors

      dictionary containing the added Elements to the system.

      :type: dict

   .. attribute:: kinematics

      dictionary containing the added Kinematic Conditions to the system.

      :type: dict


   .. py:attribute:: factory_keyword
      :value: 'onlydofs'


      "
      Property defining the factory_keyword to be used for instantiation of daughter class.

      :returns: factory_keyword
      :rtype: str


   .. py:method:: _add_connectors(data: dict)

      "
      Method that adds no connectors.

      Returns :
          dict: empty dictionary



   .. py:method:: _add_kinematics(data: dict)

      "
      Method that adds no kinematic conditions.

      Returns :
          dict: empty dictionary