Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.CompositeCurrentIntegral

Type: class │ Base(s): CompositeCurrentIntegralSpec

Description

Section titled “Description”

Current integral comprising one or more disjoint paths

Example(s)

Section titled “Example(s)”
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")

Parameters

Section titled “Parameters”
path_specs [tuple[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.

Methods

Section titled “Methods”
compute_current(em_field: IntegrableMonitorDataType)

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

“Collection of closed current path integrals.

Machine-Readable Export

Section titled “Machine-Readable Export”