tidy3d.rf.CompositeCurrentIntegral

class CompositeCurrentIntegral

Bases: CompositeCurrentIntegralSpec

Current integral comprising one or more disjoint paths

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

• path_specs (Tuple[Union[AxisAlignedCurrentIntegralSpec, Custom2DCurrentIntegralSpec], ...]) – Definition of the disjoint path specifications for each isolated contour integral.

• sum_spec (Literal['sum', 'split']) – Determines the method used to combine the currents calculated by the different current integrals defined by path_specs. sum simply adds all currents, while split keeps contributions with opposite phase separate, which allows for isolating the current flowing in opposite directions. In split version, the current returned is the maximum of the two contributions.

Example

>>> spec1 = AxisAlignedCurrentIntegralSpec(center=(0, 0, 0), size=(1, 1, 0), sign="+")
>>> spec2 = AxisAlignedCurrentIntegralSpec(center=(2, 0, 0), size=(1, 1, 0), sign="+")
>>> composite = CompositeCurrentIntegral(path_specs=(spec1, spec2), sum_spec="sum")

Attributes

current_integrals	"Collection of closed current path integrals.
attrs

Methods

compute_current(em_field)

Compute current flowing in loop defined by the outer edge of a rectangle.

Inherited Common Usage

property current_integrals

“Collection of closed current path integrals.

compute_current(em_field)

Compute current flowing in loop defined by the outer edge of a rectangle.

__hash__()

Hash method.