pyfebiopt.xplt.enums
====================

.. py:module:: pyfebiopt.xplt.enums

.. autoapi-nested-parse::

   FEBio PLT-related enums for data types and tags.



Classes
-------

.. autoapisummary::

   pyfebiopt.xplt.enums.FEDataType
   pyfebiopt.xplt.enums.FEDataDim
   pyfebiopt.xplt.enums.Storage_Fmt
   pyfebiopt.xplt.enums.Elem_Type
   pyfebiopt.xplt.enums.nodesPerElementClass
   pyfebiopt.xplt.enums.tags


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

.. py:class:: FEDataType

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


   Enumerate the storage formats for FEBio result data.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: FLOAT
      :value: 0



   .. py:attribute:: VEC3F


   .. py:attribute:: MAT3FS


   .. py:attribute:: MAT3FD


   .. py:attribute:: TENS4FS


   .. py:attribute:: MAT3F


.. py:class:: FEDataDim

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


   Map FEBio data types to their component counts.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: FLOAT
      :value: 1



   .. py:attribute:: VEC3F
      :value: 3



   .. py:attribute:: MAT3FS
      :value: 6



   .. py:attribute:: MAT3FD
      :value: 3



   .. py:attribute:: TENS4FS
      :value: 21



   .. py:attribute:: MAT3F
      :value: 9



.. py:class:: Storage_Fmt

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


   Identify the kind of PLT storage block.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: FMT_NODE
      :value: 0



   .. py:attribute:: FMT_ITEM


   .. py:attribute:: FMT_MULT


   .. py:attribute:: FMT_REGION


   .. py:attribute:: FMT_MATPOINTS


.. py:class:: Elem_Type

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


   Enumerate FEBio element type identifiers.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: ELEM_HEX
      :value: 0



   .. py:attribute:: ELEM_PENTA


   .. py:attribute:: ELEM_TET4


   .. py:attribute:: ELEM_QUAD


   .. py:attribute:: ELEM_TRI


   .. py:attribute:: ELEM_LINE2


   .. py:attribute:: ELEM_HEX20


   .. py:attribute:: ELEM_TET10


   .. py:attribute:: ELEM_TET15


   .. py:attribute:: ELEM_HEX27


   .. py:attribute:: ELEM_TRI6


   .. py:attribute:: ELEM_QUAD8


   .. py:attribute:: ELEM_QUAD9


   .. py:attribute:: ELEM_PENTA15


   .. py:attribute:: ELEM_TET20


   .. py:attribute:: ELEM_TRI10


   .. py:attribute:: ELEM_PYRA5


   .. py:attribute:: ELEM_TET5


   .. py:attribute:: ELEM_PYRA13


