flex_rf.tidy3d.BlochBoundary
Type: class │ Base(s): BoundaryEdge
Description
Section titled “Description”Specifies a Bloch boundary condition along a single dimension.
Example(s)
Section titled “Example(s)”bloch = BlochBoundary(bloch_vec=1)Parameters
Section titled “Parameters”bloch_vec [float] |
|
Normalized component of the Bloch vector in units of 2 * pi / (size along dimension) in the background medium, along the dimension in which the boundary is specified. |
name [str | None] = None |
|
Optional unique name for boundary. |
Methods
Section titled “Methods”bloch_phase() |
|
Returns the forward phase factor associated with |
from_source(source: BlochSourceType, domain_size: float, axis: Axis, medium: Medium | None = None) |
|
Set the Bloch vector component based on a given angled source and its center frequency. Note that if a broadband angled source is used, only the frequency components near the center frequency will exhibit angled incidence at the expect angle. In this case, a narrowband source is recommended. |