Plugins

Mode Solver

tidy3d.plugins.mode.ModeSolver	Interface for solving electromagnetic eigenmodes in a 2D plane with translational invariance in the third dimension.
tidy3d.plugins.mode.ModeSolverData	Data associated with a ModeSolverMonitor: scalar components of E and H fields.

Dispersive Model Fitting

tidy3d.plugins.dispersion.FastDispersionFitter	Tool for fitting refractive index data to get a dispersive medium described by PoleResidue model.
tidy3d.plugins.dispersion.AdvancedFastFitterParam	Advanced fast fitter parameters.
tidy3d.plugins.dispersion.DispersionFitter	Tool for fitting refractive index data to get a dispersive medium described by PoleResidue model.
tidy3d.plugins.dispersion.AdvancedFitterParam	Advanced fitter parameters
tidy3d.plugins.dispersion.web.run(fitter[, ...])	Execute the data fit using the stable fitter in the server.
tidy3d.plugins.dispersion.StableDispersionFitter	Deprecated.

Self-intersecting Polyslab

tidy3d.plugins.polyslab.ComplexPolySlab

Interface for dividing a complex polyslab where self-intersecting polygon can occur during extrusion.

Scattering Matrix Calculator

tidy3d.plugins.smatrix.ComponentModeler	Tool for modeling devices and computing scattering matrix elements.
tidy3d.plugins.smatrix.Port	Specifies a port in the scattering matrix.
tidy3d.plugins.smatrix.SMatrixDataArray	Scattering matrix elements.

Resonance Finder

tidy3d.plugins.resonance.ResonanceFinder

Tool that extracts resonance information from a time series of the form shown below.

Adjoint

• Adjoint Plugin Developer Guide
  • Context
    • The Need for Simulation Differentiation
    • Numerical Derivatives
    • Automatic Differentiation
    • Adjoint Method
    • Adjoint Plugin
    • AD using Jax
    • Outline of Guide
  • Automatic Differentiation w/ Jax
    • Vector Jacobian Products (VJPs)
    • Custom VJPs
    • The VJP of web.run()
    • Where do derivatives come from?
  • Jax Nuts and Bolts
    • Registering Tidy3D components with jax
    • Jax Subclasses of Tidy3D objects
    • Conversion Between JaxTidy3D and Tidy3D Components
    • The One Exception: DataArrays
  • Adjoint Method
    • Gradient Monitors
    • Adjoint Source Creation
    • Adjoint Simulation Creation
    • PostProcessing Forward and Adjoint Fields for VJP Creation
  • Using the Plugin
    • Defining Jax Simulation
      • Input Structures
      • Output Monitors
      • Gradient Monitors
      • Other Differences
    • Adjoint web.run function
    • Working with JaxSimulationData
    • Putting it all together
  • Differentiating using jax
    • Derivative Functions
      • grad
      • value_and_grad
      • jax.numpy
  • Conclusion

tidy3d.plugins.adjoint.web.run	Submits a JaxSimulation to server, starts running, monitors progress, downloads, and loads results as a JaxSimulationData object.
tidy3d.plugins.adjoint.web.run_async	Submits a set of JaxSimulation objects to server, starts running, monitors progress, downloads, and loads results as a tuple of JaxSimulationData objects.
tidy3d.plugins.adjoint.JaxBox	A Box registered with jax.
tidy3d.plugins.adjoint.JaxPolySlab	A PolySlab registered with jax.
tidy3d.plugins.adjoint.JaxMedium	A Medium registered with jax.
tidy3d.plugins.adjoint.JaxAnisotropicMedium	A Medium registered with jax.
tidy3d.plugins.adjoint.JaxCustomMedium	A CustomMedium registered with jax.
tidy3d.plugins.adjoint.JaxStructure	A Structure registered with jax.
tidy3d.plugins.adjoint.JaxSimulation	A Simulation registered with jax.
tidy3d.plugins.adjoint.JaxSimulationData	A SimulationData registered with jax.
tidy3d.plugins.adjoint.JaxModeData	A ModeData registered with jax.
tidy3d.plugins.adjoint.JaxPermittivityDataset	A PermittivityDataset registered with jax.
tidy3d.plugins.adjoint.JaxDataArray	A DataArray-like class that only wraps xarray for jax compatibility.
tidy3d.plugins.adjoint.utils.filter.ConicFilter	Filter that convolves an image with a conical mask, used for larger feature sizes.
tidy3d.plugins.adjoint.utils.filter.BinaryProjector	Projects a grayscale image towards min and max values using a smooth tanh function.
tidy3d.plugins.adjoint.utils.penalty.RadiusPenalty	Generates a penalty for radius of curvature of set of points.

Waveguide

tidy3d.plugins.waveguide.RectangularDielectric

General rectangular dielectric waveguide

Design Space Exploration

• Parameter Sweep Plugin
  • Basics
  • Function
  • Parameters
  • Method
  • Design Space
  • Results

tidy3d.plugins.design.ParameterFloat	Parameter containing floats.
tidy3d.plugins.design.ParameterInt	Parameter containing integers.
tidy3d.plugins.design.ParameterAny	Parameter containing a set of of anything.
tidy3d.plugins.design.MethodGrid	Select parameters uniformly on a grid.
tidy3d.plugins.design.MethodMonteCarlo	Select sampling points using Monte Carlo sampling (Latin Hypercube method).
tidy3d.plugins.design.MethodRandomCustom	Select parameters with an object with a user supplied sampler with a .random method.
tidy3d.plugins.design.MethodRandom	Select sampling points uniformly at random.
tidy3d.plugins.design.DesignSpace	Specification of a design problem / combination of several parameters + algorithm.