API Reference¶
Simulation¶
|
Main class for building a simulation model. |
List containing all materials included in the simulation. |
|
List containing all |
|
List containing all |
|
List containing all |
|
|
Compute the complex relative permittivity inside a volume. |
|
Change the value of the run time of the simulation and the time step determined by the courant stability factor. |
Saving and loading¶
|
Load all monitor data recorded from a Tidy3D run. |
Return a dictionary with all simulation parameters and objects. |
|
|
Export the simulation specification to a JSON file. |
|
Import a simulation specification from a JSON file. |
Material¶
|
Base class for a custom defined material. |
|
Evaluate the (complex) relative permittivity of the medium. |
Perfect electric conductor. |
A library of pre-defined materials. |
Dispersive models¶
|
Base class for a model of material dispersion. |
|
Sellmeier dispersion refractive index model. |
|
Create a 1-pole Sellmeier model from dispersion data. |
|
Lorentz dispersion permittivity model. |
|
Debye dispersion permittivity model. |
|
Drude dispersion permittivity model. |
Fitting optical data¶
|
|
|
Fits data a number of times and returns best results. |
|
Make plot of model vs data, at a set of wavelengths (if supplied). |
|
Loads nk data from file, performs validation on input. |
|
Loads txt file with (num_poles, 2) complex array data into |
Structure¶
|
Base class for regions defined by geometric shapes in a simulation domain. |
|
Box structure, i.e. a 3D rectangular axis-aligned prism. |
|
Sphere structure. |
|
Cylinder structure. |
|
A structure defined as polygon in x and y, and extruded in z. |
|
A structure defined through a GDS cell imported through |
Source¶
|
Base class for defining spatial profiles of excitation conditions. |
|
A source specified as an electric or a magnetic current of a fixed component (one of |
|
A source specified as an electric or a magnetic current of a fixed component (one of |
|
Eigenmode source spanning a 2D cross section of a given size inside a |
|
Plane-wave source with a specified direction and polarization, spanning the whole 2D simulation cross-section at a given position normal to a given injection axis. |
|
Plane-wave source with a specified direction and polarization, spanning the whole simulation cross-section at a given position and axis normal. |
|
Compute the eigenmodes of the 2D cross-section of a |
|
Set the index of the mode to be used by the mode source. |
|
Returns the spectrum of a |
Time dependence¶
Base class for the time dependence of a source. |
|
|
Source with a Gaussian-envelope time dependence. |
Monitor¶
|
Base class for defining field monitors. |
|
Monitor recording the time-domain fields within a 3D region. |
|
Monitor recording a discrete Fourier transform of the fields within a 3D region, for a given list of frequencies. |
|
|
|
Compute the eigenmodes of the 2D cross-section of a |
|
Set the parameters for the modes to be used in the modal decomposition in the monitor. |
Simulation Outputs¶
|
Return a dictionary with all the stored data in a |
|
Compute the area-integrated Poynting flux in a given direction. |
|
Compute the Poynting vector at every point recorded by a |
|
Compute the decomposition of the fields recorded in a |
Near Field to Far Field¶
|
Near field to far field transformation tool. |
|
Get fields at a point relative to monitor center in cartesian coordintes. |
|
Get fields at a point relative to monitor center in spherical coordintes. |
|
Get power scattered to a point relative to monitor center in cartesian coordinates. |
|
Get power scattered to a point relative to monitor center in spherical coordinates. |
|
Get radar cross section at a point relative to monitor center in units of incident power. |
Plotting tools¶
|
Plot the real part of the relative permittivity distribution of a 2D cross-section of the simulation. |
|
Plot both the time and frequency dependence of a source. |
|
Plot the time dependence of a source. |
|
Plot the frequency dependence of a source. |
|
Plot a 2D cross-section of a field stored in a |
|
Plot the field distribution of the 2D eigenmodes of a |
Web API¶
|
Create new project. |
|
Get all project details from a given task_id. |
|
Delete a project from a given task_id. |
|
Monitor the status of a given project every second. |
|
Print a summary of all projects of the current user, in chronological order of submission. |
|
Download the project json file |
|
Download the results of a solver run, including the json file defining the simulation, a single file containing all the monitor data, and a log file. |
|
Runs a simulation and loads the results. |
|
Loads results from web to simulation. |
Job Management¶
|
Container for single simulation and associated task. |
|
Loads a Job from it’s task id. |
Returns dictionary containing |
|
Deletes the |
|
Prints status of |
|
|
Downloads data to |
|
Download the json file associated with this job to |
|
Download the job results to |
Batch Management¶
|
Container for processing set of simulations. |
|
Save |
|
Load a |
|
Load a |
Return list of dictionaries storing |
|
Delete all jobs in |
|
Monitor progress of |
|
downloads results and either loads into list of simulations or returns list of new simulations |
|
Downalod json file of each |
|
Downalod data of each |
Miscellaneous¶
|
Computes the frequency spectrum associated to a time series directly using the discrete fourier transform. |
Set the default logging configuration. |
|
|
Set a file to write log to, independently from the stdout and stderr output chosen using |
|
Set the lowest severity level to print to the console, as per the python logger. |