mmgp.FE_utils
=============

.. py:module:: mmgp.FE_utils


Functions
---------

.. autoapisummary::

   mmgp.FE_utils.compute_FE_projection_operators
   mmgp.FE_utils.compute_node_to_node_graph
   mmgp.FE_utils.initialize_graph_points_from_mesh_points


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

.. py:function:: compute_FE_projection_operators(origin_mesh: Muscat.Containers.Mesh.Mesh, target_mesh: Muscat.Containers.Mesh.Mesh, verbose: bool = False) -> Tuple[numpy.ndarray, numpy.ndarray]

   Compute Finite Element Projection Operators.

   :param origin_mesh: The original mesh data.
   :type origin_mesh: Mesh
   :param target_mesh: The target mesh data.
   :type target_mesh: Mesh
   :param verbose: Whether to display verbose output. Defaults to False.
   :type verbose: bool, optional

   :returns: A tuple containing two projection operators (projOperator, invProjOperator).
   :rtype: tuple(np.ndarray, np.ndarray)


.. py:function:: compute_node_to_node_graph(in_mesh: Muscat.Containers.Mesh.Mesh, dimensionality: int = None, dist_func: Callable = None) -> networkx.Graph

   Creates a networkx graph from the node connectivity on a Mesh through edges

   :param in_mesh: input mesh
   :type in_mesh: Mesh
   :param dimensionality: dimension of the elements considered to initalize the graph
   :type dimensionality: int
   :param dist_func: function applied to the lengh of the edges of the mesh, and attached of the
                     corresponding edge of the graph of the mesh
   :type dist_func: func

   :returns: Element to element graph
   :rtype: networkx.Graph


.. py:function:: initialize_graph_points_from_mesh_points(in_mesh: Muscat.Containers.Mesh.Mesh) -> networkx.Graph

   Initializes a networkx graph with nodes consistant with the number of nodes of a Mesh.
   This enables further edge addition compatible with the connectivity of the elements of the Mesh.

   :param in_mesh: input mesh
   :type in_mesh: Mesh

   :returns: initialized graph
   :rtype: networkx.Graph