tidy3d.plugins.microwave.CurrentIntegralAxisAligned

tidy3d.plugins.microwave.CurrentIntegralAxisAligned#

class CurrentIntegralAxisAligned[source]#

Bases: AbstractAxesRH, Box

Class for computing conduction current via Ampère’s circuital law on an axis-aligned loop.

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

  • center (Union[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]], Box] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (Union[tuple[Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box]], Box]) – [units = um]. Size in x, y, and z directions.

  • sign (Literal['+', '-']) – Positive indicates current flowing in the positive normal axis direction.

  • extrapolate_to_endpoints (bool = False) – This parameter is passed to AxisAlignedPathIntegral objects when computing the contour integral.

  • snap_contour_to_grid (bool = False) – This parameter is passed to AxisAlignedPathIntegral objects when computing the contour integral.

Attributes

main_axis

Axis normal to loop

attrs

Methods

compute_current(em_field)

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

plot([x, y, z, ax])

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

Inherited Common Usage

sign#
extrapolate_to_endpoints#
snap_contour_to_grid#
compute_current(em_field)[source]#

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

property main_axis#

Axis normal to loop

plot(x=None, y=None, z=None, ax=None, **path_kwargs)[source]#

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

Parameters:

  • x (float = None) – Position of plane in x direction, only one of x,y,z can be specified to define plane.

  • y (float = None) – Position of plane in y direction, only one of x,y,z can be specified to define plane.

  • z (float = None) – Position of plane in z direction, only one of x,y,z can be specified to define plane.

  • ax (matplotlib.axes._subplots.Axes = None) – Matplotlib axes to plot on, if not specified, one is created.

  • **path_kwargs – Optional keyword arguments passed to the matplotlib plotting of the line. For details on accepted values, refer to Matplotlib’s documentation.

Returns:

The supplied or created matplotlib axes.

Return type:

matplotlib.axes._subplots.Axes

__hash__()#

Hash method.