bluemira.structural.constants
=============================

.. py:module:: bluemira.structural.constants

.. autoapi-nested-parse::

   Constants for use in the structural module.



Attributes
----------

.. autoapisummary::

   bluemira.structural.constants.NU
   bluemira.structural.constants.SD_LIMIT
   bluemira.structural.constants.D_TOLERANCE
   bluemira.structural.constants.NEAR_ZERO
   bluemira.structural.constants.R_LARGE_DISP
   bluemira.structural.constants.GLOBAL_COORDS
   bluemira.structural.constants.N_INTERP
   bluemira.structural.constants.STRESS_COLOR
   bluemira.structural.constants.DEFLECT_COLOR


Classes
-------

.. autoapisummary::

   bluemira.structural.constants.LoadKind
   bluemira.structural.constants.SubLoadType
   bluemira.structural.constants.LoadType
   bluemira.structural.constants.DisplacementType


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

.. py:data:: NU
   :value: 0.33


.. py:data:: SD_LIMIT
   :value: 0.1


.. py:data:: D_TOLERANCE
   :value: 1e-05


.. py:data:: NEAR_ZERO

.. py:data:: R_LARGE_DISP
   :value: 100


.. py:data:: GLOBAL_COORDS

.. py:data:: N_INTERP
   :value: 7


.. py:data:: STRESS_COLOR

.. py:data:: DEFLECT_COLOR

.. py:class:: LoadKind(*args, **kwds)

   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: bluemira.structural.constants.LoadKind
      :parts: 1
      :private-bases:


   Enumeration of types of loads.


   .. py:attribute:: ELEMENT_LOAD


   .. py:attribute:: DISTRIBUTED_LOAD


   .. py:attribute:: NODE_LOAD


   .. py:method:: _missing_(value: str) -> LoadKind
      :classmethod:



.. py:class:: SubLoadType(*args, **kwds)

   Bases: :py:obj:`enum.Enum`

   .. autoapi-inheritance-diagram:: bluemira.structural.constants.SubLoadType
      :parts: 1
      :private-bases:


   Enumeration of sub load types.


   .. py:attribute:: FORCE


   .. py:attribute:: MOMENT


   .. py:attribute:: ALL


   .. py:method:: _missing_(value: str) -> SubLoadType
      :classmethod:



.. py:class:: LoadType

   Bases: :py:obj:`enum.IntEnum`

   .. autoapi-inheritance-diagram:: bluemira.structural.constants.LoadType
      :parts: 1
      :private-bases:


   Mapping of indices to load types


   .. py:attribute:: Fx
      :value: 0



   .. py:attribute:: Fy


   .. py:attribute:: Fz


   .. py:attribute:: Mx


   .. py:attribute:: My


   .. py:attribute:: Mz


   .. py:method:: _missing_(value: str) -> LoadType
      :classmethod:



   .. py:method:: vector()

      Direction vector of load



.. py:class:: DisplacementType

   Bases: :py:obj:`enum.IntEnum`

   .. autoapi-inheritance-diagram:: bluemira.structural.constants.DisplacementType
      :parts: 1
      :private-bases:


   Mapping of indices to displacement/support types


   .. py:attribute:: Dx
      :value: 0



   .. py:attribute:: Dy


   .. py:attribute:: Dz


   .. py:attribute:: Rx


   .. py:attribute:: Ry


   .. py:attribute:: Rz


   .. py:method:: _missing_(value: str) -> DisplacementType
      :classmethod: