fibomat.layout.layoutbase module

Provide the LayoutBase class.

class fibomat.layout.layoutbase.LayoutBase(description: Optional[str] = None)

Bases: Generic[fibomat.layout.layoutbase.ElementT, fibomat.layout.layoutbase.VectorT, fibomat.layout.layoutbase.BBoxT], abc.ABC

ABC for all layout related classes.

It can be used to arrange fibomat.site.Site, fibomat.pattern.Pattern and fibomat.shapes.Shape.

The saved are accessed via the LayoutBase.layout_elements() method which returns a generator containing all included elements.

What kind of elements and how these are set must be specified in child classes.

__init__(description: Optional[str] = None)

Args:

description (str, optional): description

layout_elements() → Iterator[fibomat.layout.layoutbase.ElementT]

Access to the saved elements.

Yields:

Any: Type depends on saved element.

fibomat.layout.lattices.lattice_builder_base module fibomat.layout.utils module