API Reference

Simulation

Simulation

Simulation

Contains all information about Tidy3d simulation.

Boundary Conditions

BoundarySpec	Specifies boundary conditions on each side of the domain and along each dimension.
Boundary	Boundary conditions at the minus and plus extents along a dimension
BoundaryEdge	Electromagnetic boundary condition at a domain edge.

Types of Boundaries

Periodic	Periodic boundary condition class.
PECBoundary	Perfect electric conductor boundary condition class.
PMCBoundary	Perfect magnetic conductor boundary condition class.
BlochBoundary	Specifies a Bloch boundary condition along a single dimension.

Absorbing Boundaries

Types of Absorbers

PML	Specifies a standard PML along a single dimension.
StablePML	Specifies a 'stable' PML along a single dimension.
Absorber	Specifies an adiabatic absorber along a single dimension.

Absorber Parameters

AbsorberParams	Specifies parameters common to Absorbers and PMLs.
PMLParams	Specifies full set of parameters needed for complex, frequency-shifted PML.

Geometry

Box	Rectangular prism.
Sphere	Spherical geometry.
Cylinder	Cylindrical geometry with optional sidewall angle along axis direction.
PolySlab	Polygon extruded with optional sidewall angle along axis direction.
TriangleMesh	Custom surface geometry given by a triangle mesh, as in the STL file format.
GeometryGroup	A collection of Geometry objects that can be called as a single geometry object.

Mediums

Non-Dispersive Medium

Medium	Dispersionless medium.
PECMedium	Perfect electrical conductor class.
CustomMedium	Medium with user-supplied permittivity distribution.

Dispersive Mediums

PoleResidue	A dispersive medium described by the pole-residue pair model.
Lorentz	A dispersive medium described by the Lorentz model.
Sellmeier	A dispersive medium described by the Sellmeier model.
Drude	A dispersive medium described by the Drude model.
Debye	A dispersive medium described by the Debye model.

General Mediums (can be both dispersive and non-dispersive)

AnisotropicMedium	Diagonally anisotropic medium.
Medium2D	2D diagonally anisotropic medium.

Material Library

• Material Library
  • Silver (“Ag”)
  • Aluminum (“Al”)
  • Alumina (“Al2O3”)
  • Aluminum Arsenide (“AlAs”)
  • Aluminum Gallium Nitride (“AlGaN”)
  • Aluminum Nitride (“AlN”)
  • Aluminum Oxide (“AlxOy”)
  • Amino Acid (“Aminoacid”)
  • Amorphous Silicon (“aSi”)
  • Gold (“Au”)
  • Beryllium (“Be”)
  • N-BK7 Borosilicate Glass (“BK7”)
  • Calcium Fluoride (“CaF2”)
  • Cellulose (“Cellulose”)
  • Chromium (“Cr”)
  • Crystalline Silicon (“cSi”)
  • Copper (“Cu”)
  • Fused Silica (“FusedSilica”)
  • Gallium Arsenide (“GaAs”)
  • Germanium (“Ge”)
  • Germanium Oxide (“GeOx”)
  • Graphene (“graphene”)
    • tidy3d.Graphene
  • Water (“H2O”)
  • Hafnium Oxide (“HfO2”)
  • Hexamethyldisilazane, or Bis(trimethylsilyl)amine (“HMDS”)
  • Indium Phosphide (“InP”)
  • Indium Tin Oxide (“ITO”)
  • 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”)

Structures

Structure	Defines a physical object that interacts with the electromagnetic fields.
MeshOverrideStructure	Defines an object that is only used in the process of generating the mesh.

Sources

Types of Sources

PointDipole	Uniform current source with a zero size.
UniformCurrentSource	Source in a rectangular volume with uniform time dependence.
PlaneWave	Uniform current distribution on an infinite extent plane.
ModeSource	Injects current source to excite modal profile on finite extent plane.
GaussianBeam	Guassian distribution on finite extent plane.
AstigmaticGaussianBeam	This class implements the simple astigmatic Gaussian beam described in Kochkina et al., Applied Optics, vol.
CustomFieldSource	Implements a source corresponding to an input dataset containing E and H fields.
TFSF	Total field scattered field with a plane wave field in a volume.

Source Time Dependence

GaussianPulse

Source time dependence that describes a Gaussian pulse.

Monitors

Monitor Types

