bempp_cl.api.space
==================

.. py:module:: bempp_cl.api.space

.. autoapi-nested-parse::

   Definitions of finite element spaces.

   Documentation of the functionality of this module and examples
   can be found at https://bempp.com/handbook/api/function_spaces.html



Submodules
----------

.. toctree::
   :maxdepth: 1

   /docs/bempp_cl/api/space/maxwell_spaces/index
   /docs/bempp_cl/api/space/scalar_dual_spaces/index
   /docs/bempp_cl/api/space/scalar_spaces/index
   /docs/bempp_cl/api/space/shapesets/index
   /docs/bempp_cl/api/space/space/index


Functions
---------

.. autoapisummary::

   bempp_cl.api.space.function_space


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

.. py:function:: function_space(grid, kind, degree, scatter=True, **kwargs)

   Initialize a function space.

   Parameters
   ----------
   grid : bempp_cl.Grid
       The grid that the space is defined on.
   kind : str
       The space type
   degree : int
       The polynomial degree of the space
   support_elements : np.array
       The element indices of elements that make up the part
       of the mesh on which the space is defined.
   segments : list
       The segment numbers of the part of the mesh on which the space is defined.
   swapped_normals : bool
       TODO
   scatter : bool
       TODO
   include_boundary_dofs : bool
       Should degrees of freedom on the boundary of the grid segments be included?
   truncate_at_segment_edge : bool
       Should basis functions be truncated at the edge of the grid segment? If this is set to true,
       continuous spaces will no longer be continuous across the segment edge.