API Documentation¶
Modules list¶
constants |
Physical constants. |
fiber |
A Fiber represents a physical fiber (material and geometry). |
fiber.material |
A material describes the refractive index of a layer as function of Wavelength. |
fiber.geometry |
A geometry describes a function applied to the refractive index, as function of the radial position. |
fiber.solver |
A solver gives the function used to find cutoff and/or effective index of a given Mode in a given fibermodes.fiber.fiber.Fiber. |
field |
Electromagnetic fields computation. |
functions |
Miscellaneous mathematical functions. |
mode |
Fiber mode representations, and utility functions. |
simulator |
Simulators are used to sweep over different Fiber parameters, and to solve for Mode using those parameters. |
slrc |
Scalar, list, range or code object. |
wavelength |
Easy wavelength units conversion. |
Module contents¶
This package provides tools for solving modes in different kind of optical fibers.
The following classes can be imported directly from fibermodes. All those classes are imported if using import *
Classes
FiberFactory([filename]) |
FiberFactory is used to instantiate a Fiber or a series of Fiber objects. |
Mode |
Fiber mode representation. |
HE11 |
Predefined HE(1,1) mode |
LP01 |
Predefined LP(0,1) mode |
ModeFamily |
alias of Family |
Simulator([factory, wavelengths, numax, ...]) |
The Simulator links FiberFactory with a list of wavelengths, and provides a convenient way to compute a range of modal properties. |
PSimulator(*args, **kwargs) |
|
Wavelength |
Easy wavelength units conversion class. |