pyHarm.Substructures.ABCSubstructure
====================================

.. py:module:: pyHarm.Substructures.ABCSubstructure

.. autoapi-nested-parse::

   "
   This module is responsible for the definition of the Abstract based class ABCSubstructure defining the main interfaces charateristics of a substructure in pyHarm.
   The substructure shall be responsible for creating dofs through the generation of an explicit dof list describing which dofs are being created in the system.



Classes
-------

.. autoapisummary::

   pyHarm.Substructures.ABCSubstructure.ABCSubstructure


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

.. py:class:: ABCSubstructure(nh: int | list[int], name: str, data: dict)

   Bases: :py:obj:`abc.ABC`


   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:: flag_substructure
      :value: True



   .. py:attribute:: default_data


   .. py:attribute:: nh


   .. py:attribute:: name


   .. py:attribute:: _dup_anh


   .. py:attribute:: substructure_reader


   .. py:attribute:: nnodes


   .. py:attribute:: nmodes


   .. py:attribute:: ndofs


   .. py:attribute:: dofs_matching


   .. py:attribute:: total_dofs


   .. py:attribute:: edf


   .. py:attribute:: connectors


   .. py:attribute:: kinematics


   .. py:method:: __repr__() -> str


   .. py:property:: factory_keyword
      :type: str

      :abstractmethod:


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

      :returns: factory_keyword
      :rtype: str


   .. py:method:: _add_connectors() -> dict
      :abstractmethod:


      "
      Method that adds connectors depending on the type of substructure.



   .. py:method:: _add_kinematics() -> dict
      :abstractmethod:


      "
      Method that adds kinematic conditions depending on the type of substructure.



   .. py:method:: _gen_sub_col()


   .. py:method:: _gen_harm_col()


   .. py:method:: _gen_cs_col()


   .. py:method:: _gen_nodes_col()


   .. py:method:: _gen_dofs_col()


   .. py:method:: _gen_PoM_col()


   .. py:method:: _get_explicit_df()