tidy3d.Periodic#

class Periodic[source]#

Bases: BoundaryEdge

Periodic boundary condition class.

Parameters:

name (Optional[str] = None) – Optional unique name for boundary.

Attributes

bloch_vec

Periodic boundaries are effectively Bloch boundaries with bloch_vec == 0.

Methods

Inherited Common Usage

property bloch_vec#

Periodic boundaries are effectively Bloch boundaries with bloch_vec == 0. In practice, periodic boundaries do not force the use of complex fields, while Bloch boundaries do, even with bloch_vec == 0. Thus, it is more efficient to use periodic.

__hash__()#

Hash method.