tidy3d.rf.TerminalWavePort

class TerminalWavePort

Bases: AbstractWavePort

Class representing a single terminal-driven wave port.

Parameters:

• center (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [units = um]. Center of object in x, y, and z.

• size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.

• name (str) – Unique name for the port.

• direction (Literal['+', '-']) – ‘+’ or ‘-’, defining which direction is considered ‘input’.

• num_grid_cells (Optional[int] = 5) – 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 (Optional[PECFrame] = PECFrame()) – Add a thin frame around the source during FDTD run for an improved injection.

• absorber (Union[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.

• 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 (Union[Literal['Z0'], complex, ImpedanceTerminalDataArray] = Z0) – [units = ohm]. 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.

• terminal_specs (Union[AutoImpedanceSpec, tuple[CustomImpedanceSpec, …]] = AutoImpedanceSpec()) – 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.

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.

Attributes

reference_impedance
absorber
terminal_specs
differential_pairs
direction
num_grid_cells
conjugated_dot_product
frame
extrude_structures
name
size
center

Methods

compute_current(sim_data)	Helper to compute current flowing through the port.
compute_voltage(sim_data)	Helper to compute voltage across the port.
get_characteristic_impedance_matrix(...)	Retrieve the characteristic impedance matrix of the port.
to_source(source_time[, snap_center, ...])	Create a microwave terminal source from the wave port.

reference_impedance

absorber

terminal_specs

differential_pairs

to_source(source_time, snap_center=None, terminal_label=None, mode_spec=None)

Create a microwave terminal source from the wave port.

Parameters:

• source_time (SourceTimeType) – Source time specification.

• snap_center (float, optional) – Position to snap the source center to along injection axis.

• terminal_label (str, optional) – Terminal label to inject. If None, uses the first terminal in mode_spec.

• mode_spec (MicrowaveModeSpecType, optional) – Resolved mode specification with integer num_modes. If None, uses self._mode_spec but raises SetupError if num_modes=’auto’.

get_characteristic_impedance_matrix(sim_mode_data)

Retrieve the characteristic impedance matrix of the port.

compute_voltage(sim_data)

Helper to compute voltage across the port.

compute_current(sim_data)

Helper to compute current flowing through the port.