FieldMonitor	Monitor that records electromagnetic fields in the frequency domain.
FieldTimeMonitor	Monitor that records electromagnetic fields in the time domain.
FluxMonitor	Monitor that records power flux in the frequency domain.
FluxTimeMonitor	Monitor that records power flux in the time domain.
ModeMonitor	Monitor that records amplitudes from modal decomposition of fields on plane.
ModeSolverMonitor	Monitor that stores the mode field profiles returned by the mode solver in the monitor plane.
PermittivityMonitor	Monitor that records the diagonal components of the complex-valued relative permittivity tensor in the frequency domain.
FieldProjectionCartesianMonitor	Monitor that samples electromagnetic near fields in the frequency domain and projects them on a Cartesian observation plane.
FieldProjectionAngleMonitor	Monitor that samples electromagnetic near fields in the frequency domain and projects them at given observation angles.
FieldProjectionKSpaceMonitor	Monitor that samples electromagnetic near fields in the frequency domain and projects them on an observation plane defined in k-space.
DiffractionMonitor	Monitor that uses a 2D Fourier transform to compute the diffraction amplitudes and efficiency for allowed diffraction orders.

Apodization Specification

ApodizationSpec

Stores specifications for the apodizaton of frequency-domain monitors.

Mode Specifications

ModeSpec

Stores specifications for the mode solver to find an electromagntic mode.

Discretization

GridSpec	Collective grid specification for all three dimensions.
AutoGrid	Specification for non-uniform grid along a given dimension.
UniformGrid	Uniform 1D grid.
CustomGrid	Custom 1D grid supplied as a list of grid cell sizes centered on the simulation center.
Coords	Holds data about a set of x,y,z positions on a grid.
FieldGrid	Holds the grid data for a single field.
YeeGrid	Holds the yee grid coordinates for each of the E and H positions.
Grid	Contains all information about the spatial positions of the FDTD grid.

Field Projector

FieldProjectionSurface	Data structure to store surface monitors where near fields are recorded for field projections.
FieldProjector	Projection of near fields to points on a given observation grid.

Output Data

All Data for a Simulation

SimulationData

Stores data from a collection of Monitor objects in a Simulation.

Collections of Data from single monitor

FieldData	Data associated with a FieldMonitor: scalar components of E and H fields.
FieldTimeData	Data associated with a FieldTimeMonitor: scalar components of E and H fields.
ModeSolverData	Data associated with a ModeSolverMonitor: scalar components of E and H fields.
PermittivityData	Data for a PermittivityMonitor: diagonal components of the permittivity tensor.
FluxData	Data associated with a FluxMonitor: flux data in the frequency-domain.
FluxTimeData	Data associated with a FluxTimeMonitor: flux data in the time-domain.
ModeData	Data associated with a ModeMonitor: modal amplitudes and propagation indices.
FieldProjectionAngleData	Data associated with a FieldProjectionAngleMonitor: components of projected fields.
FieldProjectionCartesianData	Data associated with a FieldProjectionCartesianMonitor: components of projected fields.
FieldProjectionKSpaceData	Data associated with a FieldProjectionKSpaceMonitor: components of projected fields.
DiffractionData	Data for a DiffractionMonitor: complex components of diffracted far fields.

Individual Datasets

PermittivityDataset	Dataset storing the diagonal components of the permittivity tensor.
ScalarFieldDataArray(data, coords, ...)	Spatial distribution in the frequency-domain.
ScalarModeFieldDataArray(data, coords, ...)	Spatial distribution of a mode in frequency-domain as a function of mode index.
ScalarFieldTimeDataArray(data, coords, ...)	Spatial distribution in the time-domain.
ModeAmpsDataArray(data, coords, ...)	Forward and backward propagating complex-valued mode amplitudes.
ModeIndexDataArray(data, coords, ...)	Complex-valued effective propagation index of a mode.
FluxDataArray(data, coords, ...)	Flux through a surface in the frequency-domain.
FluxTimeDataArray(data, coords, ...)	Flux through a surface in the time-domain.
FieldProjectionAngleDataArray(data, coords, ...)	Far fields in frequency domain as a function of angles theta and phi.
FieldProjectionCartesianDataArray(data, ...)	Far fields in frequency domain as a function of local x and y coordinates.
FieldProjectionKSpaceDataArray(data, coords, ...)	Far fields in frequency domain as a function of normalized kx and ky vectors on the observation plane.
DiffractionDataArray(data, coords, ...)	Diffraction power amplitudes as a function of diffraction orders and frequency.

Logging

log	Custom logger to avoid the complexities of the logging module
set_logging_level(level)	Raise a warning here instead of setting the logging level.
set_logging_file(fname[, filemode, level])	Set a file to write log to, independently from the stdout and stderr output chosen using set_logging_level().

Submitting Simulations

Through python API

