Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.Custom2DCurrentIntegralSpec

Type: class │ Base(s): Custom2DPathIntegralSpec

Description

Section titled “Description”

Class for specifying the computation of conduction current via Ampère’s circuital law on a custom path. To compute the current flowing in the positive axis direction, the vertices should be ordered in a counterclockwise direction.

Example(s)

Section titled “Example(s)”
import numpy as np
vertices = np.array([[0, 0], [2, 0], [2, 1], [0, 1], [0, 0]])
current_spec = Custom2DCurrentIntegralSpec(
    axis=2,
    position=0,
    vertices=vertices
)

Parameters

Section titled “Parameters”
axis [Axis]

Specifies dimension of the planar axis (0,1,2) -> (x,y,z).
position [float]

Position of the plane along the axis.
vertices [ArrayFloat2D]

List of (d1, d2) defining the 2 dimensional positions of the path. The index of dimension should be in the ascending order, which means if the axis corresponds with y, the coordinates of the vertices should be (x, z). The path must form a closed contour, i.e., vertices[-1] == vertices[0].

Methods

Section titled “Methods”
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.

Machine-Readable Export

Section titled “Machine-Readable Export”