Skip to main content
Back to top
Ctrl
+
K
Search
Ctrl
+
K
Installation 👋
Lectures 📖
FDTD 101
Future-Ready FDTD Workshop
Inverse design in photonics
Example Library 📚
Basics
Quickstart
Tidy3D first walkthrough
Introduction on Tidy3D working principles
Running simulations through the cloud
How to troubleshoot a diverged FDTD simulation
Feature Tutorials
Mediums
Modeling dispersive materials
Fitting dispersive material models
Defining fully anisotropic materials
Defining gyrotropic materials
Defining spatially-varying dielectric structures
Applying time modulation to materials
Structures
Importing GDS files
Export to GDS file
Importing STL files
Defining self-intersecting polygons
Geometry transformations
Defining common integrated photonic components
Defining common photonic crystal structures
Defining complex geometries using trimesh
Grid Specification
Using automatic nonuniform meshing
Boundary Conditions & Symmetry
Setting up boundary conditions
Defining and using symmetries
Sources
Defining mode sources and monitors
Injecting modes in bent and angled waveguides
Defining a total-field scattered-field (TFSF) plane wave source
Defining spatially-varying sources
Data Visualization and Postprocessing
Visualizing geometries in Tidy3D
Performing visualization of simulation data
Advanced monitor data (xarray) manipulation and visualization
Creating FDTD animations
Performing near field to far field projections
Unstructured datasets
Mode Solver
Using the mode solver for optical mode analysis
Using the waveguide plugin to analyze waveguide modes
Running mode solver tasks in parallel
Design Space Exploration
Performing parallel / batch processing of simulations
Design Space Exploration Plugin
Scattering Matrix
Computing the scattering matrix of a device
Resonance Finder
Extracting resonance information using Resonance Finder
Cavity quality factor, effective mode volume, and Purcell factor
Inverse Design
Inverse design plugin
Inverse design quickstart
Autograd, automatic differentiation, and adjoint optimization: basics
Adjoint analysis of a multi-layer slab
Inverse design optimization of a mode converter
Multi-objective adjoint optimization
Inverse design optimization of a waveguide taper
Inverse design optimization of a compact grating coupler
Inverse design optimization of a metalens
Adjoint-based shape optimization of a waveguide bend
Adjoint optimization of a wavelength division multiplexer
Diffractive metasurface inverse design with topology optimization
Adjoint inverse design of a quantum emitter light extractor
Inverse design optimization of a plasmonic nanoantenna metasurface
Inverse design optimization of a bilayer grating coupler
Adjoint optimization of an integrated bandpass filter
Topology optimization of a waveguide bend
Inverse design of an apodized grating coupler through shape optimization
Design and shape optimization of a metalens-assisted waveguide taper
Inverse design of a GaP photon extractor for nitrogen-vacancy centers in diamond
Adjoint optimization of a photonic crystal
HEAT 🔥
Heat solver
EME 🌈
EME solver
Advanced Applications
Building a simple, Python-based GUI for Tidy3D
Microwave and RF
Computing the characteristic impedance of transmission lines using Tidy3D
Inverse Design with the Adjoint Plugin (Deprecated)
Inverse design quickstart
Jax, automatic differentiation, and adjoint optimization: basics
Adjoint analysis of a multi-layer slab
Inverse design optimization of a mode converter
Multi-objective adjoint optimization
Inverse design optimization of a waveguide taper
Inverse design optimization of a compact grating coupler
Inverse design optimization of a metalens
Adjoint-based shape optimization of a waveguide bend
Adjoint optimization of a wavelength division multiplexer
Parameterized level set optimization of a y-branch
Inverse design integrated with circuit simulation
Adjoint inverse design of a quantum emitter light extractor
Diffractive metasurface inverse design with topology optimization
Machine learning-based fabrication constraints for inverse design using PreFab
Case Studies
Passive Photonic Integrated Circuit Components
Waveguide Y junction
Waveguide to ring coupling
Waveguide crossing based on cosine tapers
Euler waveguide bend
Inverse taper edge coupler
2D effective index approximation of 3D simulations
Uniform grating coupler
Focusing apodized grating coupler
1x4 MMI power splitter
2D ring resonator
Broadband bi-level taper polarization rotator-splitter
Waveguide mode size converters
Strip to slot waveguide converters
Waveguide bragg gratings
Broadband directional coupler
Compact polarization splitter-rotator
8-Channel mode and polarization de-multiplexer
THz integrated demultiplexer/filter based on a ring resonator
Photonic crystal waveguide polarization filter
90 degree optical hybrid
Broadband polarizer assisted by anisotropic metamaterial
Exceptional coupling for waveguide crosstalk reduction
Thin film lithium niobate adiabatic waveguide coupler
Polarization splitter and rotator based on 90 degree bends
Plasmonic waveguide sensor for carbon dioxide detection
Bi-layer SiN edge coupler in the visible frequency
Dielectric waveguide with scale-invariant effective index
Unidirectional waveguide grating antenna
Free-form chip-to-chip coupler
MMI-based NIR/MIR demultiplexer
Dispersion calculation in tapered waveguide
Designing a polarization splitter/rotator on thin-film lithium niobate
Integrated plasmonic Vivaldi antenna with silicon waveguide
Generation of Kerr sideband
Active Photonic Integrated Circuit Components
Thermally tuned waveguide
Thermally tuned ring resonator
Carrier injection based Mach-Zehnder modulator
Thermo-optic modulator with a doped silicon heater
Global Optimization
Particle swarm optimization of a polarization beam splitter
Particle swarm optimization of a bullseye cavity for quantum emitter light extraction
Compact on-chip optical switch design optimization using DBS
Optimization of an S-bend with CMA-ES
Genetic algorithm optimization of a silicon on-chip reflector
Metamaterials, Gratings, and Other Periodic Structures
Dielectric metasurface absorber
Gradient metasurface reflector
Graphene metamaterial absorber
Tunable chiral metasurface based on phase change material
Microwave frequency selective surface
High-Q silicon resonator
Germanium Fano metasurface
Multilevel blazed diffraction grating
Biosensor grating simulation
Distributed Bragg reflector and cavity
CMOS RGB image sensor
Plasmonic cavity resonator consisting of a gold nanorod array
All-dielectric structural colors
MIM resonator
Vortex beam metasurface
Microwave and RF Devices
Designing and optimizing a coupled line bandpass filter
Photonic Crystals
Band structure calculation of a photonic crystal slab
Optimized photonic crystal L3 cavity
Bistability in photonic crystal microcavities
Nanobeam cavity
Optical Scattering and Far-field Radiation
Scattering cross-section calculation of a dielectric sphere
Scattering of a plasmonic nanoparticle
Plasmonic Yagi-Uda nanoantenna
Field projection for a zone plate
Multipole expansion for electromagnetic scattering
Lenses
3D optical Luneburg lens
Metalens in the visible frequency range
Mid-IR metalens based on silicon nanopillars
Spherical Fresnel lens
Nanophotonics
Hyperbolic polaritons in nanostructured hBN
Unidirectional SPP from non-Hermitian metagratings
Anderson localization of electromagnetic waves in 3D
Atomically thin waveguides based on MoS2 monolayers
Radiative cooling glass coating
Metal oxide sunscreen
Fiber Optics
Anti-resonant hollow-core fiber
FAQ 🔎
About Tidy3D
How is using Tidy3D billed?
What is Tidy3D?
Can I get a discount as a student or teacher?
What are the advantages of Tidy3D compared to traditional EM simulators?
Do I have to know Python programming to use Tidy3D?
What is a FlexCredit?
How many CPU hours is one FlexCredit comparable to?
Does Tidy3D have a graphical user interface (GUI)?
Can I do a free trial to evaluate the capabilities of Tidy3D before purchasing it?
Boundary Conditions
Which types of boundary conditions are available in Tidy3D?
How do I set the perfect matched layer (PML) boundary condition?
How do I set the perfect electric conductor (PEC) boundary condition?
How do I set the perfect magnetic conductor (PMC) boundary condition?
How do I set the periodic boundary condition?
How do I set the Bloch boundary condition?
How do I set the Absorber boundary condition?
How do I specify different boundary conditions on each simulation domain edge?
Can my geometry lie within the boundary layers?
What is the ideal distance between the geometry and absorbing layers?
How do I avoid reflections from the simulation edges?
How do I simulate periodic structures in Tidy3D?
What is The Difference Between Periodic and Bloch Boundaries?
Data Visualization and Postprocessing
How do I plot an object with a spatial definition?
How do I change the object plotting characteristics (facecolor, edgecolor, etc)?
How do I change the global plot characteristics (title, size, etc)?
How do I access the data of a specific monitor?
How do I interpolate the electromagnetic field data at the Yee cell centers?
How do I get the monitor’s data from a SimulationData object?
How do I select the data at a certain coordinate value (i.e. x=0.0, f=200e12)?
How do I get the monitor data at a certain index?
How do I interpolate the monitor data at various coordinate values?
How do I get the real part, imaginary part, or absolute value of complex-valued simulation data?
How do I get the raw monitor data values as a numpy array?
How do I get a specific field component from a FieldMonitor or FieldTimeMonitor?
How do I plot the monitor data as a function of one of its coordinates?
How do I plot the simulation structure on top of my field plot?
How do I project electromagnetic near-field data to the far field?
Grid Specification
What do I need to know about the numerical grid?
How fine of a grid or mesh does my simulation need? How to choose grid spec?
How to use the automatic nonuniform meshing? What steps per wavelength will be sufficient?
How can I create a uniform grid?
How can I locally refine the mesh?
Installation and Help
How can I install the Python client of Tidy3D?
How do I see the version of Tidy3D I am using?
How do I get help related to a Tidy3D object?
Can I try Tidy3D before installing the Python client on my computer?
Inverse Design
What is adjoint simulation?
How many simulations are performed in adjoint calculations?
How is the adjoint simulation billed?
How to install jax?
How do I set an inverse design problem?
What are the differences between adjoint shape, topology, and level set optimizations?
How do I set an adjoint shape optimization?
How do I set an adjoint topology optimization?
How do I create an adjoint parameterized level set optimization?
How do I include fabrication constraints in adjoint shape optimization?
How do I include fabrication constraints in adjoint topology optimization?
How do I include fabrication constraints in adjoint level set optimization?
How do I export the final inverse design structure to GDS?
Mediums
How do I include material dispersion?
Can I import my own tabulated material data?
How do I create a lossy material (with a conductivity)?
How do I create a material from n, k values at a given frequency?
How do I create a material from optical n, k data?
How do I create a dispersive material from model parameters?
How do I create an anisotropic material?
How do I create an active material?
How do I create a spatially varying material?
How do I export a spatially varying medium dataset to HDF5?
How do I load a commonly used dispersive material?
How can I define a 2D material?
How can I define graphene?
How can I define a nonlinear material?
Mode Solver
How do I set the mode solver?
How are the output modes sorted?
How do I set the mode polarization?
How do I run the mode solver locally?
How do I run the server-side mode solver?
What are the differences between running the server-side and the local mode solver?
Which information can I obtain from the mode solver?
How can I get the mode solver information?
How can I get the mode field distribution?
How can I plot the mode field distribution?
How do I plot the mode effective index versus wavelength?
How do I plot the mode group index versus wavelength?
How do I calculate the mode effective area?
How do I calculate the mode polarization fraction?
How do I calculate the waveguide mode polarization fraction?
Monitors
How do I set a FieldMonitor?
How do I specify apodization?
How do I create field animations?
How do I change the phase of fields obtained from frequency-domain monitors?
How do I set a FieldTimeMonitor?
How do I create a time-domain field animation?
How do I plot the time-domain field at a specific time?
How do I set a FluxMonitor?
How do I calculate the Poynting vector at a specific surface?
How do I integrate the Poynting vector at a specific surface?
How do I create a flux box?
How do I set a FluxTimeMonitor?
How do I set a ModeMonitor?
How do I get the coupling efficiency of a specific waveguide mode?
How do I calculate mode overlap?
How do I set a ModeSolverMonitor?
How do I set a PermittivityMonitor?
How do I set a FieldProjectionCartesianMonitor?
How do I set a FieldProjectionAngleMonitor?
How do I set a FieldProjectionKSpaceMonitor?
How do I set a DiffractionMonitor?
Parameter Sweep
How do I run a parameter sweep?
How do I submit multiple simulations?
How to load a batch result?
How do I loop through tidy3d.web.BatchData without loading all of the data into memory?
How do I save or load a tidy3d.web.Batch so I can work with it later?
Resonance Finder
How do I set the ResonanceFinder?
How do I get resonance quality factors?
How do I calculate photonic band diagrams using the ResonanceFinder?
How do I calculate the effective mode volume?
How to Ensure the Calculated Quality Factor is Accurate?
How do I calculate the Purcell factor?
Scattering Matrix
How do I compute scattering matrix parameters for modeling my device?
How do I specify a Port in the scattering matrix calculation?
How do I specify mappings between scattering matrix elements?
Simulation Troubleshoot
Why is a simulation diverging?
How can I troubleshoot a diverged FDTD simulation?
Why did my simulation finish early?
Should I make sure that fields have fully decayed by the end of the simulation?
Can I have structures larger than the simulation domain?
Why can I not change Tidy3D instances after they are created?
Simulations
How do I run a simulation and access the results?
How to submit a simulation in Python to the server?
How do I upload a job to the web without running it so I can inspect it first?
How do I monitor the progress of a simulation?
How do I load the results of a simulation?
How do I load the results of a job that has already been finished without knowing the task ID?
How do I access the original Simulation object that created the data?
How do I save and load the SimulationData object?
How do I save and load any Tidy3D object?
How do I get all data in a Tidy3d object as a dictionary?
How do I estimate how many credits my simulation will take?
How do I see the cost of my simulation?
How can I reduce the simulation cost?
How do I print the task log file?
What are the units used in the simulation?
How to run a 2D simulation in Tidy3D?
Why the simulation time for the exact same simulation can vary?
How long should I run the simulation?
Can you convert a lumerical script file to Tidy3D?
Sources
What source bandwidth should I use for my simulation?
How do I set the source frequency and bandwidth?
How can I plot the source spectrum and time-dependence?
How can I plot the source spectrum?
How are results normalized?
How do I set a PointDipole source?
How do I calculate the power radiated by a PointDipole source?
How do I set a UniformCurrentSource source?
How do I set a PlaneWave source?
How do I set a ModeSource?
How do I inject a specific optical mode in a waveguide?
How do I inject an optical mode in a waveguide bend?
How do I set a GaussianBeam?
How do I model an optical fiber mode source?
How do I model a converging Gaussian beam?
How do I model a diverging Gaussian beam?
How do I set an AstigmaticGaussianBeam source?
How do I set a total-field scattered-field (TFSF) source?
How do I set a custom field source?
How do I set a custom current source?
How do I inject an optical mode in an angled waveguide?
Structures
How do I import a structure from a GDSII file?
How can I import a structure from STL files?
How do I export a structure to GDSII format?
How do I create a box?
How do I create a sphere?
How do I create a cylinder?
How do I create a polygon?
How do I create a geometry group?
How do I combine multiple geometries?
When two structures overlap, what is the priority determined?
How to rotate a geometry?
How to translate a geometry?
How to scale a geometry?
How can I apply transformations to a geometry?
How do I use clip operations?
Which features can I use to create geometries in Tidy3D?
How do I define complex geometries using trimesh?
How do I build curves, rings, and other photonic integrated components?
How do I build photonic crystal structures?
Symmetry
Why is it preferable to use symmetry whenever possible?
How do I set symmetry in Tidy3D?
How do I identify the symmetry planes of my simulation?
What does “odd, i.e. ‘PEC’ symmetry” mean?
What does “even, i.e. ‘PMC’ symmetry” mean?
How do I filter out waveguide modes using symmetry?
Does Tidy3D support continuous and discrete rotational symmetries?
API 💻
Simulation
tidy3d.Simulation
attrs
tidy3d.RunTimeSpec
attrs
Boundary Conditions
tidy3d.BoundarySpec
attrs
tidy3d.Boundary
attrs
tidy3d.BoundaryEdge
attrs
tidy3d.Periodic
attrs
tidy3d.PECBoundary
attrs
tidy3d.PMCBoundary
attrs
tidy3d.BlochBoundary
attrs
tidy3d.PML
attrs
tidy3d.StablePML
attrs
tidy3d.Absorber
attrs
tidy3d.AbsorberParams
attrs
tidy3d.PMLParams
attrs
Geometry
tidy3d.Box
attrs
tidy3d.Sphere
attrs
tidy3d.Cylinder
attrs
tidy3d.PolySlab
attrs
tidy3d.TriangleMesh
attrs
tidy3d.GeometryGroup
attrs
tidy3d.ClipOperation
attrs
tidy3d.Transformed
attrs
tidy3d.RotationAroundAxis
attrs
Mediums
tidy3d.Medium
attrs
tidy3d.PECMedium
attrs
tidy3d.FullyAnisotropicMedium
attrs
tidy3d.CustomMedium
attrs
tidy3d.PoleResidue
attrs
tidy3d.Lorentz
attrs
tidy3d.Sellmeier
attrs
tidy3d.Drude
attrs
tidy3d.Debye
attrs
tidy3d.CustomPoleResidue
attrs
tidy3d.CustomLorentz
attrs
tidy3d.CustomSellmeier
attrs
tidy3d.CustomDrude
attrs
tidy3d.CustomDebye
attrs
tidy3d.PerturbationMedium
attrs
tidy3d.PerturbationPoleResidue
attrs
tidy3d.AnisotropicMedium
attrs
tidy3d.Medium2D
attrs
tidy3d.CustomAnisotropicMedium
attrs
tidy3d.NonlinearSpec
attrs
tidy3d.NonlinearSusceptibility
attrs
tidy3d.KerrNonlinearity
attrs
tidy3d.TwoPhotonAbsorption
attrs
tidy3d.ModulationSpec
tidy3d.SpaceTimeModulation
tidy3d.ContinuousWaveTimeModulation
tidy3d.SpaceModulation
Material Library
tidy3d.Graphene
tidy3d.components.medium.AbstractPerturbationMedium
tidy3d.components.medium.NonlinearModel
Material Library
tidy3d.Graphene
Structures
tidy3d.Structure
attrs
tidy3d.MeshOverrideStructure
attrs
Sources
tidy3d.PointDipole
attrs
tidy3d.UniformCurrentSource
attrs
tidy3d.PlaneWave
attrs
tidy3d.ModeSource
attrs
tidy3d.GaussianBeam
attrs
tidy3d.AstigmaticGaussianBeam
attrs
tidy3d.CustomFieldSource
attrs
tidy3d.CustomCurrentSource
attrs
tidy3d.TFSF
attrs
tidy3d.GaussianPulse
attrs
tidy3d.ContinuousWave
attrs
tidy3d.CustomSourceTime
attrs
Monitors
tidy3d.FieldMonitor
attrs
tidy3d.FieldTimeMonitor
attrs
tidy3d.FluxMonitor
attrs
tidy3d.FluxTimeMonitor
attrs
tidy3d.ModeMonitor
attrs
tidy3d.ModeSolverMonitor
attrs
tidy3d.PermittivityMonitor
attrs
tidy3d.FieldProjectionCartesianMonitor
attrs
tidy3d.FieldProjectionAngleMonitor
attrs
tidy3d.FieldProjectionKSpaceMonitor
attrs
tidy3d.DiffractionMonitor
attrs
tidy3d.ApodizationSpec
attrs
Mode Specifications
tidy3d.ModeSpec
attrs
Field Projector
tidy3d.FieldProjectionSurface
attrs
tidy3d.FieldProjector
attrs
Lumped elements
tidy3d.LumpedResistor
attrs
tidy3d.CoaxialLumpedResistor
attrs
Discretization
tidy3d.GridSpec
attrs
tidy3d.AutoGrid
attrs
tidy3d.UniformGrid
attrs
tidy3d.CustomGrid
attrs
tidy3d.CustomGridBoundaries
attrs
tidy3d.Coords
attrs
tidy3d.FieldGrid
attrs
tidy3d.YeeGrid
attrs
tidy3d.Grid
attrs
Subpixel Averaging
tidy3d.SubpixelSpec
attrs
tidy3d.Staircasing
attrs
tidy3d.VolumetricAveraging
attrs
tidy3d.HeuristicPECStaircasing
attrs
tidy3d.PolarizedAveraging
attrs
tidy3d.PECConformal
attrs
Output Data
tidy3d.SimulationData
tidy3d.log
attrs
tidy3d.FieldData
attrs
tidy3d.FieldTimeData
attrs
tidy3d.ModeSolverData
attrs
tidy3d.PermittivityData
attrs
tidy3d.FluxData
attrs
tidy3d.FluxTimeData
attrs
tidy3d.ModeData
attrs
tidy3d.FieldProjectionAngleData
attrs
tidy3d.FieldProjectionCartesianData
attrs
tidy3d.FieldProjectionKSpaceData
attrs
tidy3d.DiffractionData
attrs
tidy3d.SpatialDataArray
tidy3d.PermittivityDataset
attrs
tidy3d.ScalarFieldDataArray
tidy3d.ScalarModeFieldDataArray
tidy3d.ScalarFieldTimeDataArray
tidy3d.ModeAmpsDataArray
tidy3d.ModeIndexDataArray
tidy3d.FluxDataArray
tidy3d.FluxTimeDataArray
tidy3d.FieldProjectionAngleDataArray
tidy3d.FieldProjectionCartesianDataArray
tidy3d.FieldProjectionKSpaceDataArray
tidy3d.DiffractionDataArray
Scene
tidy3d.Scene
attrs
Logging
tidy3d.log
tidy3d.set_logging_level
tidy3d.set_logging_file
Submitting Simulations
tidy3d.web.api.webapi.run
tidy3d.web.api.webapi.upload
tidy3d.web.api.webapi.estimate_cost
tidy3d.web.api.webapi.real_cost
tidy3d.web.api.webapi.get_info
tidy3d.web.api.webapi.start
tidy3d.web.api.webapi.monitor
tidy3d.web.api.webapi.download
tidy3d.web.api.webapi.load
tidy3d.web.api.webapi.delete
tidy3d.web.api.webapi.download_log
tidy3d.web.api.webapi.download_json
tidy3d.web.api.webapi.load_simulation
tidy3d.web.api.asynchronous.run_async
tidy3d.web.api.container.Job
attrs
tidy3d.web.api.container.Batch
attrs
tidy3d.web.api.container.BatchData
attrs
tidy3d.web.core.task_info.TaskInfo
tidy3d.web.core.task_info.TaskStatus
tidy3d.web.api.mode.run
tidy3d.web.api.mode.run_batch
tidy3d.web.api.mode.ModeSolverTask
HEAT 🔥
Simulation
tidy3d.HeatSimulation
Material Thermal Specification
tidy3d.FluidSpec
tidy3d.SolidSpec
Thermal Boundary Conditions
tidy3d.HeatBoundarySpec
tidy3d.TemperatureBC
tidy3d.ConvectionBC
tidy3d.HeatFluxBC
tidy3d.StructureStructureInterface
tidy3d.StructureBoundary
tidy3d.MediumMediumInterface
tidy3d.StructureSimulationBoundary
tidy3d.SimulationBoundary
Thermal Sources
tidy3d.UniformHeatSource
Grid Specification
tidy3d.UniformUnstructuredGrid
tidy3d.DistanceUnstructuredGrid
Monitors
tidy3d.TemperatureMonitor
Output Data
tidy3d.HeatSimulationData
tidy3d.TemperatureData
tidy3d.TriangularGridDataset
tidy3d.TetrahedralGridDataset
tidy3d.PointDataArray
tidy3d.CellDataArray
tidy3d.IndexedDataArray
tidy3d.HeatSimulation
attrs
tidy3d.FluidSpec
attrs
tidy3d.SolidSpec
attrs
tidy3d.LinearHeatPerturbation
attrs
tidy3d.CustomHeatPerturbation
attrs
tidy3d.HeatBoundarySpec
attrs
tidy3d.TemperatureBC
attrs
tidy3d.ConvectionBC
attrs
tidy3d.HeatFluxBC
attrs
tidy3d.StructureStructureInterface
attrs
tidy3d.StructureBoundary
attrs
tidy3d.MediumMediumInterface
attrs
tidy3d.StructureSimulationBoundary
attrs
tidy3d.SimulationBoundary
attrs
tidy3d.UniformHeatSource
attrs
tidy3d.UniformUnstructuredGrid
attrs
tidy3d.DistanceUnstructuredGrid
attrs
tidy3d.TemperatureMonitor
attrs
tidy3d.HeatSimulationData
tidy3d.log
attrs
tidy3d.TemperatureData
attrs
tidy3d.TriangularGridDataset
attrs
tidy3d.TetrahedralGridDataset
attrs
tidy3d.PointDataArray
tidy3d.CellDataArray
tidy3d.IndexedDataArray
CHARGE ⚡
Charge Perturbation Specification
tidy3d.LinearChargePerturbation
tidy3d.CustomChargePerturbation
tidy3d.LinearChargePerturbation
attrs
tidy3d.CustomChargePerturbation
attrs
EME 🌈
Simulation
tidy3d.EMESimulation
Grid Specification
tidy3d.EMEUniformGrid
tidy3d.EMECompositeGrid
tidy3d.EMEExplicitGrid
tidy3d.EMEGrid
tidy3d.EMEModeSpec
Monitors
tidy3d.EMECoefficientMonitor
tidy3d.EMEModeSolverMonitor
tidy3d.EMEFieldMonitor
tidy3d.EMEMonitor
Propagation Sweeps
tidy3d.EMELengthSweep
tidy3d.EMEModeSweep
Output Data
tidy3d.EMECoefficientData
tidy3d.EMEModeSolverData
tidy3d.EMEFieldData
tidy3d.EMESimulationData
tidy3d.EMESimulation
attrs
tidy3d.EMEUniformGrid
attrs
tidy3d.EMECompositeGrid
attrs
tidy3d.EMEExplicitGrid
attrs
tidy3d.EMEGrid
attrs
tidy3d.EMEModeSpec
attrs
tidy3d.EMECoefficientMonitor
attrs
tidy3d.EMEModeSolverMonitor
attrs
tidy3d.EMEFieldMonitor
attrs
tidy3d.EMEMonitor
attrs
tidy3d.EMELengthSweep
attrs
tidy3d.EMEModeSweep
attrs
tidy3d.EMECoefficientData
attrs
tidy3d.EMEModeSolverData
attrs
tidy3d.EMEFieldData
attrs
tidy3d.EMESimulationData
tidy3d.log
attrs
Plugins
Mode Solver
tidy3d.plugins.mode.ModeSolver
tidy3d.plugins.mode.ModeSolverData
Dispersive Model Fitting
tidy3d.plugins.dispersion.FastDispersionFitter
tidy3d.plugins.dispersion.AdvancedFastFitterParam
tidy3d.plugins.dispersion.DispersionFitter
tidy3d.plugins.dispersion.AdvancedFitterParam
tidy3d.plugins.dispersion.web.run
tidy3d.plugins.dispersion.StableDispersionFitter
Self-intersecting Polyslab
tidy3d.plugins.polyslab.ComplexPolySlab
Scattering Matrix Calculator
tidy3d.plugins.smatrix.ComponentModeler
tidy3d.plugins.smatrix.Port
tidy3d.plugins.smatrix.ModalPortDataArray
tidy3d.plugins.smatrix.TerminalComponentModeler
tidy3d.plugins.smatrix.LumpedPort
tidy3d.plugins.smatrix.LumpedPortDataArray
tidy3d.plugins.smatrix.CoaxialLumpedPort
Resonance Finder
tidy3d.plugins.resonance.ResonanceFinder
Automatic Differentiation with Autograd
tidy3d.plugins.autograd.functions.threshold
tidy3d.plugins.autograd.functions.rescale
tidy3d.plugins.autograd.functions.morphological_gradient_external
tidy3d.plugins.autograd.functions.morphological_gradient_internal
tidy3d.plugins.autograd.functions.morphological_gradient
tidy3d.plugins.autograd.functions.grey_closing
tidy3d.plugins.autograd.functions.grey_opening
tidy3d.plugins.autograd.functions.grey_erosion
tidy3d.plugins.autograd.functions.grey_dilation
tidy3d.plugins.autograd.functions.pad
tidy3d.plugins.autograd.functions.convolve
tidy3d.plugins.autograd.utilities.chain
tidy3d.plugins.autograd.utilities.make_kernel
tidy3d.plugins.autograd.utilities.get_kernel_size_px
tidy3d.plugins.autograd.primitives.gaussian_filter
tidy3d.plugins.autograd.invdes.grey_indicator
tidy3d.plugins.autograd.invdes.make_circular_filter
tidy3d.plugins.autograd.invdes.make_conic_filter
tidy3d.plugins.autograd.invdes.make_curvature_penalty
tidy3d.plugins.autograd.invdes.make_erosion_dilation_penalty
tidy3d.plugins.autograd.invdes.make_filter
tidy3d.plugins.autograd.invdes.make_filter_and_project
tidy3d.plugins.autograd.invdes.ramp_projection
tidy3d.plugins.autograd.invdes.tanh_projection
tidy3d.plugins.autograd.types.PaddingType
tidy3d.plugins.autograd.types.KernelType
Adjoint
tidy3d.plugins.adjoint.web.run
tidy3d.plugins.adjoint.web.run_async
tidy3d.plugins.adjoint.JaxBox
tidy3d.plugins.adjoint.JaxPolySlab
tidy3d.plugins.adjoint.JaxComplexPolySlab
tidy3d.plugins.adjoint.JaxMedium
tidy3d.plugins.adjoint.JaxAnisotropicMedium
tidy3d.plugins.adjoint.JaxCustomMedium
tidy3d.plugins.adjoint.JaxStructure
tidy3d.plugins.adjoint.JaxSimulation
tidy3d.plugins.adjoint.JaxSimulationData
tidy3d.plugins.adjoint.JaxModeData
tidy3d.plugins.adjoint.JaxPermittivityDataset
tidy3d.plugins.adjoint.JaxDataArray
tidy3d.plugins.adjoint.utils.filter.ConicFilter
tidy3d.plugins.adjoint.utils.filter.BinaryProjector
tidy3d.plugins.adjoint.utils.penalty.RadiusPenalty
Inverse Design Plugin
tidy3d.plugins.invdes.FilterProject
tidy3d.plugins.invdes.ErosionDilationPenalty
tidy3d.plugins.invdes.TopologyDesignRegion
tidy3d.plugins.invdes.InverseDesign
tidy3d.plugins.invdes.InverseDesignMulti
tidy3d.plugins.invdes.InverseDesignResult
tidy3d.plugins.invdes.AdamOptimizer
tidy3d.plugins.invdes.utils.get_amps
tidy3d.plugins.invdes.utils.get_field_component
tidy3d.plugins.invdes.utils.get_intensity
tidy3d.plugins.invdes.utils.sum_array
tidy3d.plugins.invdes.utils.sum_abs_squared
tidy3d.plugins.invdes.utils.get_phase
Design Space Exploration
tidy3d.plugins.design.parameter.Parameter
tidy3d.plugins.design.ParameterFloat
tidy3d.plugins.design.ParameterInt
tidy3d.plugins.design.ParameterAny
tidy3d.plugins.design.method.Method
tidy3d.plugins.design.MethodGrid
tidy3d.plugins.design.MethodMonteCarlo
tidy3d.plugins.design.MethodRandomCustom
tidy3d.plugins.design.MethodRandom
tidy3d.plugins.design.DesignSpace
tidy3d.plugins.design.Result
Waveguide
tidy3d.plugins.waveguide.RectangularDielectric
Microwave
tidy3d.plugins.microwave.AxisAlignedPathIntegral
tidy3d.plugins.microwave.VoltageIntegralAxisAligned
tidy3d.plugins.microwave.CurrentIntegralAxisAligned
tidy3d.plugins.microwave.CustomPathIntegral2D
tidy3d.plugins.microwave.CustomVoltageIntegral2D
tidy3d.plugins.microwave.CustomCurrentIntegral2D
tidy3d.plugins.microwave.ImpedanceCalculator
tidy3d.plugins.mode.ModeSolver
attrs
tidy3d.plugins.mode.ModeSolverData
attrs
tidy3d.plugins.dispersion.FastDispersionFitter
attrs
tidy3d.plugins.dispersion.AdvancedFastFitterParam
attrs
tidy3d.plugins.dispersion.DispersionFitter
attrs
tidy3d.plugins.dispersion.AdvancedFitterParam
attrs
tidy3d.plugins.dispersion.web.run
tidy3d.plugins.dispersion.StableDispersionFitter
attrs
tidy3d.plugins.polyslab.ComplexPolySlab
attrs
tidy3d.plugins.smatrix.ComponentModeler
attrs
tidy3d.plugins.smatrix.Port
attrs
tidy3d.plugins.smatrix.ModalPortDataArray
tidy3d.plugins.smatrix.TerminalComponentModeler
attrs
tidy3d.plugins.smatrix.LumpedPort
attrs
tidy3d.plugins.smatrix.LumpedPortDataArray
tidy3d.plugins.smatrix.CoaxialLumpedPort
attrs
tidy3d.plugins.resonance.ResonanceFinder
attrs
tidy3d.plugins.autograd.functions.threshold
tidy3d.plugins.autograd.functions.rescale
tidy3d.plugins.autograd.functions.morphological_gradient_external
tidy3d.plugins.autograd.functions.morphological_gradient_internal
tidy3d.plugins.autograd.functions.morphological_gradient
tidy3d.plugins.autograd.functions.grey_closing
tidy3d.plugins.autograd.functions.grey_opening
tidy3d.plugins.autograd.functions.grey_erosion
tidy3d.plugins.autograd.functions.grey_dilation
tidy3d.plugins.autograd.functions.pad
tidy3d.plugins.autograd.functions.convolve
tidy3d.plugins.autograd.utilities.chain
tidy3d.plugins.autograd.utilities.make_kernel
tidy3d.plugins.autograd.utilities.get_kernel_size_px
tidy3d.plugins.autograd.primitives.gaussian_filter
tidy3d.plugins.autograd.invdes.grey_indicator
tidy3d.plugins.autograd.invdes.make_circular_filter
tidy3d.plugins.autograd.invdes.make_conic_filter
tidy3d.plugins.autograd.invdes.make_curvature_penalty
tidy3d.plugins.autograd.invdes.make_erosion_dilation_penalty
tidy3d.plugins.autograd.invdes.make_filter
tidy3d.plugins.autograd.invdes.make_filter_and_project
tidy3d.plugins.autograd.invdes.ramp_projection
tidy3d.plugins.autograd.invdes.tanh_projection
tidy3d.plugins.autograd.types.PaddingType
tidy3d.plugins.autograd.types.KernelType
tidy3d.plugins.adjoint.web.run
tidy3d.plugins.adjoint.web.run_async
tidy3d.plugins.adjoint.JaxBox
attrs
tidy3d.plugins.adjoint.JaxPolySlab
attrs
tidy3d.plugins.adjoint.JaxComplexPolySlab
attrs
tidy3d.plugins.adjoint.JaxMedium
attrs
tidy3d.plugins.adjoint.JaxAnisotropicMedium
attrs
tidy3d.plugins.adjoint.JaxCustomMedium
attrs
tidy3d.plugins.adjoint.JaxStructure
attrs
tidy3d.plugins.adjoint.JaxSimulation
attrs
tidy3d.plugins.adjoint.JaxSimulationData
attrs
tidy3d.plugins.adjoint.JaxModeData
attrs
tidy3d.plugins.adjoint.JaxPermittivityDataset
attrs
tidy3d.plugins.adjoint.JaxDataArray
attrs
tidy3d.plugins.adjoint.utils.filter.ConicFilter
attrs
tidy3d.plugins.adjoint.utils.filter.BinaryProjector
attrs
tidy3d.plugins.adjoint.utils.penalty.RadiusPenalty
attrs
tidy3d.plugins.invdes.FilterProject
attrs
tidy3d.plugins.invdes.ErosionDilationPenalty
attrs
tidy3d.plugins.invdes.TopologyDesignRegion
attrs
tidy3d.plugins.invdes.InverseDesign
attrs
tidy3d.plugins.invdes.InverseDesignMulti
attrs
tidy3d.plugins.invdes.InverseDesignResult
attrs
tidy3d.plugins.invdes.AdamOptimizer
attrs
tidy3d.plugins.invdes.utils.get_amps
tidy3d.plugins.invdes.utils.get_field_component
tidy3d.plugins.invdes.utils.get_intensity
tidy3d.plugins.invdes.utils.sum_array
tidy3d.plugins.invdes.utils.sum_abs_squared
tidy3d.plugins.invdes.utils.get_phase
tidy3d.plugins.design.parameter.Parameter
attrs
tidy3d.plugins.design.ParameterFloat
attrs
tidy3d.plugins.design.ParameterInt
attrs
tidy3d.plugins.design.ParameterAny
attrs
tidy3d.plugins.design.method.Method
attrs
tidy3d.plugins.design.MethodGrid
attrs
tidy3d.plugins.design.MethodMonteCarlo
attrs
tidy3d.plugins.design.MethodRandomCustom
attrs
tidy3d.plugins.design.MethodRandom
attrs
tidy3d.plugins.design.DesignSpace
attrs
tidy3d.plugins.design.Result
attrs
tidy3d.plugins.waveguide.RectangularDielectric
attrs
tidy3d.plugins.microwave.AxisAlignedPathIntegral
attrs
tidy3d.plugins.microwave.VoltageIntegralAxisAligned
attrs
tidy3d.plugins.microwave.CurrentIntegralAxisAligned
attrs
tidy3d.plugins.microwave.CustomPathIntegral2D
attrs
tidy3d.plugins.microwave.CustomVoltageIntegral2D
attrs
tidy3d.plugins.microwave.CustomCurrentIntegral2D
attrs
tidy3d.plugins.microwave.ImpedanceCalculator
attrs
Constants
tidy3d.constants.C_0
tidy3d.constants.HBAR
tidy3d.constants.Q_e
tidy3d.constants.ETA_0
tidy3d.constants.EPSILON_0
tidy3d.constants.MU_0
tidy3d.constants.K_B
tidy3d.constants.inf
tidy3d.config.Tidy3dConfig
tidy3d.DefaultPMLParameters
tidy3d.DefaultStablePMLParameters
tidy3d.DefaultAbsorberParameters
tidy3d.constants.HERTZ
tidy3d.constants.TERAHERTZ
tidy3d.constants.SECOND
tidy3d.constants.PICOSECOND
tidy3d.constants.METER
tidy3d.constants.MICROMETER
tidy3d.constants.NANOMETER
tidy3d.constants.RADIAN
tidy3d.constants.CONDUCTIVITY
tidy3d.constants.PERMITTIVITY
tidy3d.constants.PML_SIGMA
tidy3d.constants.RADPERSEC
tidy3d.constants.ELECTRON_VOLT
tidy3d.constants.KELVIN
tidy3d.constants.PML_SIGMA
tidy3d.constants.CMCUBE
tidy3d.constants.PERCMCUBE
tidy3d.constants.WATT
tidy3d.constants.VOLT
tidy3d.constants.THERMAL_CONDUCTIVITY
tidy3d.constants.SPECIFIC_HEAT_CAPACITY
tidy3d.constants.HEAT_FLUX
tidy3d.constants.VOLUMETRIC_HEAT_RATE
tidy3d.constants.HEAT_TRANSFER_COEFF
tidy3d.constants.dp_eps
tidy3d.constants.fp_eps
tidy3d.constants.pec_val
tidy3d.constants.LARGE_NUMBER
tidy3d.constants.GLANCING_CUTOFF
Abstract Base Models
tidy3d.components.base_sim.data.sim_data.AbstractSimulationData
attrs
tidy3d.components.base_sim.monitor.AbstractMonitor
attrs
tidy3d.components.base_sim.simulation.AbstractSimulation
attrs
tidy3d.components.base_sim.source.AbstractSource
attrs
tidy3d.components.data.dataset.AbstractFieldDataset
attrs
tidy3d.components.data.monitor_data.AbstractFieldProjectionData
attrs
tidy3d.components.parameter_perturbation.AbstractPerturbation
attrs
tidy3d.components.parameter_perturbation.AbstractPerturbation
attrs
tidy3d.components.medium.AbstractCustomMedium
attrs
tidy3d.components.medium.AbstractMedium
attrs
tidy3d.components.simulation.AbstractYeeGridSimulation
attrs
tidy3d.components.structure.AbstractStructure
attrs
tidy3d.components.time.AbstractTimeDependence
attrs
Base Models
tidy3d.Geometry
attrs
tidy3d.components.base.Tidy3dBaseModel
attrs
tidy3d.components.boundary.AbsorberSpec
attrs
tidy3d.components.data.data_array.DataArray
tidy3d.components.data.dataset.FieldDataset
attrs
tidy3d.components.data.dataset.FieldTimeDataset
attrs
tidy3d.components.data.dataset.ModeSolverDataset
attrs
tidy3d.components.data.monitor_data.ElectromagneticFieldData
attrs
tidy3d.components.data.monitor_data.MonitorData
attrs
tidy3d.components.data.sim_data.SimulationData
attrs
tidy3d.components.geometry.base.Centered
attrs
tidy3d.components.geometry.base.Circular
attrs
tidy3d.components.geometry.base.Planar
attrs
tidy3d.components.geometry.base.SimplePlaneIntersection
attrs
tidy3d.components.grid.grid_spec.GridSpec1d
attrs
tidy3d.components.lumped_element.LumpedElement
attrs
tidy3d.components.medium.CustomDispersiveMedium
attrs
tidy3d.components.medium.DispersiveMedium
attrs
tidy3d.components.monitor.FreqMonitor
attrs
tidy3d.components.monitor.Monitor
attrs
tidy3d.components.monitor.PlanarMonitor
attrs
tidy3d.components.monitor.TimeMonitor
attrs
tidy3d.components.source.AngledFieldSource
attrs
tidy3d.components.source.BroadbandSource
attrs
tidy3d.components.source.CurrentSource
attrs
tidy3d.components.source.DirectionalSource
attrs
tidy3d.components.source.FieldSource
attrs
tidy3d.components.source.PlanarSource
attrs
tidy3d.components.source.Pulse
attrs
tidy3d.components.source.ReverseInterpolatedSource
attrs
tidy3d.components.source.Source
attrs
tidy3d.components.source.SourceTime
attrs
tidy3d.components.source.VolumeSource
attrs
tidy3d.Simulation
attrs
tidy3d.RunTimeSpec
attrs
tidy3d.BoundarySpec
attrs
tidy3d.Boundary
attrs
tidy3d.BoundaryEdge
attrs
tidy3d.Periodic
attrs
tidy3d.PECBoundary
attrs
tidy3d.PMCBoundary
attrs
tidy3d.BlochBoundary
attrs
tidy3d.PML
attrs
tidy3d.StablePML
attrs
tidy3d.Absorber
attrs
tidy3d.AbsorberParams
attrs
tidy3d.PMLParams
attrs
tidy3d.Box
attrs
tidy3d.Sphere
attrs
tidy3d.Cylinder
attrs
tidy3d.PolySlab
attrs
tidy3d.TriangleMesh
attrs
tidy3d.GeometryGroup
attrs
tidy3d.ClipOperation
attrs
tidy3d.Transformed
attrs
tidy3d.RotationAroundAxis
attrs
tidy3d.Medium
attrs
tidy3d.PECMedium
attrs
tidy3d.FullyAnisotropicMedium
attrs
tidy3d.CustomMedium
attrs
tidy3d.PoleResidue
attrs
tidy3d.Lorentz
attrs
tidy3d.Sellmeier
attrs
tidy3d.Drude
attrs
tidy3d.Debye
attrs
tidy3d.CustomPoleResidue
attrs
tidy3d.CustomLorentz
attrs
tidy3d.CustomSellmeier
attrs
tidy3d.CustomDrude
attrs
tidy3d.CustomDebye
attrs
tidy3d.PerturbationMedium
attrs
tidy3d.PerturbationPoleResidue
attrs
tidy3d.AnisotropicMedium
attrs
tidy3d.Medium2D
attrs
tidy3d.CustomAnisotropicMedium
attrs
tidy3d.NonlinearSpec
attrs
tidy3d.NonlinearSusceptibility
attrs
tidy3d.KerrNonlinearity
attrs
tidy3d.TwoPhotonAbsorption
attrs
tidy3d.ModulationSpec
tidy3d.SpaceTimeModulation
tidy3d.ContinuousWaveTimeModulation
tidy3d.SpaceModulation
Material Library
tidy3d.Graphene
tidy3d.components.medium.AbstractPerturbationMedium
tidy3d.components.medium.NonlinearModel
tidy3d.Structure
attrs
tidy3d.MeshOverrideStructure
attrs
tidy3d.PointDipole
attrs
tidy3d.UniformCurrentSource
attrs
tidy3d.PlaneWave
attrs
tidy3d.ModeSource
attrs
tidy3d.GaussianBeam
attrs
tidy3d.AstigmaticGaussianBeam
attrs
tidy3d.CustomFieldSource
attrs
tidy3d.CustomCurrentSource
attrs
tidy3d.TFSF
attrs
tidy3d.GaussianPulse
attrs
tidy3d.ContinuousWave
attrs
tidy3d.CustomSourceTime
attrs
tidy3d.FieldMonitor
attrs
tidy3d.FieldTimeMonitor
attrs
tidy3d.FluxMonitor
attrs
tidy3d.FluxTimeMonitor
attrs
tidy3d.ModeMonitor
attrs
tidy3d.ModeSolverMonitor
attrs
tidy3d.PermittivityMonitor
attrs
tidy3d.FieldProjectionCartesianMonitor
attrs
tidy3d.FieldProjectionAngleMonitor
attrs
tidy3d.FieldProjectionKSpaceMonitor
attrs
tidy3d.DiffractionMonitor
attrs
tidy3d.ApodizationSpec
attrs
tidy3d.ModeSpec
attrs
tidy3d.FieldProjectionSurface
attrs
tidy3d.FieldProjector
attrs
tidy3d.LumpedResistor
attrs
tidy3d.CoaxialLumpedResistor
attrs
tidy3d.GridSpec
attrs
tidy3d.AutoGrid
attrs
tidy3d.UniformGrid
attrs
tidy3d.CustomGrid
attrs
tidy3d.CustomGridBoundaries
attrs
tidy3d.Coords
attrs
tidy3d.FieldGrid
attrs
tidy3d.YeeGrid
attrs
tidy3d.Grid
attrs
tidy3d.SubpixelSpec
attrs
tidy3d.Staircasing
attrs
tidy3d.VolumetricAveraging
attrs
tidy3d.HeuristicPECStaircasing
attrs
tidy3d.PolarizedAveraging
attrs
tidy3d.PECConformal
attrs
tidy3d.SimulationData
tidy3d.log
attrs
tidy3d.FieldData
attrs
tidy3d.FieldTimeData
attrs
tidy3d.ModeSolverData
attrs
tidy3d.PermittivityData
attrs
tidy3d.FluxData
attrs
tidy3d.FluxTimeData
attrs
tidy3d.ModeData
attrs
tidy3d.FieldProjectionAngleData
attrs
tidy3d.FieldProjectionCartesianData
attrs
tidy3d.FieldProjectionKSpaceData
attrs
tidy3d.DiffractionData
attrs
tidy3d.SpatialDataArray
tidy3d.PermittivityDataset
attrs
tidy3d.ScalarFieldDataArray
tidy3d.ScalarModeFieldDataArray
tidy3d.ScalarFieldTimeDataArray
tidy3d.ModeAmpsDataArray
tidy3d.ModeIndexDataArray
tidy3d.FluxDataArray
tidy3d.FluxTimeDataArray
tidy3d.FieldProjectionAngleDataArray
tidy3d.FieldProjectionCartesianDataArray
tidy3d.FieldProjectionKSpaceDataArray
tidy3d.DiffractionDataArray
tidy3d.Scene
attrs
tidy3d.log
tidy3d.set_logging_level
tidy3d.set_logging_file
tidy3d.web.api.webapi.run
tidy3d.web.api.webapi.upload
tidy3d.web.api.webapi.estimate_cost
tidy3d.web.api.webapi.real_cost
tidy3d.web.api.webapi.get_info
tidy3d.web.api.webapi.start
tidy3d.web.api.webapi.monitor
tidy3d.web.api.webapi.download
tidy3d.web.api.webapi.load
tidy3d.web.api.webapi.delete
tidy3d.web.api.webapi.download_log
tidy3d.web.api.webapi.download_json
tidy3d.web.api.webapi.load_simulation
tidy3d.web.api.asynchronous.run_async
tidy3d.web.api.container.Job
attrs
tidy3d.web.api.container.Batch
attrs
tidy3d.web.api.container.BatchData
attrs
tidy3d.web.core.task_info.TaskInfo
tidy3d.web.core.task_info.TaskStatus
tidy3d.web.api.mode.run
tidy3d.web.api.mode.run_batch
tidy3d.web.api.mode.ModeSolverTask
Simulation
tidy3d.Simulation
attrs
tidy3d.RunTimeSpec
attrs
Mediums
tidy3d.Medium
attrs
tidy3d.PECMedium
attrs
tidy3d.FullyAnisotropicMedium
attrs
tidy3d.CustomMedium
attrs
tidy3d.PoleResidue
attrs
tidy3d.Lorentz
attrs
tidy3d.Sellmeier
attrs
tidy3d.Drude
attrs
tidy3d.Debye
attrs
tidy3d.CustomPoleResidue
attrs
tidy3d.CustomLorentz
attrs
tidy3d.CustomSellmeier
attrs
tidy3d.CustomDrude
attrs
tidy3d.CustomDebye
attrs
tidy3d.PerturbationMedium
attrs
tidy3d.PerturbationPoleResidue
attrs
tidy3d.AnisotropicMedium
attrs
tidy3d.Medium2D
attrs
tidy3d.CustomAnisotropicMedium
attrs
tidy3d.NonlinearSpec
attrs
tidy3d.NonlinearSusceptibility
attrs
tidy3d.KerrNonlinearity
attrs
tidy3d.TwoPhotonAbsorption
attrs
tidy3d.ModulationSpec
tidy3d.SpaceTimeModulation
tidy3d.ContinuousWaveTimeModulation
tidy3d.SpaceModulation
Material Library
tidy3d.Graphene
tidy3d.components.medium.AbstractPerturbationMedium
tidy3d.components.medium.NonlinearModel
Boundary Conditions
tidy3d.BoundarySpec
attrs
tidy3d.Boundary
attrs
tidy3d.BoundaryEdge
attrs
tidy3d.Periodic
attrs
tidy3d.PECBoundary
attrs
tidy3d.PMCBoundary
attrs
tidy3d.BlochBoundary
attrs
tidy3d.PML
attrs
tidy3d.StablePML
attrs
tidy3d.Absorber
attrs
tidy3d.AbsorberParams
attrs
tidy3d.PMLParams
attrs
Discretization
tidy3d.GridSpec
attrs
tidy3d.AutoGrid
attrs
tidy3d.UniformGrid
attrs
tidy3d.CustomGrid
attrs
tidy3d.CustomGridBoundaries
attrs
tidy3d.Coords
attrs
tidy3d.FieldGrid
attrs
tidy3d.YeeGrid
attrs
tidy3d.Grid
attrs
Output Data
tidy3d.SimulationData
tidy3d.log
attrs
tidy3d.FieldData
attrs
tidy3d.FieldTimeData
attrs
tidy3d.ModeSolverData
attrs
tidy3d.PermittivityData
attrs
tidy3d.FluxData
attrs
tidy3d.FluxTimeData
attrs
tidy3d.ModeData
attrs
tidy3d.FieldProjectionAngleData
attrs
tidy3d.FieldProjectionCartesianData
attrs
tidy3d.FieldProjectionKSpaceData
attrs
tidy3d.DiffractionData
attrs
tidy3d.SpatialDataArray
tidy3d.PermittivityDataset
attrs
tidy3d.ScalarFieldDataArray
tidy3d.ScalarModeFieldDataArray
tidy3d.ScalarFieldTimeDataArray
tidy3d.ModeAmpsDataArray
tidy3d.ModeIndexDataArray
tidy3d.FluxDataArray
tidy3d.FluxTimeDataArray
tidy3d.FieldProjectionAngleDataArray
tidy3d.FieldProjectionCartesianDataArray
tidy3d.FieldProjectionKSpaceDataArray
tidy3d.DiffractionDataArray
Mediums
tidy3d.Medium
attrs
tidy3d.PECMedium
attrs
tidy3d.FullyAnisotropicMedium
attrs
tidy3d.CustomMedium
attrs
tidy3d.PoleResidue
attrs
tidy3d.Lorentz
attrs
tidy3d.Sellmeier
attrs
tidy3d.Drude
attrs
tidy3d.Debye
attrs
tidy3d.CustomPoleResidue
attrs
tidy3d.CustomLorentz
attrs
tidy3d.CustomSellmeier
attrs
tidy3d.CustomDrude
attrs
tidy3d.CustomDebye
attrs
tidy3d.PerturbationMedium
attrs
tidy3d.PerturbationPoleResidue
attrs
tidy3d.AnisotropicMedium
attrs
tidy3d.Medium2D
attrs
tidy3d.CustomAnisotropicMedium
attrs
tidy3d.NonlinearSpec
attrs
tidy3d.NonlinearSusceptibility
attrs
tidy3d.KerrNonlinearity
attrs
tidy3d.TwoPhotonAbsorption
attrs
tidy3d.ModulationSpec
tidy3d.SpaceTimeModulation
tidy3d.ContinuousWaveTimeModulation
tidy3d.SpaceModulation
Material Library
tidy3d.Graphene
tidy3d.components.medium.AbstractPerturbationMedium
tidy3d.components.medium.NonlinearModel
Simulation
tidy3d.Simulation
attrs
tidy3d.RunTimeSpec
attrs
Output Data
tidy3d.SimulationData
tidy3d.log
attrs
tidy3d.FieldData
attrs
tidy3d.FieldTimeData
attrs
tidy3d.ModeSolverData
attrs
tidy3d.PermittivityData
attrs
tidy3d.FluxData
attrs
tidy3d.FluxTimeData
attrs
tidy3d.ModeData
attrs
tidy3d.FieldProjectionAngleData
attrs
tidy3d.FieldProjectionCartesianData
attrs
tidy3d.FieldProjectionKSpaceData
attrs
tidy3d.DiffractionData
attrs
tidy3d.SpatialDataArray
tidy3d.PermittivityDataset
attrs
tidy3d.ScalarFieldDataArray
tidy3d.ScalarModeFieldDataArray
tidy3d.ScalarFieldTimeDataArray
tidy3d.ModeAmpsDataArray
tidy3d.ModeIndexDataArray
tidy3d.FluxDataArray
tidy3d.FluxTimeDataArray
tidy3d.FieldProjectionAngleDataArray
tidy3d.FieldProjectionCartesianDataArray
tidy3d.FieldProjectionKSpaceDataArray
tidy3d.DiffractionDataArray
tidy3d.constants.C_0
tidy3d.constants.HBAR
tidy3d.constants.Q_e
tidy3d.constants.ETA_0
tidy3d.constants.EPSILON_0
tidy3d.constants.MU_0
tidy3d.constants.K_B
tidy3d.constants.inf
tidy3d.config.Tidy3dConfig
tidy3d.DefaultPMLParameters
tidy3d.DefaultStablePMLParameters
tidy3d.DefaultAbsorberParameters
tidy3d.constants.HERTZ
tidy3d.constants.TERAHERTZ
tidy3d.constants.SECOND
tidy3d.constants.PICOSECOND
tidy3d.constants.METER
tidy3d.constants.MICROMETER
tidy3d.constants.NANOMETER
tidy3d.constants.RADIAN
tidy3d.constants.CONDUCTIVITY
tidy3d.constants.PERMITTIVITY
tidy3d.constants.PML_SIGMA
tidy3d.constants.RADPERSEC
tidy3d.constants.ELECTRON_VOLT
tidy3d.constants.KELVIN
tidy3d.constants.PML_SIGMA
tidy3d.constants.CMCUBE
tidy3d.constants.PERCMCUBE
tidy3d.constants.WATT
tidy3d.constants.VOLT
tidy3d.constants.THERMAL_CONDUCTIVITY
tidy3d.constants.SPECIFIC_HEAT_CAPACITY
tidy3d.constants.HEAT_FLUX
tidy3d.constants.VOLUMETRIC_HEAT_RATE
tidy3d.constants.HEAT_TRANSFER_COEFF
tidy3d.constants.dp_eps
tidy3d.constants.fp_eps
tidy3d.constants.pec_val
tidy3d.constants.LARGE_NUMBER
tidy3d.constants.GLANCING_CUTOFF
tidy3d.components.base_sim.data.sim_data.AbstractSimulationData
attrs
tidy3d.components.base_sim.monitor.AbstractMonitor
attrs
tidy3d.components.base_sim.simulation.AbstractSimulation
attrs
tidy3d.components.base_sim.source.AbstractSource
attrs
tidy3d.components.data.dataset.AbstractFieldDataset
attrs
tidy3d.components.data.monitor_data.AbstractFieldProjectionData
attrs
tidy3d.components.parameter_perturbation.AbstractPerturbation
attrs
tidy3d.components.parameter_perturbation.AbstractPerturbation
attrs
tidy3d.components.medium.AbstractCustomMedium
attrs
tidy3d.components.medium.AbstractMedium
attrs
tidy3d.components.simulation.AbstractYeeGridSimulation
attrs
tidy3d.components.structure.AbstractStructure
attrs
tidy3d.components.time.AbstractTimeDependence
attrs
tidy3d.Geometry
attrs
tidy3d.components.base.Tidy3dBaseModel
attrs
tidy3d.components.boundary.AbsorberSpec
attrs
tidy3d.components.data.data_array.DataArray
tidy3d.components.data.dataset.FieldDataset
attrs
tidy3d.components.data.dataset.FieldTimeDataset
attrs
tidy3d.components.data.dataset.ModeSolverDataset
attrs
tidy3d.components.data.monitor_data.ElectromagneticFieldData
attrs
tidy3d.components.data.monitor_data.MonitorData
attrs
tidy3d.components.data.sim_data.SimulationData
attrs
tidy3d.components.geometry.base.Centered
attrs
tidy3d.components.geometry.base.Circular
attrs
tidy3d.components.geometry.base.Planar
attrs
tidy3d.components.geometry.base.SimplePlaneIntersection
attrs
tidy3d.components.grid.grid_spec.GridSpec1d
attrs
tidy3d.components.lumped_element.LumpedElement
attrs
tidy3d.components.medium.CustomDispersiveMedium
attrs
tidy3d.components.medium.DispersiveMedium
attrs
tidy3d.components.monitor.FreqMonitor
attrs
tidy3d.components.monitor.Monitor
attrs
tidy3d.components.monitor.PlanarMonitor
attrs
tidy3d.components.monitor.TimeMonitor
attrs
tidy3d.components.source.AngledFieldSource
attrs
tidy3d.components.source.BroadbandSource
attrs
tidy3d.components.source.CurrentSource
attrs
tidy3d.components.source.DirectionalSource
attrs
tidy3d.components.source.FieldSource
attrs
tidy3d.components.source.PlanarSource
attrs
tidy3d.components.source.Pulse
attrs
tidy3d.components.source.ReverseInterpolatedSource
attrs
tidy3d.components.source.Source
attrs
tidy3d.components.source.SourceTime
attrs
tidy3d.components.source.VolumeSource
attrs
Development Guide 🛠️
An Introduction to the Development Flow
Understanding Virtual Environments
Using
poetry
for package management
Code Quality Principles
tidy3d
Project Structure
Development Environment Installation
Using the Development Flow
Recommendations
Release Flow
Feature Contribution
Releasing a new
tidy3d
version
Documentation Release
Notebooks Development
Documentation
Changelog ⏪
About our Solver
Repository
Open issue
.rst
.pdf
tidy3d.DefaultPMLParameters
Contents
DefaultPMLParameters
tidy3d.DefaultPMLParameters
#
DefaultPMLParameters
#
Inherited Common Usage
