Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.CoaxialLumpedPort

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

Description

Section titled “Description”

Class representing a single coaxial lumped port.

Example(s)

Section titled “Example(s)”
port1 = CoaxialLumpedPort(center=(0, 0, 0),
            outer_diameter=4,
            inner_diameter=1,
            normal_axis=2,
            direction="+",
            name="coax_port_1",
            impedance=50
        )

Parameters

Section titled “Parameters”
name [str]

Unique name for the port.
outer_diameter [PositiveFloat]

Diameter of the outer coaxial circle.
inner_diameter [PositiveFloat]

Diameter of the inner coaxial circle.
normal_axis [Axis]

Specifies the axis which is normal to the concentric circles.
direction [Direction]

The direction of the signal travelling in the transmission line. This is needed in order to position the path integral, which is used for computing conduction current using Ampère’s circuital law.
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.
center [Coordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.

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.
injection_axis()

Required for inheriting from AbstractTerminalPort.
main_axis()

Required for inheriting from AbstractAxesRH.
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.

Machine-Readable Export

Section titled “Machine-Readable Export”