pyfebiopt.xplt.element_state
============================

.. py:module:: pyfebiopt.xplt.element_state

.. autoapi-nested-parse::

   Element status flags stored in XPLT mesh-state blocks.



Attributes
----------

.. autoapisummary::

   pyfebiopt.xplt.element_state.ELEMENT_ACTIVE


Classes
-------

.. autoapisummary::

   pyfebiopt.xplt.element_state.ElementStateView


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

.. py:data:: ELEMENT_ACTIVE

.. py:class:: ElementStateView(times: collections.abc.Iterable[float], status: collections.abc.Iterable[numpy.ndarray], mesh: pyfebiopt.mesh.mesh.Mesh)

   Expose raw FEBio element status flags and active masks over time.

   Build an element-state view in global mesh element order.


   .. py:method:: __len__() -> int

      Return number of loaded states.



   .. py:method:: times() -> numpy.ndarray

      Return loaded state times.



   .. py:method:: domains() -> tuple[str, ...]

      Return available domain names.



   .. py:method:: status(*, time: int | slice | numpy.ndarray | list[int] = slice(None), domain: str | None = None) -> numpy.ndarray

      Return raw FEBio status flags for selected states and elements.



   .. py:method:: active(*, time: int | slice | numpy.ndarray | list[int] = slice(None), domain: str | None = None) -> numpy.ndarray

      Return true where FEBio's ``FEElement::ACTIVE`` bit is set.



   .. py:method:: inactive(*, time: int | slice | numpy.ndarray | list[int] = slice(None), domain: str | None = None) -> numpy.ndarray

      Return true where FEBio's ``FEElement::ACTIVE`` bit is clear.



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


   .. py:attribute:: __str__