# Wave Port

A Wave Port represents a modal-driven port used to excite and measure propagating modes through a planar port region.

This object corresponds to tidy3d.rf.WavePort (opens new window).

# Name

name: Unique name for the port.

  • Required field

# Geometry

Specification of the wave port plane.

# Center + Size

Object definition through a center position and size.

plane: Plane of the wave port.

  • Options: XY/YZ/XZ
  • Required field

The selected plane determines the zero-size dimension and the injection axis:

  • XY: port normal is along the z-axis.
  • YZ: port normal is along the x-axis.
  • XZ: port normal is along the y-axis.

center: Center of the port in x, y, and z-directions.

  • Type: floating-point number
  • Unit: m, mm (default unit), um
  • Default: (0, 0, 0)

size: Size of the port in x, y, and z-directions.

  • Type: floating-point number
  • Unit: m, mm (default unit), um
  • Constraint: greater than or equal to 0
  • Required field

# Bounds

Object definition through minimum and maximum coordinate bounds.

min: Values of the x, y, and z coordinates defining the lower corner of the port.

  • Type: floating-point number
  • Unit: m, mm (default unit), um
  • Required field

max: Values of the x, y, and z coordinates defining the upper corner of the port.

  • Type: floating-point number
  • Unit: m, mm (default unit), um
  • Required field

NOTE

A wave port must be planar. The size along the port normal direction is set to 0.

# Direction

direction: The injected power direction for the port.

  • Options: +/-
  • Required field

The direction is defined along the port normal axis.

# Mode Selection

mode_selection: Selected injected mode index or mode indices used by the port.

  • Type: integer or list of integers
  • Constraint: non-negative and less than num_modes
  • Default: None, which uses all modes returned by the mode solver

# Microwave Mode Specification

mode_spec: Parameters used by the mode solver to determine which modes are returned and how microwave transmission line quantities are computed.

See Microwave Mode Specification.

# Mode Sorting

sort_spec: Specification for filtering, sorting, and tracking modes within each frequency.

See Mode Sort Specification.

# Impedance and Calibration

impedance_specs: Specification for how voltage, current, and characteristic impedance are computed for each mode.

See Impedance and Calibration.

# Advanced

num_pml: Number of standard PML layers added in the two tangential axes of the mode plane.

  • Type: two non-negative integers
  • Default: (0, 0)

X: Number of PML layers along the first tangential axis of the port plane.

Y: Number of PML layers along the second tangential axis of the port plane.

frame: Toggle whether to add a thin PEC frame around the source during the FDTD run.

  • Options:
    • True: Add a frame for improved injection.
    • False: Do not add a frame.
  • Default: True

num_grid_cells: Number of mesh grid cells in the transverse plane of the wave port. These cells are used to generate suggested mesh override structures.

  • Type: integer
  • Constraint: greater than or equal to 3
  • Default: 5

extrude_structures: Toggle whether structures intersecting the wave port plane are extruded by a few grid cells.

  • Options:
    • True: Extrude intersecting structures to improve mode injection accuracy.
    • False: Do not extrude intersecting structures.
  • Default: False

conjugated_dot_product: Toggle whether to use conjugated dot product for mode decomposition.

  • Options:
    • True: Use conjugated dot product.
    • False: Use non-conjugated dot product.
  • Default: False

absorber: Place a mode absorber in the port.

  • Options:
    • False: Do not place a mode absorber.
    • True / Auto: Automatically place a mode absorber.
    • ABCBoundary: Use a one-way wave equation absorbing boundary condition.
    • ModeABCBoundary: Use a one-way wave equation absorbing boundary condition for a selected mode.
  • Default: True

← RLC Network →