flex_rf.tidy3d.LumpedPort

Type: class │ Base(s): AbstractLumpedPort, Box

Description

Class representing a single rectangular lumped port.

Notes

The port must be planar (exactly one zero-size dimension). One-dimensional ports (two zero-size dimensions) are not supported. If you need a narrow port, provide a small but finite width along the lateral axis (e.g., fp_eps or larger).

Example(s)

port1 = LumpedPort(center=(0, 0, 0),
            size=(0, 1, 2),
            voltage_axis=2,
            name="port_1",
            impedance=50
        )

Parameters

size [TracedSize]

Size in x, y, and z directions.

name [str]

Unique name for the port.

voltage_axis [Axis]

Specifies the axis along which the E-field line integral is performed when computing the port voltage. The integration axis must lie in the plane of the port.

center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.

impedance [Complex] = DEFAULT_REFERENCE_IMPEDANCE

Reference port impedance for scattering parameter computation.

num_grid_cells [PositiveInt | None] = DEFAULT_PORT_NUM_CELLS

Number of mesh grid cells associated with the port along each direction, which are added through automatic mesh refinement. A value of None will turn off automatic mesh refinement.

enable_snapping_points [bool] = True

When enabled, snapping points are automatically generated to snap grids to key geometric features of the lumped port for more accurate modelling.

snap_perimeter_to_grid [bool] = True

When enabled, the perimeter of the port is snapped to the simulation grid, which improves accuracy when the number of grid cells is low within the element. A LumpedPort is always snapped to the grid along its injection axis.

dist_type [LumpDistType] = 'on'

Optional field that is passed directly to the LinearLumpedElement used to model the port’s load. When set to on, the network portion of the lumped port, including the source, is distributedacross the entirety of the lumped element’s bounding box. When set to off, the network portion of the lumped port is restricted to one cell and PEC connections are used to connect the network cell to the edges of the lumped element. A third option exists laterally_only, where the network portion is only distributed along the lateral axis of the lumped port.

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.

current_axis()

Integration axis for computing the port current via the magnetic field.

from_structures(x: float | None = None, y: float | None = None, z: float | None = None, ground_terminal: Structure | None = None, signal_terminal: Structure | None = None, voltage_axis: Axis = None, lateral_coord: float | None = None, port_width: float | None = None, **kwargs: Any)

Auto-generate lumped port based on provided structures and plane coordinates.

injection_axis()

Injection axis of the port.

to_current_monitor(freqs: FreqArray, snap_center: float | None = None, grid: Grid | None = None)

Field monitor to compute port current.

to_load(snap_center: float | None = None)

Create a load resistor from the lumped port.

to_source(source_time: SourceTimeType, snap_center: float | None = None, grid: Grid | None = None, **kwargs: Any)

Create a current source from the lumped port.

to_voltage_monitor(freqs: FreqArray, snap_center: float | None = None, grid: Grid | None = None)

Field monitor to compute port voltage.