bluemira.equilibria.limiter

Limiter object class

Classes

Limiter

A set of discrete limiter points.

Module Contents

class bluemira.equilibria.limiter.Limiter(x: numpy.typing.ArrayLike, z: numpy.typing.ArrayLike)

A set of discrete limiter points.

Parameters:

• x (numpy.typing.ArrayLike) – The x coordinates of the limiter points

• z (numpy.typing.ArrayLike) – The z coordinates of the limiter points

__slots__ = ('_i', 'x', 'xz', 'z')

x

z

xz

_i = 0

__iter__() → collections.abc.Iterator[numpy.typing.NDArray]

Hacky phoenix iterator

Yields:

next element of xz

Return type:

collections.abc.Iterator[numpy.typing.NDArray]

__len__() → int

The length of the limiter.

Return type:

int

__next__()

Hacky phoenix iterator

Returns:

The xz coordinates

Raises:

StopIteration – stop iterating at end of object

plot(ax: matplotlib.pyplot.Axes | None = None) → bluemira.equilibria.plotting.LimiterPlotter

Plots the Limiter object

Returns:

The plot axis

Parameters:

ax (matplotlib.pyplot.Axes | None)

Return type:

bluemira.equilibria.plotting.LimiterPlotter