API 💻

• Simulation
  • Overview
  • Defining a FDTD Simulation
  • Submitting a Simulation
  • Batch Jobs
  • Other Simulation Types
  • Logging
  • Additional Methods
• Geometry
  • Overview
  • Primitives
  • Boolean Operations
  • Spatial Transformations
  • Geometry Groups
  • Working with GDS
  • Working with Trimesh and STL
• Structure and Scene
  • Overview
  • Structure
  • Scene
• EM Mediums
  • Overview
  • Non-Dispersive
  • Dispersive
  • Anisotropic
  • Metallic/PEC/PMC
  • Spatial Variation
  • Perturbation (Multiphysics)
  • Nonlinearity
  • Spatio-temporal Modulation
• Material Library
  • Silver (“Ag”)
  • Aluminum (“Al”)
  • Alumina (“Al2O3”)
  • Aluminum Arsenide (“AlAs”)
  • Aluminum Gallium Nitride (“AlGaN”)
  • Aluminum Nitride (“AlN”)
  • Aluminum Oxide (“AlxOy”)
  • Amino Acid (“Aminoacid”)
  • Silicon (Amorphous) (“aSi”)
  • Gold (“Au”)
  • Beryllium (“Be”)
  • N-BK7 Borosilicate Glass (“BK7”)
  • Calcium Fluoride (“CaF2”)
  • Cellulose (“Cellulose”)
  • Chromium (“Cr”)
  • Silicon (Crystalline) (“cSi”)
  • Copper (“Cu”)
  • Fused Silica (“FusedSilica”)
  • Gallium Arsenide (“GaAs”)
  • Germanium (“Ge”)
  • Germanium Oxide (“GeOx”)
  • Graphene (“graphene”)
  • Water (“H2O”)
  • Hafnium Oxide (“HfO2”)
  • Hexamethyldisilazane, or Bis(trimethylsilyl)amine (“HMDS”)
  • Indium Arsenide (“InAs”)
  • Indium Phosphide (“InP”)
  • Indium Tin Oxide (“ITO”)
  • Lithium niobate (“LiNbO3”)
  • Magnesium Fluoride (“MgF2”)
  • Magnesium Oxide (“MgO”)
  • Molybdenum Disulfide (“MoS2”)
  • Molybdenum Diselenide (“MoSe2”)
  • Nickel (“Ni”)
  • Palladium (“Pd”)
  • Polyetherimide (“PEI”)
  • Polyethylene Naphthalate (“PEN”)
  • Polyethylene Terephthalate (“PET”)
  • Poly(methyl Methacrylate) (“PMMA”)
  • Polycarbonate (“Polycarbonate”)
  • Polystyrene (“Polystyrene”)
  • Platinum (“Pt”)
  • Polytetrafluoroethylene, or Teflon (“PTFE”)
  • Polyvinyl Chloride (“PVC”)
  • Sapphire (“Sapphire”)
  • Silicon Nitride (“Si3N4”)
  • Silicon Carbide (“SiC”)
  • Silicon Mononitride (“SiN”)
  • Silicon Dioxide (“SiO2”)
  • Silicon Oxynitride (“SiON”)
  • Tantalum Pentoxide (“Ta2O5”)
  • Titanium (“Ti”)
  • Titanium Oxide (“TiOx”)
  • Tungsten (“W”)
  • Tungsten Disulfide (“WS2”)
  • Tungsten Diselenide (“WSe2”)
  • Yttrium Oxide (“Y2O3”)
  • Yttrium Aluminium Garnet (“YAG”)
  • Zirconium Oxide (“ZrO2”)
• RF Material Library
  • ArlonAD255C (“AD255C”)
  • FR4 (“FR4”)
  • Rogers3003 (“RO3003”)
  • Rogers3010 (“RO3010”)
  • Rogers4003C (“RO4003C”)
  • Rogers4350B (“RO4350B”)
• Boundary Conditions
  • Overview
  • Boundary Specification
  • PEC/PMC
  • Periodic
  • Absorbing
• Grid Discretization
  • Overview
  • Grid Specification
  • Refinement
  • Subpixel Averaging
  • Utility Classes
• Sources
  • Overview
  • Source Time Dependence
  • Dipole and Uniform Current
  • Plane Wave
  • Gaussian Beam
  • Mode Source
  • Total-Field/Scattered-Field (TFSF)
  • User-defined
• Monitors
  • Overview
  • Field
  • Flux
  • Mode
  • Diffraction
  • Far-field
  • Permittivity
  • Apodization
• Output Data
  • Overview
  • The SimulationData Object
  • The BatchData Object
  • List of Monitor Data Types
  • List of Dataset Types
• Analytic Beams
  • tidy3d.PlaneWaveBeamProfile
  • tidy3d.GaussianBeamProfile
  • tidy3d.AstigmaticGaussianBeamProfile
