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 anattr
obj.attrs['foo'] = bar
. Also note that Tidy3D` will raise aTypeError
ifattrs
contain objects that can not be serialized. One can check ifattrs
are serializable by callingobj.json()
.voltage_integral (Optional[VoltageIntegralAxisAligned]) – Definition of path integral for computing voltage.
current_integral (Optional[CurrentIntegralAxisAligned]) – Definition of contour integral for computing current.
Attributes
Methods
check_voltage_or_current
(val, values)Raise validation error if both
voltage_integral
andcurrent_integral
were not provided.compute_impedance
(em_field)Compute impedance for the supplied
em_field
usingvoltage_integral
andcurrent_integral
.Inherited Common Usage
- voltage_integral#
- current_integral#
- compute_impedance(em_field)[source]#
Compute impedance for the supplied
em_field
usingvoltage_integral
andcurrent_integral
. If only a single integral has been defined, impedance is computed using the total flux inem_field
.
- classmethod check_voltage_or_current(val, values)[source]#
Raise validation error if both
voltage_integral
andcurrent_integral
were not provided.
- __hash__()#
Hash method.