Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.TerminalWavePort

Type: class │ Base(s): AbstractWavePort

Description

Section titled “Description”

Class representing a single terminal-driven wave port.

Notes

Section titled “Notes”
  • By default, the terminals are single-ended, specified by terminal_specs parameters. They are labeled by T0, T1, …, Tn, where the order is defined by their order in terminal_specs if it’s a tuple/list, or their location from left to right and bottom to top if terminal_specs is an AutoImpedanceSpec.
  • Differential pairs are defined by selecting a pair of single-ended terminals based on their labels. The differential pair itself is labeled by “Diff0@comm”, “Diff0@diff”, “Diff1@comm”, “Diff1@diff”, …, where the order is defined by their order in differential_pairs.
  • The terminals are ordered so that the single-ended terminal labels come first, followed by differential pairs.
  • By default, a reference impedance of 50 Ohm is used for S-parameter calculations unless otherwise specified.

Parameters

Section titled “Parameters”
size [TracedSize]

Size in x, y, and z directions.
name [str]

Unique name for the port.
direction [Direction]

’+’ or ’-’, defining which direction is considered ‘input’.
center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.
num_grid_cells [int | None] = DEFAULT_WAVE_PORT_NUM_CELLS

Number of mesh grid cells in the transverse plane of the WavePort. Used in generating the suggested list of MeshOverrideStructure objects. Must be greater than or equal to 3. When set to None, no grid refinement is performed.
conjugated_dot_product [bool] = False

Use conjugated or non-conjugated dot product for mode decomposition.
frame [PECFrame | None] = DEFAULT_WAVE_PORT_FRAME

Add a thin frame around the source during FDTD run for an improved injection.
extrude_structures [bool] = False

Extrudes structures that intersect the wave port plane by a few grid cells when True, improving mode injection accuracy.
reference_impedance [Literal['Z0'] | Complex | ImpedanceTerminalDataArray] = 'Z0'

User-specified reference impedance for S-parameter computation. If Z0, the characteristic impedance is used. Otherwise, it can be a single complex value applied to all terminals, or a data array specified for each terminal. If the data array misses some terminals, 50 Ohm is applied to the missing terminals. By default, 50 Ohm is used.
absorber [bool | ABCBoundary | ModeABCBoundary] = False

Place a mode absorber in the port. If True, an automatically generated mode absorber is placed in the port. If ABCBoundary or ModeABCBoundary, a mode absorber is placed in the port with the specified boundary conditions.
terminal_specs [AutoImpedanceSpec | tuple[CustomImpedanceSpec, ...]] = factory: AutoImpedanceSpec._default_without_license_warning

Parameters to feed to terminal solver which determine single-ended terminals and how transmission line quantities for each single-ended terminal, e.g., charateristic impedance, are computed.
differential_pairs [tuple[tuple[str, str], ...]] = ()

Differential pairs defined by a pair of single-ended terminals based on their labels, which can be found out through TerminalComponentModeler.plot_port() method. In each pair, the first termial is positive, while the second is negative.

Methods

Section titled “Methods”
compute_current(sim_data: SimulationData)

Helper to compute current flowing through the port.
compute_voltage(sim_data: SimulationData)

Helper to compute voltage across the port.
get_characteristic_impedance_matrix(sim_mode_data: SimulationData | MicrowaveModeData)

Retrieve the characteristic impedance matrix of the port.
to_source(source_time: SourceTimeType, snap_center: float | None = None, terminal_label: str | None = None, mode_spec: MicrowaveModeSpecType | None = None)

Create a microwave terminal source from the wave port.

Machine-Readable Export

Section titled “Machine-Readable Export”