tidy3d.plugins.microwave.ImpedanceCalculator#

class ImpedanceCalculator[source]#

Bases: Tidy3dBaseModel

Tool for computing the characteristic impedance of a transmission line.

Parameters:
  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • voltage_integral (Union[VoltageIntegralAxisAligned, CustomVoltageIntegral2D, NoneType] = None) – Definition of path integral for computing voltage.

  • current_integral (Union[CurrentIntegralAxisAligned, CustomCurrentIntegral2D, NoneType] = None) – Definition of contour integral for computing current.

Attributes

Methods

check_voltage_or_current(val, values)

Raise validation error if both voltage_integral and current_integral were not provided.

compute_impedance(em_field)

Compute impedance for the supplied em_field using voltage_integral and current_integral.

Inherited Common Usage

voltage_integral#
current_integral#
compute_impedance(em_field)[source]#

Compute impedance for the supplied em_field using voltage_integral and current_integral. If only a single integral has been defined, impedance is computed using the total flux in em_field.

Parameters:

em_field (MonitorDataTypes) – The electromagnetic field data that will be used for computing the characteristic impedance.

Returns:

Result of impedance computation over remaining dimensions (frequency, time, mode indices).

Return type:

IntegralResultTypes

classmethod check_voltage_or_current(val, values)[source]#

Raise validation error if both voltage_integral and current_integral were not provided.

__hash__()#

Hash method.