tidy3d.web.run(simulation, task_name[, ...])	Submits a Simulation to server, starts running, monitors progress, downloads, and loads results as a SimulationData object.
tidy3d.web.upload(simulation, task_name[, ...])	Upload simulation to server, but do not start running Simulation.
tidy3d.web.estimate_cost(task_id)	Compute the maximum FlexCredit charge for a given task.
tidy3d.web.real_cost(task_id)	Get the billed cost for given task after it has been run.
tidy3d.web.get_info(task_id)	Return information about a task.
tidy3d.web.start(task_id[, solver_version, ...])	Start running the simulation associated with task.
tidy3d.web.monitor(task_id[, verbose])	Print the real time task progress until completion.
tidy3d.web.download(task_id[, path, ...])	Download results of task and log to file.
tidy3d.web.load(task_id[, path, ...])	Download and Load simultion results into SimulationData object.
tidy3d.web.delete(task_id)	Delete server-side data associated with task.
tidy3d.web.download_log(task_id[, path, ...])	Download the tidy3d log file associated with a task.
tidy3d.web.download_json(task_id[, path, ...])	Download the .json file associated with the Simulation of a given task.
tidy3d.web.load_simulation(task_id[, path, ...])	Download the .json file of a task and load the associated Simulation.
tidy3d.web.run_async(simulations[, ...])	Submits a set of Simulation objects to server, starts running, monitors progress, downloads, and loads results as a BatchData object.

Convenience for Single and Batch

tidy3d.web.Job	Interface for managing the running of a Simulation on server.
tidy3d.web.Batch	Interface for submitting several Simulation objects to sever.
tidy3d.web.BatchData	Holds a collection of SimulationData returned by Batch.

Information Containers

tidy3d.web.task.TaskInfo	General information about task.
tidy3d.web.task.TaskStatus(value)	The statuses that the task can be in.

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.DispersionFitter	Tool for fitting refractive index data to get a dispersive medium described by PoleResidue model.
tidy3d.plugins.dispersion.StableDispersionFitter	Stable fitter based on web service
tidy3d.plugins.dispersion.AdvancedFitterParam	Advanced fitter parameters

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

tidy3d.plugins.adjoint.run	Submits a JaxSimulation to server, starts running, monitors progress, downloads, and loads results as a JaxSimulationData object.
tidy3d.plugins.adjoint.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.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 compability.

Constants

Physical Constants

tidy3d.C_0	Convert a string or number to a floating point number, if possible.
tidy3d.HBAR	Convert a string or number to a floating point number, if possible.
tidy3d.Q_e	Convert a string or number to a floating point number, if possible.
tidy3d.ETA_0	Double-precision floating-point number type, compatible with Python float and C double.
tidy3d.EPSILON_0	Convert a string or number to a floating point number, if possible.
tidy3d.MU_0	Convert a string or number to a floating point number, if possible.

Tidy3D Special Constants

tidy3d.inf	Convert a string or number to a floating point number, if possible.
tidy3d.PEC	Perfect electrical conductor class.

Tidy3D Configuration

tidy3d.config.Tidy3dConfig

configuration of tidy3d

Default Absorber Parameters

tidy3d.DefaultPMLParameters	Specifies full set of parameters needed for complex, frequency-shifted PML.
tidy3d.DefaultStablePMLParameters	Specifies full set of parameters needed for complex, frequency-shifted PML.
tidy3d.DefaultAbsorberParameters	Specifies parameters common to Absorbers and PMLs.

Abstract Models

These are some classes that are used to organize the tidy3d components, but aren’t to be used directly in the code. Documented here mainly for reference.

tidy3d.components.base.Tidy3dBaseModel	Base pydantic model that all Tidy3d components inherit from.
tidy3d.components.boundary.AbsorberSpec	Specifies the generic absorber properties along a single dimension.
tidy3d.components.medium.AbstractMedium	A medium within which electromagnetic waves propagate.
tidy3d.components.medium.DispersiveMedium	A Medium with dispersion (propagation characteristics depend on frequency)
tidy3d.components.geometry.Geometry	Abstract base class, defines where something exists in space.
tidy3d.components.geometry.Planar	Geometry with one axis that is slab-like with thickness height.
tidy3d.components.geometry.Circular	Geometry with circular characteristics (specified by a radius).
tidy3d.components.source.SourceTime	Base class describing the time dependence of a source.
tidy3d.components.source.Source	Abstract base class for all sources.
tidy3d.components.source.FieldSource	A Source defined by the desired E and/or H fields.
tidy3d.components.monitor.Monitor	Abstract base class for monitors.