tidy3d.rf.CustomImpedanceSpec

class CustomImpedanceSpec

Bases: AbstractImpedanceSpec

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

Parameters:

• voltage_spec (Optional[Union[AxisAlignedVoltageIntegralSpec, Custom2DVoltageIntegralSpec]] = None) – Path specification for computing the voltage associated with a mode profile.

• current_spec (Optional[Union[AxisAlignedCurrentIntegralSpec, Custom2DCurrentIntegralSpec, CompositeCurrentIntegralSpec]] = None) – Path specification for computing the current associated with a mode profile.

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

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

Attributes

impedance_definition	Determine the impedance definition based on provided path specifications.
voltage_spec
current_spec

Methods

check_path_spec_combinations()	Validate that at least one of voltage_spec or current_spec is provided.
from_bounding_box(bounding_box[, current_sign])	Create a custom impedance specification from a bounding box.

voltage_spec

current_spec

check_path_spec_combinations()

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

In order to define voltage/current/impedance, either a voltage or current path specification must be provided. Both cannot be None simultaneously.

property impedance_definition

Determine the impedance definition based on provided path specifications.

Returns:

The impedance definition type: - VI: Both voltage and current specs provided. - PI: Only current spec provided. - PV: Only voltage spec provided.

Return type:

ImpedanceDef

classmethod from_bounding_box(bounding_box, current_sign='+')

Create a custom impedance specification from a bounding box.