:py:mod:`symfem.moments`
========================

.. py:module:: symfem.moments

.. autoapi-nested-parse::

   Functions to create integral moments.



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


Functions
~~~~~~~~~

.. autoapisummary::

   symfem.moments._extract_moment_data
   symfem.moments.make_integral_moment_dofs



Attributes
~~~~~~~~~~

.. autoapisummary::

   symfem.moments.MomentType
   symfem.moments.SingleMomentTypeInput
   symfem.moments.MomentTypeInput


.. py:data:: MomentType

   

.. py:data:: SingleMomentTypeInput

   

.. py:data:: MomentTypeInput

   

.. py:function:: _extract_moment_data(moment_data: MomentTypeInput, sub_type: str) -> MomentType

   Get the information for a moment.

   :param moment_data: The moment data
   :param sub_type: The subentity type

   :returns: The moment type, finite elment, order, mapping, and keyword arguments for the moment


.. py:function:: make_integral_moment_dofs(reference: symfem.references.Reference, vertices: Optional[MomentTypeInput] = None, edges: Optional[MomentTypeInput] = None, faces: Optional[MomentTypeInput] = None, volumes: Optional[MomentTypeInput] = None, cells: Optional[MomentTypeInput] = None, facets: Optional[MomentTypeInput] = None, ridges: Optional[MomentTypeInput] = None, peaks: Optional[MomentTypeInput] = None) -> List[symfem.functionals.BaseFunctional]

   Generate DOFs due to integral moments on sub entities.

   :param reference: The reference cell.
   :param vertices: DOFs on dimension 0 entities.
   :param edges: DOFs on dimension 1 entities.
   :param faces: DOFs on dimension 2 entities.
   :param volumes: DOFs on dimension 3 entities.
   :param cells: DOFs on codimension 0 entities.
   :param facets: DOFs on codimension 1 entities.
   :param ridges: DOFs on codimension 2 entities.
   :param peaks: DOFs on codimension 3 entities.

   :returns: A list of DOFs for the element