:py:mod:`symfem`
================

.. py:module:: symfem

.. autoapi-nested-parse::

   Symfem: a symbolic finite element definition library.



Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   elements/index.rst
   polynomials/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   basis_functions/index.rst
   caching/index.rst
   create/index.rst
   finite_element/index.rst
   functionals/index.rst
   functions/index.rst
   geometry/index.rst
   mappings/index.rst
   moments/index.rst
   piecewise_functions/index.rst
   plotting/index.rst
   quadrature/index.rst
   references/index.rst
   symbols/index.rst
   utils/index.rst
   version/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   symfem.add_element
   symfem.create_element
   symfem.create_reference



Attributes
~~~~~~~~~~

.. autoapisummary::

   symfem.__version__
   symfem.__citation__
   symfem.__github__
   symfem.__git__


.. py:function:: add_element(element_class: Type)

   Add an element to Symfem.

   :param element_class: The class defining the element.


.. py:function:: create_element(cell_type: str, element_type: str, order: int, vertices: Optional[symfem.geometry.SetOfPointsInput] = None, **kwargs: Any) -> symfem.finite_element.FiniteElement

   Make a finite element.

   :param cell_type: The reference cell type.
                     Supported values: point, interval, triangle, quadrilateral, tetrahedron,
                     hexahedron, prism, pyramid, dual polygon(number_of_triangles)
   :param element_type: The type of the element.
                        Supported values:
                        Lagrange, P,
                        vector Lagrange, vP,
                        matrix Lagrange,
                        symmetric matrix Lagrange,
                        dPc,
                        vector dPc,
                        Crouzeix-Raviart, CR, Crouzeix-Falk, CF,
                        conforming Crouzeix-Raviart, conforming CR,
                        serendipity, S,
                        serendipity Hcurl, Scurl, BDMCE, AAE,
                        serendipity Hdiv, Sdiv, BDMCF, AAF,
                        direct serendipity,
                        Regge,
                        Nedelec, Nedelec1, N1curl, Ncurl,
                        Nedelec2, N2curl,
                        Raviart-Thomas, RT, N1div,
                        Brezzi-Douglas-Marini, BDM, N2div,
                        Q,
                        vector Q, vQ,
                        NCE, RTCE, Qcurl,
                        NCF, RTCF, Qdiv,
                        Morley,
                        Morley-Wang-Xu, MWX,
                        Hermite,
                        Mardal-Tai-Winther, MTW,
                        Argyris,
                        bubble,
                        dual polynomial, dual P, dual,
                        Buffa-Christiansen, BC,
                        rotated Buffa-Christiansen, RBC,
                        Brezzi-Douglas-Fortin-Marini, BDFM,
                        Brezzi-Douglas-Duran-Fortin, BDDF,
                        Hellan-Herrmann-Johnson, HHJ,
                        Arnold-Winther, AW, conforming Arnold-Winther,
                        Bell,
                        Kong-Mulder-Veldhuizen, KMV,
                        Bernstein, Bernstein-Bezier,
                        Hsieh-Clough-Tocher, Clough-Tocher, HCT, CT,
                        reduced Hsieh-Clough-Tocher, rHCT,
                        Taylor, discontinuous Taylor,
                        bubble enriched Lagrange,
                        bubble enriched vector Lagrange,
                        Bogner-Fox-Schmit, BFS,
                        Fortin-Soulie, FS,
                        Bernardi-Raugel,
                        Wu-Xu,
                        transition,
                        Guzman-Neilan,
                        nonconforming Arnold-Winther, nonconforming AW,
                        TScurl, trimmed serendipity Hcurl,
                        TSdiv, trimmed serendipity Hdiv,
                        TNT, tiniest tensor,
                        TNTcurl, tiniest tensor Hcurl,
                        TNTdiv, tiniest tensor Hdiv,
                        Arnold-Boffi-Falk, ABF,
                        Arbogast-Correa, AC, AC full, Arbogast-Correa full,
                        Rannacher-Turek,
                        P1-iso-P2, P2-iso-P1, iso-P2 P1,
                        Huang-Zhang, HZ,
                        enriched Galerkin, EG,
                        enriched vector Galerkin, locking-free enriched Galerkin, LFEG,
                        P1 macro,
                        Alfeld-Sorokina, AS
   :param order: The order of the element.
   :param vertices: The vertices of the reference.


.. py:function:: create_reference(cell_type: str, vertices: Optional[symfem.geometry.SetOfPointsInput] = None) -> symfem.references.Reference

   Make a reference cell.

   :param cell_type: The reference cell type.
                     Supported values: point, interval, triangle, quadrilateral, tetrahedron,
                     hexahedron, prism, pyramid, dual polygon(number_of_triangles)
   :param vertices: The vertices of the reference.


.. py:data:: __version__
   :value: '2024.1.1'

   

.. py:data:: __citation__
   :value: 'https://doi.org/10.21105/joss.03556 (Scroggs, 2021)'

   

.. py:data:: __github__
   :value: 'https://github.com/mscroggs/symfem'

   

.. py:data:: __git__
   :value: 'https://github.com/mscroggs/symfem.git'