Models

Model classes

• photonforge.Model Abstract model class to calculate a component’s S matrix.
• photonforge.AnalyticDirectionalCouplerModel Analytic model for a 4-port directional coupler.
• photonforge.AnalyticMZIModel Analytic model for a 4-port Mach-Zehnder interferometer.
• photonforge.AnalyticWaveguideModel Analytic model for waveguides, bends, and EO modulators.
• photonforge.BraggGratingModel Waveguide Bragg grating from coupled-mode theory.
• photonforge.CircuitModel Model based on circuit-level S-parameter calculation.
• photonforge.CirculatorModel Data model for a 3-port circulator.
• photonforge.CrossingModel Data model for a 4-port waveguide crossing.
• photonforge.DataModel Model based on existing S matrix data.
• photonforge.DirectionalCouplerCircuitModel Model for directional couplers based on circuit decomposition.
• photonforge.DirectionalCouplerModel Data model for a 4-port directional coupler.
• photonforge.DualRingModel Dual ring resonator/modulator model with single or double bus.
• photonforge.EMEModel S matrix model based on Eigenmode Expansion calculation.
• photonforge.IsolatorModel Data model for a 2-port isolator.
• photonforge.MultimodeInterferometerModel Multimode interference coupler, from the solved modes of its own cross-section.
• photonforge.MuxDemuxModel Wavelength multiplexer/demultiplexer (WDM).
• photonforge.PolarizationBeamSplitterModel Data model for a 3-port polarization beam splitter.
• photonforge.PolarizationModeDispersionModel Frequency-dependent Jones matrix of a randomly birefringent fibre.
• photonforge.PolarizationSplitterRotatorModel Data model for a polarization splitter rotator.
• photonforge.PowerSplitterModel Data model for a 3-port power splitter.
• photonforge.RingModel Analytic ring resonator/modulator model with single or double bus.
• photonforge.TerminationModel Data model for a 1-port device.
• photonforge.Tidy3DModel S matrix model based on Tidy3D FDTD calculation.
• photonforge.TwoPortModel Data model for a 2-port component.
• photonforge.WaveguideModel Data model for straight waveguides.

Lumped Model classes

• photonforge.LumpedModel Abstract lumped model class for computing MNA (Modified Nodal Analysis) stamps.
• photonforge.Capacitor Two-terminal capacitor.
• photonforge.IdealTransformer Ideal transformer with turns ratio n:1.
• photonforge.IdealTransmissionLine Lossless transmission line.
• photonforge.Inductor Two-terminal inductor.
• photonforge.ParallelRLC Parallel RLC circuit between two terminals.
• photonforge.Resistor Two-terminal resistor.
• photonforge.SeriesRLC Series RLC circuit between two terminals.

Helper classes

• photonforge.MNAMatrix Modified Nodal Analysis (MNA) matrix.
• photonforge.PoleResidueMatrix Pole-residue representation of an S matrix.
• photonforge.SMatrix S matrix object.
• photonforge.Tidy3DAutogradConfig Configuration for Tidy3D-specific autograd finite-difference behavior.
• photonforge.YMatrix Nodal admittance matrix (Y matrix).
• photonforge.ZMatrix Nodal impedance matrix (Z matrix).

Helper functions

• photonforge.abort_pending_tasks Abort all known pending Tidy3D pending tasks.
• photonforge.dispersion_from_beta2 Convert $\beta_2$, $\beta_3$ to PhotonForge’s D and S.
• photonforge.franz_keldysh_absorption Franz-Keldysh absorption table for a bulk electro-absorber.
• photonforge.frequency_classification Return a classification for the frequencies: “optical” or “electrical”.
• photonforge.load_snp Load an S matrix from a Touchstone (snp) file.
• photonforge.pole_residue_fit Fit S matrix elements with rational functions sharing a set of poles.
• photonforge.register_model_class Register a model class derived from Model.
• photonforge.s_to_y_matrix Convert an S-matrix (scattering matrix) to a Y-matrix (admittance matrix).
• photonforge.s_to_z_matrix Convert an S-matrix (scattering matrix) to a Z-matrix (impedance matrix).
• photonforge.y_to_s_matrix Convert a Y-matrix (admittance matrix) to an S-matrix (scattering matrix).
• photonforge.y_to_z_matrix Convert a Y-matrix (admittance matrix) to a Z-matrix (impedance matrix).
• photonforge.z_to_s_matrix Convert a Z-matrix (impedance matrix) to an S-matrix (scattering matrix).
• photonforge.z_to_y_matrix Convert a Z-matrix (impedance matrix) to a Y-matrix (admittance matrix).

Caching

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