bluemira.equilibria.limiter
===========================

.. py:module:: bluemira.equilibria.limiter

.. autoapi-nested-parse::

   Limiter object class



Classes
-------

.. autoapisummary::

   bluemira.equilibria.limiter.Limiter


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

.. py:class:: Limiter(x: numpy.typing.ArrayLike, z: numpy.typing.ArrayLike)

   A set of discrete limiter points.

   :param x: The x coordinates of the limiter points
   :param z: The z coordinates of the limiter points


   .. py:attribute:: __slots__
      :value: ('_i', 'x', 'xz', 'z')



   .. py:attribute:: x


   .. py:attribute:: z


   .. py:attribute:: xz


   .. py:attribute:: _i
      :value: 0



   .. py:method:: __iter__() -> collections.abc.Iterator[numpy.typing.NDArray]

      Hacky phoenix iterator

      :Yields: next element of xz



   .. py:method:: __len__() -> int

      The length of the limiter.



   .. py:method:: __next__()

      Hacky phoenix iterator

      :returns: The xz coordinates

      :raises StopIteration: stop iterating at end of object



   .. py:method:: plot(ax: matplotlib.pyplot.Axes | None = None) -> bluemira.equilibria.plotting.LimiterPlotter

      Plots the Limiter object

      :returns: The plot axis