.. py:class:: nodesPerElementClass

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


   Define the node count per FEBio element class.

   Initialize self.  See help(type(self)) for accurate signature.


   .. py:attribute:: ELEM_HEX
      :value: 8



   .. py:attribute:: ELEM_PENTA
      :value: 6



   .. py:attribute:: ELEM_TET4
      :value: 4



   .. py:attribute:: ELEM_QUAD
      :value: 4



   .. py:attribute:: ELEM_TRI
      :value: 3



   .. py:attribute:: ELEM_LINE2
      :value: 2



   .. py:attribute:: ELEM_HEX20
      :value: 20



   .. py:attribute:: ELEM_TET10
      :value: 10



   .. py:attribute:: ELEM_TET15
      :value: 15



   .. py:attribute:: ELEM_HEX27
      :value: 27



   .. py:attribute:: ELEM_TRI6
      :value: 6



   .. py:attribute:: ELEM_QUAD8
      :value: 8



   .. py:attribute:: ELEM_QUAD9
      :value: 9



   .. py:attribute:: ELEM_PENTA15
      :value: 15



   .. py:attribute:: ELEM_TET20
      :value: 20



   .. py:attribute:: ELEM_TRI10
      :value: 10



   .. py:attribute:: ELEM_PYRA5
      :value: 5



   .. py:attribute:: ELEM_TET5
      :value: 5



   .. py:attribute:: ELEM_PYRA13
      :value: 13



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

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


   PLT tag constants that name key sections and data items.


   .. py:attribute:: PLT_VERSION
      :value: '0x0031'



   .. py:attribute:: PLT_ROOT
      :value: '0x01000000'



   .. py:attribute:: PLT_HEADER
      :value: '0x01010000'



   .. py:attribute:: PLT_HDR_VERSION
      :value: '0x01010001'



   .. py:attribute:: PLT_HDR_COMPRESSION
      :value: '0x01010004'



   .. py:attribute:: PLT_HDR_AUTHOR
      :value: '0x01010005'



   .. py:attribute:: PLT_HDR_SOFTWARE
      :value: '0x01010006'



   .. py:attribute:: PLT_DICTIONARY
      :value: '0x01020000'



   .. py:attribute:: PLT_DIC_ITEM
      :value: '0x01020001'



   .. py:attribute:: PLT_DIC_ITEM_TYPE
      :value: '0x01020002'



   .. py:attribute:: PLT_DIC_ITEM_FMT
      :value: '0x01020003'



   .. py:attribute:: PLT_DIC_ITEM_NAME
      :value: '0x01020004'



   .. py:attribute:: PLT_DIC_ITEM_ARRAYSIZE
      :value: '0x01020005'



   .. py:attribute:: PLT_DIC_ITEM_ARRAYNAME
      :value: '0x01020006'



   .. py:attribute:: PLT_DIC_GLOBAL
      :value: '0x01021000'



   .. py:attribute:: PLT_DIC_NODAL
      :value: '0x01023000'



   .. py:attribute:: PLT_DIC_DOMAIN
      :value: '0x01024000'



   .. py:attribute:: PLT_DIC_SURFACE
      :value: '0x01025000'



   .. py:attribute:: PLT_MESH
      :value: '0x01040000'



   .. py:attribute:: PLT_NODE_SECTION
      :value: '0x01041000'



   .. py:attribute:: PLT_NODE_HEADER
      :value: '0x01041100'



   .. py:attribute:: PLT_NODE_SIZE
      :value: '0x01041101'



   .. py:attribute:: PLT_NODE_DIM
      :value: '0x01041102'



   .. py:attribute:: PLT_NODE_NAME
      :value: '0x01041103'



   .. py:attribute:: PLT_NODE_COORDS
      :value: '0x01041200'



   .. py:attribute:: PLT_DOMAIN_SECTION
      :value: '0x01042000'



   .. py:attribute:: PLT_DOMAIN
      :value: '0x01042100'



   .. py:attribute:: PLT_DOMAIN_HDR
      :value: '0x01042101'



   .. py:attribute:: PLT_DOM_ELEM_TYPE
      :value: '0x01042102'



   .. py:attribute:: PLT_DOM_PART_ID
      :value: '0x01042103'



   .. py:attribute:: PLT_DOM_ELEMS
      :value: '0x01032104'



   .. py:attribute:: PLT_DOM_NAME
      :value: '0x01032105'



   .. py:attribute:: PLT_DOM_ELEM_LIST
      :value: '0x01042200'



   .. py:attribute:: PLT_ELEMENT
      :value: '0x01042201'



   .. py:attribute:: PLT_SURFACE_SECTION
      :value: '0x01043000'



   .. py:attribute:: PLT_SURFACE
      :value: '0x01043100'



   .. py:attribute:: PLT_SURFACE_HDR
      :value: '0x01043101'



   .. py:attribute:: PLT_SURFACE_ID
      :value: '0x01043102'



   .. py:attribute:: PLT_SURFACE_FACES
      :value: '0x01043103'



   .. py:attribute:: PLT_SURFACE_NAME
      :value: '0x01043104'



   .. py:attribute:: PLT_SURFACE_MAX_FACET_NODES
      :value: '0x01043105'



   .. py:attribute:: PLT_FACE_LIST
      :value: '0x01043200'



   .. py:attribute:: PLT_FACE
      :value: '0x01043201'



   .. py:attribute:: PLT_NODESET_SECTION
      :value: '0x01044000'



   .. py:attribute:: PLT_NODESET
      :value: '0x01044100'



   .. py:attribute:: PLT_NODESET_HDR
      :value: '0x01044101'



   .. py:attribute:: PLT_NODESET_ID
      :value: '0x01044102'



   .. py:attribute:: PLT_NODESET_NAME
      :value: '0x01044103'



   .. py:attribute:: PLT_NODESET_SIZE
      :value: '0x01044104'



   .. py:attribute:: PLT_NODESET_LIST
      :value: '0x01044200'



   .. py:attribute:: PLT_PARTS_SECTION
      :value: '0x01045000'



   .. py:attribute:: PLT_PART
      :value: '0x01045100'



   .. py:attribute:: PLT_PART_ID
      :value: '0x01045101'



   .. py:attribute:: PLT_PART_NAME
      :value: '0x01045102'



   .. py:attribute:: PLT_OBJECTS_SECTION
      :value: '0x01050000'



   .. py:attribute:: PLT_OBJECT_ID
      :value: '0x01050001'



   .. py:attribute:: PLT_OBJECT_NAME
      :value: '0x01050002'



   .. py:attribute:: PLT_OBJECT_TAG
      :value: '0x01050003'



   .. py:attribute:: PLT_OBJECT_POS
      :value: '0x01050004'



   .. py:attribute:: PLT_OBJECT_ROT
      :value: '0x01050005'



   .. py:attribute:: PLT_OBJECT_DATA
      :value: '0x01050006'



   .. py:attribute:: PLT_POINT_OBJECT
      :value: '0x01051000'



   .. py:attribute:: PLT_POINT_COORD
      :value: '0x01051001'



   .. py:attribute:: PLT_LINE_OBJECT
      :value: '0x01052000'



   .. py:attribute:: PLT_LINE_COORDS
      :value: '0x01052001'



   .. py:attribute:: PLT_STATE
      :value: '0x02000000'



   .. py:attribute:: PLT_STATE_HEADER
      :value: '0x02010000'



   .. py:attribute:: PLT_STATE_HDR_ID
      :value: '0x02010001'



   .. py:attribute:: PLT_STATE_HDR_TIME
      :value: '0x02010002'



   .. py:attribute:: PLT_STATE_STATUS
      :value: '0x02010003'



   .. py:attribute:: PLT_STATE_DATA
      :value: '0x02020000'



   .. py:attribute:: PLT_STATE_VARIABLE
      :value: '0x02020001'



   .. py:attribute:: PLT_STATE_VAR_ID
      :value: '0x02020002'



   .. py:attribute:: PLT_STATE_VAR_DATA
      :value: '0x02020003'



   .. py:attribute:: PLT_GLOBAL_DATA
      :value: '0x02020100'



   .. py:attribute:: PLT_NODE_DATA
      :value: '0x02020300'



   .. py:attribute:: PLT_ELEMENT_DATA
      :value: '0x02020400'



   .. py:attribute:: PLT_FACE_DATA
      :value: '0x02020500'



   .. py:attribute:: PLT_MESH_STATE
      :value: '0x02030000'



   .. py:attribute:: PLT_ELEMENT_STATE
      :value: '0x02030001'



   .. py:attribute:: PLT_OBJECTS_STATE
      :value: '0x02040000'