# Mode ABC Boundary

ModeABCBoundary is a one-way wave equation absorbing boundary condition for a selected waveguide mode.

This object corresponds to tidy3d.ModeABCBoundary (opens new window).

# Name

name: Optional unique name for the boundary.

  • Default: None

# Mode Specification

mode_spec: Parameters used by the mode solver to determine the absorbed mode.

# Mode Index

mode_index: Index of the mode to absorb.

  • Type: integer
  • Constraint: greater than or equal to 0
  • Default: 0

If mode_index is larger than mode_spec.num_modes, the solver automatically increases num_modes to mode_index + 1.

# Frequency Specification

freq_spec: Frequency at which the field is absorbed.

  • Options:
    • None: Use the central frequency of the source.
    • Frequency value: Absorb the field at the specified frequency.
    • Broadband specification: Absorb the field over a specified frequency range.
  • Default: None

# Plane

plane: Cross-sectional plane in which the absorbed mode is computed.

  • Required field

NOTE

The plane must be planar. It should match the cross section of the mode that needs to be absorbed.