tidy3d.Periodic

class Periodic

Bases: BoundaryEdge

Periodic boundary condition class.

Parameters:

• attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

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

Attributes

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

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.