pyHarm.CoordinateSystem
=======================

.. py:module:: pyHarm.CoordinateSystem


Classes
-------

.. autoapisummary::

   pyHarm.CoordinateSystem.CoordinateSystem
   pyHarm.CoordinateSystem.GlobalCoordinateSystem


Functions
---------

.. autoapisummary::

   pyHarm.CoordinateSystem.generateCoordinateSystem


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

.. py:function:: generateCoordinateSystem(dirs: list[list[float]])

   Generates a CoordinateSystem object based on the provided directions.

   :param dirs: A list of lists containing the directions relative to the global
                coordinate system.
   :type dirs: list[list[float]]

   :returns: A CoordinateSystem object.
   :rtype: CoordinateSystem


.. py:class:: CoordinateSystem(dirs: list[list[float]])

   Class that represents a coordinate system. It allows for generating local coordinate systems
   to be attached to elements or substructures and transfering their residuals and Jacobians
   to the global coordinate system.

   :param dirs: A list of lists containing the directions relative to the global
                coordinate system.
   :type dirs: list[list[float]]


   .. py:attribute:: dirs


   .. py:attribute:: n_dirs


   .. py:attribute:: n_component


   .. py:method:: checkOrthonormal()

      Checks if the provided coordinate system is orthonormal.

      :raises ValueError: If the coordinate system is not orthonormal.



   .. py:method:: getTM(nh: int, component: list[int]) -> numpy.ndarray

      Generates a transform matrix of size (ncompo, ncompo, n_dirs).

      :param nh: Number of harmonics.
      :type nh: int
      :param component: The components of the transform matrix.
      :type component: list[int]

      :returns: The generated transform matrix.
      :rtype: np.ndarray



.. py:class:: GlobalCoordinateSystem(ndirs: int)

   Bases: :py:obj:`CoordinateSystem`


   Subclass of CoordinateSystem that allows defining global coordinate systems.
   The initialization is modified for ease of instantiation.

   :param ndirs: The number of directions in the global coordinate system.
   :type ndirs: int


   .. py:attribute:: dirs


   .. py:attribute:: n_dirs


   .. py:attribute:: n_component