API Reference
Contents
API Reference#
Simulation#
Simulation#
Contains all information about Tidy3d simulation. |
Boundary Conditions#
Specifies boundary conditions on each side of the domain and along each dimension. |
|
Boundary conditions at the minus and plus extents along a dimension |
|
Electromagnetic boundary condition at a domain edge. |
Types of Boundaries#
Periodic boundary condition class. |
|
Perfect electric conductor boundary condition class. |
|
Perfect magnetic conductor boundary condition class. |
|
Specifies a Bloch boundary condition along a single dimension. |
Absorbing Boundaries#
Types of Absorbers#
Specifies a standard PML along a single dimension. |
|
Specifies a 'stable' PML along a single dimension. |
|
Specifies an adiabatic absorber along a single dimension. |
Absorber Parameters#
Specifies parameters common to Absorbers and PMLs. |
|
Specifies full set of parameters needed for complex, frequency-shifted PML. |
Geometry#
Rectangular prism. |
|
Spherical geometry. |
|
Cylindrical geometry with optional sidewall angle along axis direction. |
|
Polygon extruded with optional sidewall angle along axis direction. |
|
A collection of Geometry objects that can be called as a single geometry object. |
Mediums#
Non-Dispersive Medium#
Dispersionless medium. |
|
Diagonally anisotropic medium. |
|
Perfect electrical conductor class. |
|
|
Dispersive Mediums#
A dispersive medium described by the pole-residue pair model. |
|
A dispersive medium described by the Lorentz model. |
|
A dispersive medium described by the Sellmeier model. |
|
A dispersive medium described by the Drude model. |
|
A dispersive medium described by the Debye model. |
Material Library#
- Material Library
- Alumina (“Al2O3”)
- Aluminum (“Al”)
- Aluminum Arsenide (“AlAs”)
- Aluminum Gallium Nitride (“AlGaN”)
- Aluminum Nitride (“AlN”)
- Aluminum Oxide (“AlxOy”)
- Amino Acid (“Aminoacid”)
- Amorphous Silicon (“aSi”)
- Beryllium (“Be”)
- Calcium Fluoride (“CaF2”)
- Cellulose (“Cellulose”)
- Chromium (“Cr”)
- Copper (“Cu”)
- Crystalline Silicon (“cSi”)
- Fused Silica (“FusedSilica”)
- Gallium Arsenide (“GaAs”)
- Germanium (“Ge”)
- Germanium Oxide (“GeOx”)
- Gold (“Au”)
- Hafnium Oxide (“HfO2”)
- Hexamethyldisilazane, or Bis(trimethylsilyl)amine (“HMDS”)
- Indium Phosphide (“InP”)
- Indium Tin Oxide (“ITO”)
- Magnesium Fluoride (“MgF2”)
- Magnesium Oxide (“MgO”)
- N-BK7 Borosilicate Glass (“BK7”)
- Nickel (“Ni”)
- Palladium (“Pd”)
- Platinum (“Pt”)
- Poly(methyl Methacrylate) (“PMMA”)
- Polycarbonate (“Polycarbonate”)
- Polyetherimide (“PEI”)
- Polyethylene Naphthalate (“PEN”)
- Polyethylene Terephthalate (“PET”)
- Polystyrene (“Polystyrene”)
- Polytetrafluoroethylene, or Teflon (“PTFE”)
- Polyvinyl Chloride (“PVC”)
- Sapphire (“Sapphire”)
- Silicon Carbide (“SiC”)
- Silicon Dioxide (“SiO2”)
- Silicon Mononitride (“SiN”)
- Silicon Nitride (“Si3N4”)
- Silicon Oxynitride (“SiON”)
- Silver (“Ag”)
- Tantalum Pentoxide (“Ta2O5”)
- Titanium (“Ti”)
- Titanium Oxide (“TiOx”)
- Tungsten (“W”)
- Water (“H2O”)
- Yttrium Aluminium Garnet (“YAG”)
- Yttrium Oxide (“Y2O3”)
- Zirconium Oxide (“ZrO2”)
Structures#
Defines a physical object that interacts with the electromagnetic fields. |
|
Defines an object that is only used in the process of generating the mesh. |
Sources#
Types of Sources#
Uniform current source with a zero size. |
|
Source in a rectangular volume with uniform time dependence. |
|
Uniform current distribution on an infinite extent plane. |
|
Injects current source to excite modal profile on finite extent plane. |
|
Guassian distribution on finite extent plane. |
|
This class implements the simple astigmatic Gaussian beam described in Kochkina et al., Applied Optics, vol. |
|
Implements a source corresponding to an input dataset containing |
Source Time Dependence#
Source time dependence that describes a Gaussian pulse. |
Monitors#
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Mode Specifications#
Stores specifications for the mode solver to find an electromagntic mode. |
Discretization#
Collective grid specification for all three dimensions. |
|
Specification for non-uniform grid along a given dimension. |
|
Uniform 1D grid. |
|
Custom 1D grid supplied as a list of grid cell sizes centered on the simulation center. |
|
Holds data about a set of x,y,z positions on a grid. |
|
Holds the grid data for a single field. |
|
Holds the yee grid coordinates for each of the E and H positions. |
|
Contains all information about the spatial positions of the FDTD grid. |
Field Projector#
Data structure to store surface monitors where near fields are recorded for field projections. |
|
Projection of near fields to points on a given observation grid. |
Output Data#
All Data for a Simulation#
Stores data from a collection of |
Collections of Data from single monitor#
Data associated with a |
|
Data associated with a |
|
Data associated with a |
|
Data for a |
|
Data associated with a |
|
Data associated with a |
|
Data associated with a |
|
Data associated with a |
|
Data associated with a |
|
Data associated with a |
|
Data for a |
Individual Datasets#
Dataset storing the diagonal components of the permittivity tensor. |
|
|
Spatial distribution in the frequency-domain. |
|
Spatial distribution of a mode in frequency-domain as a function of mode index. |
|
Spatial distribution in the time-domain. |
|
Forward and backward propagating complex-valued mode amplitudes. |
|
Complex-valued effective propagation index of a mode. |
|
Flux through a surface in the frequency-domain. |
|
Flux through a surface in the time-domain. |
|
Far fields in frequency domain as a function of angles theta and phi. |
|
Far fields in frequency domain as a function of local x and y coordinates. |
|
Far fields in frequency domain as a function of normalized kx and ky vectors on the observation plane. |
|
Diffraction power amplitudes as a function of diffraction orders and frequency. |
Logging#
Instances of the Logger class represent a single logging channel. |
|
|
Raise a warning here instead of setting the logging level. |
|
Set a file to write log to, independently from the stdout and stderr output chosen using |
Submitting Simulations#
Through python API#
|
Submits a |
|
Upload simulation to server, but do not start running |
|
Compute the maximum flex unit charge for a given task, assuming the simulation runs for the full |
|
Return information about a task. |
|
Start running the simulation associated with task. |
|
Print the real time task progress until completion. |
|
Download results of task and log to file. |
|
Download and Load simultion results into |
|
Delete server-side data associated with task. |
|
Download the tidy3d log file associated with a task. |
|
Download the .json file associated with the |
|
Download the .json file of a task and load the associated |
Convenience for Single and Batch#
Interface for managing the running of a |
|
Interface for submitting several |
|
Holds a collection of |
Information Containers#
general information about task |
|
|
the statuses that the task can be in |
Plugins#
Mode Solver#
Interface for solving electromagnetic eigenmodes in a 2D plane with translational invariance in the third dimension. |
Dispersive Model Fitting#
Tool for fitting refractive index data to get a dispersive medium described by |
|
Stable fitter based on web service |
|
Advanced fitter parameters |
Scattering Matrix Calculator#
Tool for modeling devices and computing scattering matrix elements. |
|
Specifies a port in the scattering matrix. |
Resonance Finder#
Tool that extracts resonance information from a time series of the form shown below. |
Adjoint#
Mocking original web.run function, using regular tidy3d components. |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
|
A |
Constants#
Physical Constants#
Double-precision floating-point number type, compatible with Python float and C |
|
Convert a string or number to a floating point number, if possible. |
|
Convert a string or number to a floating point number, if possible. |
|
Double-precision floating-point number type, compatible with Python float and C |
|
Convert a string or number to a floating point number, if possible. |
|
Convert a string or number to a floating point number, if possible. |
Tidy3D Special Constants#
Convert a string or number to a floating point number, if possible. |
|
Perfect electrical conductor class. |
Tidy3D Configuration#
configuration of tidy3d |
Default Absorber Parameters#
Specifies full set of parameters needed for complex, frequency-shifted PML. |
|
Specifies full set of parameters needed for complex, frequency-shifted PML. |
|
Specifies parameters common to Absorbers and PMLs. |
Abstract Models#
These are classes that are used to organize the tidy3d components, but aren’t to be used directly in the code. Documented here mainly for reference.
Base pydantic model that all Tidy3d components inherit from. |
|
Specifies the generic absorber properties along a single dimension. |
|
A medium within which electromagnetic waves propagate. |
|
A Medium with dispersion (propagation characteristics depend on frequency) |
|
Abstract base class, defines where something exists in space. |
|
Geometry with one |
|
Geometry with circular characteristics (specified by a radius). |
|
Base class describing the time dependence of a source. |
|
Abstract base class for all sources. |
|
A Source defined by the desired E and/or H fields. |
|
Abstract base class for monitors. |