• Utilities
  • tidy3d.RunTimeSpec
  • tidy3d.FreqRange
  • tidy3d.FrequencyUtils
  • tidy3d.frequencies
  • tidy3d.wavelengths
• Unstructured mesh 🕸️
  • Grid Specification
  • Volume mesher
  • Mesh monitors
  • Output Data
• Heat 🔥
  • Simulation
  • Material Thermal
  • Thermal Perturbation Specification
  • Boundary Conditions
  • Thermal Sources
  • Monitors
  • Output Data
• Charge ⚡
  • Simulation
  • Charge Mediums
  • Charge Carrier Properties
  • Boundary Conditions
  • Thermal Sources
  • Monitors
  • Output Data
• EME 🌈
  • Simulation
  • Grid Specification
  • Monitors
  • Propagation Sweeps
  • Output Data
• Microwave 📡
  • Output Data
• Lumped Elements
  • Passive elements
• Plugins
  • Mode Solver
  • Dispersive Model Fitting
  • Self-intersecting Polyslab
  • Scattering Matrix Calculator
  • Resonance Finder
  • Automatic Differentiation with Autograd
  • Adjoint
  • Inverse Design Plugin
  • Design Space Exploration
  • Waveguide
  • Microwave
  • KLayout Integration
• SPICE 🔌
  • Sources
  • Analysis
• Constants
  • Physical Constants
  • Tidy3D Special Constants
  • Tidy3D Configuration
  • Default Absorber Parameters
  • Units
  • Precision & Comparator Values
• Abstract Base Classes
  • tidy3d.components.base_sim.data.sim_data.AbstractSimulationData
  • tidy3d.components.base_sim.monitor.AbstractMonitor
  • tidy3d.components.base_sim.simulation.AbstractSimulation
  • tidy3d.components.base_sim.source.AbstractSource
  • tidy3d.components.data.dataset.AbstractFieldDataset
  • tidy3d.components.data.monitor_data.AbstractFieldProjectionData
  • tidy3d.components.parameter_perturbation.AbstractPerturbation
  • tidy3d.components.parameter_perturbation.AbstractPerturbation
  • tidy3d.components.medium.AbstractCustomMedium
  • tidy3d.components.medium.AbstractMedium
  • tidy3d.components.simulation.AbstractYeeGridSimulation
  • tidy3d.components.structure.AbstractStructure
  • tidy3d.components.time.AbstractTimeDependence
• Base Classes
  • tidy3d.Geometry
  • tidy3d.components.geometry.base.Centered
  • tidy3d.components.geometry.base.Planar
  • tidy3d.components.geometry.base.Circular
  • tidy3d.components.medium.AbstractMedium
  • tidy3d.components.medium.AbstractCustomMedium
  • tidy3d.components.medium.DispersiveMedium
  • tidy3d.components.medium.CustomDispersiveMedium
  • tidy3d.components.structure.AbstractStructure
  • tidy3d.components.monitor.Monitor
  • tidy3d.components.monitor.FreqMonitor
  • tidy3d.components.monitor.TimeMonitor
  • tidy3d.components.monitor.AbstractFieldMonitor
  • tidy3d.components.monitor.AbstractFluxMonitor
  • tidy3d.components.monitor.PlanarMonitor
  • tidy3d.components.monitor.AbstractFieldProjectionMonitor
  • tidy3d.components.lumped_element.LumpedElement
  • tidy3d.components.lumped_element.RectangularLumpedElement
  • tidy3d.components.grid.grid_spec.GridSpec1d
  • tidy3d.components.data.sim_data.AbstractYeeGridSimulationData
  • tidy3d.components.data.sim_data.SimulationData
  • tidy3d.components.base.Tidy3dBaseModel
  • tidy3d.components.boundary.AbsorberSpec
  • tidy3d.components.data.data_array.DataArray
  • tidy3d.components.data.dataset.FieldDataset
  • tidy3d.components.data.dataset.FieldTimeDataset
  • tidy3d.components.data.dataset.ModeSolverDataset
  • tidy3d.components.data.monitor_data.ElectromagneticFieldData
  • tidy3d.components.data.monitor_data.MonitorData
  • tidy3d.components.data.sim_data.SimulationData
  • tidy3d.components.geometry.base.Centered
  • tidy3d.components.geometry.base.Circular
  • tidy3d.components.geometry.base.Planar
  • tidy3d.components.geometry.base.SimplePlaneIntersection
  • tidy3d.components.grid.grid_spec.GridSpec1d
  • tidy3d.components.lumped_element.LumpedElement
  • tidy3d.components.medium.CustomDispersiveMedium
  • tidy3d.components.medium.DispersiveMedium
  • tidy3d.components.monitor.FreqMonitor
  • tidy3d.components.monitor.Monitor
  • tidy3d.components.monitor.PlanarMonitor
  • tidy3d.components.monitor.TimeMonitor
• Visualization and Plotting
  • tidy3d.restore_matplotlib_rcparams
  • tidy3d.VisualizationSpec