bluemira.equilibria.boundary
============================

.. py:module:: bluemira.equilibria.boundary

.. autoapi-nested-parse::

   Boundary conditions for equilibria.



Classes
-------

.. autoapisummary::

   bluemira.equilibria.boundary.FreeBoundary


Functions
---------

.. autoapisummary::

   bluemira.equilibria.boundary.apply_boundary


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

.. py:class:: FreeBoundary(grid: bluemira.equilibria.grid.Grid)

   Object representing a free boundary condition, accounting for only the
   plasma psi

   :param grid: The grid upon which to apply the free Dirichlet boundary condition


   .. py:attribute:: __slots__
      :value: ('dx', 'dz', 'edges', 'f_greens')



   .. py:attribute:: edges


   .. py:attribute:: f_greens


   .. py:method:: __call__(psi: numpy.typing.NDArray[numpy.float64], jtor: numpy.typing.NDArray[numpy.float64])

      Applies a free boundary (Dirichlet) condition using Green's functions

      :param psi: The poloidal magnetic flux [V.s/rad]
      :param jtor: The toroidal current density in the plasma [A/m^2]

      .. rubric:: Notes

      Modifies psi in-place



.. py:function:: apply_boundary(rhs: numpy.typing.NDArray[numpy.float64], lhs: numpy.typing.ArrayLike)

   Applies a boundary constraint to the boundaries of an array for use on finite
   difference grids.

   :param rhs: The right-hand-side of the equality
   :param lhs: The left-hand-side of the equality
               If 0, will apply a fixed boundary condition of 0 to the rhs

   .. rubric:: Notes

   Modified rhs in-place; applying lhs boundary condition