Toggle navigation sidebar
Toggle in-page Table of Contents
Installation instructions
Tidy3D Example Library
FDTD 101
Inverse design in photonics
Quickstart
Tidy3D first walkthrough
Introduction on Tidy3D working principles
Running simulations through the cloud
How to troubleshoot a diverged FDTD simulation
Modeling dispersive materials
Fitting dispersive material models
Defining fully anisotropic materials
Defining gyrotropic materials
Defining spatially-varying dielectric structures
Applying time modulation to materials
Importing GDS files
Importing STL files
Defining self-intersecting polygons
Defining common integrated photonic components
Defining common photonic crystal structures
Defining complex geometries using trimesh
Using automatic nonuniform meshing
Defining and using symmetries
Setting up boundary conditions
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
Visualizing geometries in Tidy3D
Performing visualization of simulation data
Advanced monitor data manipulation and visualization
Creating FDTD animations
Performing near field to far field projections
Using the mode solver for optical mode analysis
Using the waveguide plugin to analyze waveguide modes
Performing parallel / batch processing of simulations
Computing the scattering matrix of a device
Extracting resonance information using Resonance Finder
Cavity quality factor, effective mode volume, and Purcell factor
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
Heat solver
Thermally tuned waveguide
Thermally tuned ring resonator
Building a simple, Python-based GUI for Tidy3D
Waveguide Y junction
Waveguide to ring coupling
Waveguide crossing based on cosine tapers
Euler waveguide bend
Inverse taper edge coupler
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
Particle swarm optimization of a polarization beam splitter
Particle swarm optimization of a bullseye cavity for quantum emitter light extraction
Plasmonic waveguide sensor for carbon dioxide detection
Bi-layer SiN edge coupler in the visible frequency
Dielectric waveguide with scale-invariant effective index
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
Band structure calculation of a photonic crystal slab
Optimized photonic crystal L3 cavity
Bistability in photonic crystal microcavities
Scattering cross-section calculation of a dielectric sphere
Scattering of a plasmonic nanoparticle
Plasmonic Yagi-Uda nanoantenna
Field projection for a zone plate
3D optical Luneburg lens
Metalens in the visible frequency range
Spherical Fresnel lens
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
Frequently Asked Questions
How do I …
API Reference
tidy3d.Simulation
tidy3d.BoundarySpec
tidy3d.Boundary
tidy3d.BoundaryEdge
tidy3d.Periodic
tidy3d.PECBoundary
tidy3d.PMCBoundary
tidy3d.BlochBoundary
tidy3d.PML
tidy3d.StablePML
tidy3d.Absorber
tidy3d.AbsorberParams
tidy3d.PMLParams
tidy3d.Box
tidy3d.Sphere
tidy3d.Cylinder
tidy3d.PolySlab
tidy3d.TriangleMesh
tidy3d.GeometryGroup
tidy3d.ClipOperation
tidy3d.RotationAroundAxis
tidy3d.Medium
tidy3d.PECMedium
tidy3d.FullyAnisotropicMedium
tidy3d.CustomMedium
tidy3d.PoleResidue
tidy3d.Lorentz
tidy3d.Sellmeier
tidy3d.Drude
tidy3d.Debye
tidy3d.CustomPoleResidue
tidy3d.CustomLorentz
tidy3d.CustomSellmeier
tidy3d.CustomDrude
tidy3d.CustomDebye
tidy3d.AnisotropicMedium
tidy3d.Medium2D
tidy3d.CustomAnisotropicMedium
tidy3d.NonlinearSpec
tidy3d.NonlinearSusceptibility
tidy3d.KerrNonlinearity
tidy3d.TwoPhotonAbsorption
tidy3d.ModulationSpec
tidy3d.SpaceTimeModulation
tidy3d.ContinuousWaveTimeModulation
tidy3d.SpaceModulation
tidy3d.PerturbationMedium
tidy3d.PerturbationPoleResidue
tidy3d.ParameterPerturbation
tidy3d.LinearHeatPerturbation
tidy3d.CustomHeatPerturbation
tidy3d.LinearChargePerturbation
tidy3d.CustomChargePerturbation
Material Library
tidy3d.Graphene
tidy3d.Structure
tidy3d.MeshOverrideStructure
tidy3d.PointDipole
tidy3d.UniformCurrentSource
tidy3d.PlaneWave
tidy3d.ModeSource
tidy3d.GaussianBeam
tidy3d.AstigmaticGaussianBeam
tidy3d.CustomFieldSource
tidy3d.CustomCurrentSource
tidy3d.TFSF
tidy3d.GaussianPulse
tidy3d.ContinuousWave
tidy3d.CustomSourceTime
tidy3d.FieldMonitor
tidy3d.FieldTimeMonitor
tidy3d.FluxMonitor
tidy3d.FluxTimeMonitor
tidy3d.ModeMonitor
tidy3d.ModeSolverMonitor
tidy3d.PermittivityMonitor
tidy3d.FieldProjectionCartesianMonitor
tidy3d.FieldProjectionAngleMonitor
tidy3d.FieldProjectionKSpaceMonitor
tidy3d.DiffractionMonitor
tidy3d.ApodizationSpec
tidy3d.ModeSpec
tidy3d.GridSpec
tidy3d.AutoGrid
tidy3d.UniformGrid
tidy3d.CustomGrid
tidy3d.Coords
tidy3d.FieldGrid
tidy3d.YeeGrid
tidy3d.Grid
tidy3d.FieldProjectionSurface
tidy3d.FieldProjector
tidy3d.SimulationData
tidy3d.FieldData
tidy3d.FieldTimeData
tidy3d.ModeSolverData
tidy3d.PermittivityData
tidy3d.FluxData
tidy3d.FluxTimeData
tidy3d.ModeData
tidy3d.FieldProjectionAngleData
tidy3d.FieldProjectionCartesianData
tidy3d.FieldProjectionKSpaceData
tidy3d.DiffractionData
tidy3d.SpatialDataArray
tidy3d.PermittivityDataset
tidy3d.ScalarFieldDataArray
tidy3d.ScalarModeFieldDataArray
tidy3d.ScalarFieldTimeDataArray
tidy3d.ModeAmpsDataArray
tidy3d.ModeIndexDataArray
tidy3d.FluxDataArray
tidy3d.FluxTimeDataArray
tidy3d.FieldProjectionAngleDataArray
tidy3d.FieldProjectionCartesianDataArray
tidy3d.FieldProjectionKSpaceDataArray
tidy3d.DiffractionDataArray
tidy3d.Scene
tidy3d.HeatSimulation
tidy3d.FluidSpec
tidy3d.SolidSpec
tidy3d.HeatBoundarySpec
tidy3d.TemperatureBC
tidy3d.ConvectionBC
tidy3d.HeatFluxBC
tidy3d.StructureStructureInterface
tidy3d.StructureBoundary
tidy3d.MediumMediumInterface
tidy3d.StructureSimulationBoundary
tidy3d.SimulationBoundary
tidy3d.UniformHeatSource
tidy3d.UniformUnstructuredGrid
tidy3d.DistanceUnstructuredGrid
tidy3d.TemperatureMonitor
tidy3d.TemperatureData
tidy3d.HeatSimulationData
tidy3d.log
tidy3d.set_logging_level
tidy3d.set_logging_file
tidy3d.web.run
tidy3d.web.upload
tidy3d.web.estimate_cost
tidy3d.web.real_cost
tidy3d.web.get_info
tidy3d.web.start
tidy3d.web.monitor
tidy3d.web.download
tidy3d.web.load
tidy3d.web.delete
tidy3d.web.download_log
tidy3d.web.download_json
tidy3d.web.load_simulation
tidy3d.web.run_async
tidy3d.web.Job
tidy3d.web.Batch
tidy3d.web.BatchData
tidy3d.web.core.task_info.TaskInfo
tidy3d.web.core.task_info.TaskStatus
tidy3d.plugins.mode.ModeSolver
tidy3d.plugins.mode.ModeSolverData
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
tidy3d.plugins.polyslab.ComplexPolySlab
tidy3d.plugins.smatrix.ComponentModeler
tidy3d.plugins.smatrix.Port
tidy3d.plugins.smatrix.SMatrixDataArray
tidy3d.plugins.resonance.ResonanceFinder
tidy3d.plugins.adjoint.web.run
tidy3d.plugins.adjoint.web.run_async
tidy3d.plugins.adjoint.JaxBox
tidy3d.plugins.adjoint.JaxPolySlab
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
tidy3d.plugins.waveguide.RectangularDielectric
tidy3d.C_0
tidy3d.HBAR
tidy3d.Q_e
tidy3d.ETA_0
tidy3d.EPSILON_0
tidy3d.MU_0
tidy3d.inf
tidy3d.PEC
tidy3d.config.Tidy3dConfig
tidy3d.DefaultPMLParameters
tidy3d.DefaultStablePMLParameters
tidy3d.DefaultAbsorberParameters
tidy3d.components.base.Tidy3dBaseModel
tidy3d.components.boundary.AbsorberSpec
tidy3d.components.medium.AbstractMedium
tidy3d.components.medium.DispersiveMedium
tidy3d.NonlinearModel
tidy3d.Geometry
tidy3d.components.geometry.base.Planar
tidy3d.components.geometry.base.Circular
tidy3d.components.source.SourceTime
tidy3d.components.source.Source
tidy3d.components.source.FieldSource
tidy3d.components.monitor.Monitor
Changelog
Tidy3D Solver Technology
repository
open issue
.rst
.pdf
tidy3d.HBAR
tidy3d.HBAR
#
tidy3d.
HBAR
=
6.582119569e-16
#
Convert a string or number to a floating point number, if possible.
