tidy3d.plugins.microwave.AxisAlignedPathIntegral

tidy3d.plugins.microwave.AxisAlignedPathIntegral#

class AxisAlignedPathIntegral[source]#

Bases: AxisAlignedPathIntegralSpec

Class for defining the simplest type of path integral, which is aligned with Cartesian axes.

Parameters:

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

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

  • extrapolate_to_endpoints (bool = False) – If the endpoints of the path integral terminate at or near a material interface, the field is likely discontinuous. When this field is True, fields that are outside and on the bounds of the integral are ignored. Should be enabled when computing voltage between two conductors.

  • snap_path_to_grid (bool = False) – It might be desirable to integrate exactly along the Yee grid associated with a field. When this field is True, the integration path will be snapped to the grid.

Example

>>> path = AxisAlignedPathIntegral(
...     center=(0, 0, 1),
...     size=(0, 0, 2),
...     extrapolate_to_endpoints=True,
...     snap_path_to_grid=False,
... )

Attributes

extrapolate_to_endpoints

snap_path_to_grid

size

center

Methods

compute_integral(scalar_field)

Computes the defined integral given the input scalar_field.
compute_integral(scalar_field)[source]#

Computes the defined integral given the input scalar_field.