ngsPETSc.plex
=============

.. py:module:: ngsPETSc.plex

.. autoapi-nested-parse::

   This module contains all the functions related to wrapping NGSolve meshes to
   PETSc DMPlex using the petsc4py interface.



Attributes
----------

.. autoapisummary::

   ngsPETSc.plex.FACE_SETS_LABEL
   ngsPETSc.plex.CELL_SETS_LABEL
   ngsPETSc.plex.EDGE_SETS_LABEL


Classes
-------

.. autoapisummary::

   ngsPETSc.plex.ngs
   ngsPETSc.plex.MeshMapping


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

.. py:class:: ngs

   dummy class


   .. py:class:: comp

      dummy class


      .. py:attribute:: Mesh



.. py:data:: FACE_SETS_LABEL
   :value: 'Face Sets'


.. py:data:: CELL_SETS_LABEL
   :value: 'Cell Sets'


.. py:data:: EDGE_SETS_LABEL
   :value: 'Edge Sets'


.. py:class:: MeshMapping(mesh=None, comm=PETSc.COMM_WORLD.tompi4py(), name='Default')

   This class creates a mapping between Netgen/NGSolve meshes and PETSc DMPlex  

   :arg mesh: the mesh object, it can be either a Netgen/NGSolve mesh or a PETSc DMPlex

   :arg name: the name of to be assigned to the PETSc DMPlex, by default this is set to "Default"



   .. py:attribute:: name
      :value: 'Default'



   .. py:attribute:: comm


   .. py:method:: createNGSMesh(plex)

      This function generate an NGSolve mesh from a PETSc DMPlex 

      :arg plex: the PETSc DMPlex to be converted in NGSolve mesh object




   .. py:method:: createPETScDMPlex(mesh)

      This function generate an PETSc DMPlex from a Netgen/NGSolve mesh object

      :arg plex: the Netgen/NGSolve mesh object to be converted into a PETSc
                 DMPlex.