flex_rf.tidy3d.CompositeCurrentIntegralSpec

Type: class │ Base(s): MicrowaveBaseModel

Description

Specification for a composite current integral.

Notes

This class is used to set up a CompositeCurrentIntegral, which combines multiple current integrals. It does not perform any integration itself.

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_spec = CompositeCurrentIntegralSpec(
    path_specs=(spec1, spec2),
    sum_spec="sum"
)

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

bounds()

Return the overall bounding box of all path specifications.

plot(x: float | None = None, y: float | None = None, z: float | None = None, ax: Ax = None, plot_arrow: bool = True, **path_kwargs: Any)

Plot path integral at single (x,y,z) coordinate.