Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.ModeABCBoundary

Type: class │ Base(s): AbstractABCBoundary

Description

Section titled “Description”

One-way wave equation absorbing boundary conditions for absorbing a waveguide mode.

Parameters

Section titled “Parameters”
name [str | None] = None

Optional unique name for boundary.
mode_spec [ModeSpecType] = DEFAULT_MODE_SPEC_MODE_ABC

Parameters that determine the modes computed by the mode solver.
mode_index [NonNegativeInt] = 0

Index into the collection of modes returned by mode solver. The absorbing boundary conditions are configured to absorb the specified mode. If larger than mode_spec.num_modes, num_modes in the solver will be set to mode_index + 1.
freq_spec [PositiveFloat | BroadbandModeABCSpec | None] = None

Specifies the frequency at which field is absorbed. If None, then the central frequency of the source is used. If BroadbandModeABCSpec, then the field is absorbed over the specified frequency range.
plane [Box] = ...

Cross-sectional plane in which the absorbed mode will be computed.

Methods

Section titled “Methods”
from_monitor(monitor: ModeMonitor | ModeSolverMonitor, mode_index: NonNegativeInt = 0, freq_spec: PositiveFloat | BroadbandModeABCSpec | None = None)

Instantiate from a ModeMonitor or ModeSolverMonitor.
from_source(source: ModeSource, freq_spec: PositiveFloat | BroadbandModeABCSpec | None = None)

Instantiate from a ModeSource.
is_plane(val: Box)

Raise validation error if not planar.

Machine-Readable Export

Section titled “Machine-Readable Export”