flex_rf.tidy3d.CustomImpedanceSpec

Type: class │ Base(s): AbstractImpedanceSpec

Description

Specification for custom transmission line voltages and currents in mode solvers.

Notes

The CustomImpedanceSpec class specifies how quantities related to transmission line modes are computed. It defines the paths for line integrals, which are used to compute voltage, current, and characteristic impedance of the transmission line.

Users must supply at least one of voltage or current path specifications to control where these integrals are evaluated. Both voltage_spec and current_spec cannot be None simultaneously.

Example(s)

from tidy3d.components.microwave.path_integrals.specs.voltage import AxisAlignedVoltageIntegralSpec
from tidy3d.components.microwave.path_integrals.specs.current import AxisAlignedCurrentIntegralSpec
voltage_spec = AxisAlignedVoltageIntegralSpec(
    center=(0, 0, 0), size=(0, 0, 1), sign="+"
)
current_spec = AxisAlignedCurrentIntegralSpec(
    center=(0, 0, 0), size=(2, 1, 0), sign="+"
)
impedance_spec = CustomImpedanceSpec(
    voltage_spec=voltage_spec,
    current_spec=current_spec
)

Parameters

voltage_spec [VoltagePathSpecType | None] = None

Path specification for computing the voltage associated with a mode profile.

current_spec [CurrentPathSpecType | None] = None

Path specification for computing the current associated with a mode profile.

Attributes

impedance_definition [ImpedanceDef]

Determine the impedance definition based on provided path specifications.

Methods

check_path_spec_combinations()

Validate that at least one of voltage_spec or current_spec is provided.

from_bounding_box(bounding_box: Box, current_sign: Direction = '+')

Create a custom impedance specification from a bounding box.