tidy3d.rf.CustomImpedanceSpec

class CustomImpedanceSpec

Bases: MicrowaveBaseModel

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

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_spec (Union[AxisAlignedVoltageIntegralSpec, Custom2DVoltageIntegralSpec, NoneType] = None) – Path specification for computing the voltage associated with a mode profile.

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

:param The CustomImpedanceSpec class specifies how quantities related to transmission line: :param modes are computed. It defines the paths for line integrals: :param which are used to: :param compute voltage: :param current: :param and characteristic impedance of the transmission line.: :param Users must supply at least one of voltage or current path specifications to control where these integrals: :param 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

attrs

Methods

check_path_spec_combinations(val, values)

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

Inherited Common Usage

voltage_spec

current_spec

classmethod check_path_spec_combinations(val, values)

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.

__hash__()

Hash method.