API documentation¶
Mode Solvers¶
Functions¶
use_gnuplot() |
Use gnuplot as the plotting tool for any mode related outputs. |
use_matplotlib() |
Use matplotlib as the plotting tool for any mode related outputs. |
with_metaclass(meta, *bases) |
Create a base class with a metaclass. |
Classes¶
ModeSolverFullyVectorial(n_eigs[, tol, …]) |
A fully-vectorial mode solver object used to setup and run a mode solving simulation. |
ModeSolverSemiVectorial(n_eigs[, tol, …]) |
A semi-vectorial mode solver object used to setup and run a mode solving simulation. |
Class Inheritance Diagram¶
Pre-defined Structures¶
Functions¶
use_gnuplot() |
Use gnuplot as the plotting tool for any structure related outputs. |
use_matplotlib() |
Use matplotlib as the plotting tool for any structure related outputs. |
Classes¶
RidgeWaveguide(wavelength, x_step, y_step, …) |
A general ridge waveguide structure. |
WgArray(wavelength, x_step, y_step, …[, …]) |
Class Inheritance Diagram¶
Structure Creation¶
Functions¶
use_gnuplot() |
Use gnuplot as the plotting tool for any structure related outputs. |
use_matplotlib() |
Use matplotlib as the plotting tool for any structure related outputs. |
with_metaclass(meta, *bases) |
Create a base class with a metaclass. |
Classes¶
Slab(name, x_step, y_step, x_max, y_max, …) |
A Slab represents a horizontal slice of the refractive index profile. |
Slabs(wavelength, y_step, x_step, x_max[, x_min]) |
Class to implement device refractive index profile cross-section designs. |
Structure(x_step, y_step, x_max, y_max[, …]) |
|
StructureAni(structure_xx, structure_yy, …) |
Anisottropic structure object. |
Class Inheritance Diagram¶
Design Tools¶
Functions¶
directional_coupler_lc(wavelength_nm, …) |
Calculates the coherence length (100% power transfer) of a directional coupler. |
grating_coupler_period(wavelength, n_eff, …) |
Calculate the period needed for a grating coupler. |
loss(n, wavelength) |
|
qpm_period(pmp_n, pmp_l, sig_n, sig_l, …) |
|
qpm_wavenumber(pmp_n, pmp_l, sig_n, sig_l, …) |
Coupling Efficiency¶
Functions¶
coupling_efficiency(mode_solver, fibre_mfd) |
Finds the coupling efficiency between a solved fundamental mode and a fibre of given MFD. |
reflection(n1, n2) |
Calculate the power reflection at the interface of two refractive index materials. |
transmission(n1, n2) |
Calculate the power transmission at the interface of two refractive index materials. |