Models

Classes

CircuitModel([mesh_refinement, verbose])	Model based on circuit-level S-parameter calculation.
DataModel([s_matrix, s_array, frequencies, ...])	Model based on existing S matrix data.
DirectionalCouplerModel([t, c, i, r, ports])	Analytic model for a 4-port directional coupler
EMEModel(eme_grid_spec[, medium, symmetry, ...])	S matrix model based on Eigenmode Expansion calculation.
Model()	Abstract model class to calculate a component's S matrix.
ModelResult(s_matrix[, status])	Convenience class to return S matrix results immediately.
PowerSplitterModel([t, i, r0, r1, ports])	Analytic model for a 3-port power splitter.
SMatrix(frequencies, elements[, ports])	S matrix object.
TerminationModel([r])	Analytic model for a 1-port device.
Tidy3DModel([run_time, medium, symmetry, ...])	S matrix model based on Tidy3D FDTD calculation.
TwoPortModel([t, r0, r1, ports])	Analytic model for a 2-port component.
WaveguideModel([n_complex, length, ...])	Analytic model for straight waveguides.

Time domain

PoleResidueMatrix(poles, residues[, ...])	Pole-residue representation of an S matrix.
TimeDomainModel(pole_residue_matrix, time_step)	Time-domain model based on a pole-residue representation of an S matrix.

Functions

abort_pending_tasks()	Abort all known pending Tidy3D pending tasks.
frequency_classification(frequencies)	Return a classification for the frequencies: "optical" or "electrical".
load_snp(filename)	Load an S matrix from a Touchstone (snp) file.
pole_residue_fit(s_matrix[, initial_poles, ...])	Fit S matrix elements with rational functions sharing a set of poles.
register_model_class(*model_classes)	Register a model class derived from Model.

Caching

cache_s_matrix(start)	Decorator that can be used in Model.start() to cache results.
cache.clear_cache()	Clear the runtime caches, but not the file cache.
cache.cache_capacity(capacity)	Set the runtime cache capacity.