fibermodes.simulator.simulator

The simulator allows to link fibers with wavelengths, to simulate an array of parameters.

Class members

fibers	List of fibers, generated from the FiberFactory.
initialized	Whether FiberFactory and wavelengths are set.
mmax	Maximum m when finding modes.
numax	Maximum nu when finding modes.
scalar	Whether to search for scalar modes.
set_factory(factory)	Set the FiberFactory.
set_wavelengths(value)	Set the list of wavelengths.
vectorial	Whether to search for vector modes.
wavelengths	List of wavelengths.

Class details

class fibermodes.simulator.simulator.Simulator(factory=None, wavelengths=None, numax=None, mmax=None, vectorial=True, scalar=False, delta=1e-06, clone=None)

The Simulator links FiberFactory with a list of wavelengths, and provides a convenient way to compute a range of modal properties.

Parameters:

• factory (FiberFactory) – A FiberFactory object.
• wavelengths (list) – A list of wavelengths.
• numax (int) – Maximum nu parameter used when finding modes, or None to find all modes.
• mmax (int) – Maximum m parameter used when finding modes, or None to find all modes.
• vectorial (bool) – Find vector modes.
• scalar (bool) – Find scalar modes.
• delta (float) – Delta parameter used for mode solver (smaller is mode precise, bigger is faster).
• clone (Simulator) – Simulator object to clone.

fibers

List of fibers, generated from the FiberFactory.

Raises:ValueError – No FiberFactory was initialized.

initialized

Whether FiberFactory and wavelengths are set.

mmax

Maximum m when finding modes.

numax

Maximum nu when finding modes.

scalar

Whether to search for scalar modes.

set_factory(factory)

Set the FiberFactory.

It can be used if this was not done in the constructor, or to modify the current FiberFactory.

Parameters:factory (FiberFactory) – FiberFactory object to use in simulator.

set_wavelengths(value)

Set the list of wavelengths.

It can be used if this was not done in the constructor, or to modify the current list of wavelengths.

Parameters:value (list) – List of wavelengths (in meters)

vectorial

Whether to search for vector modes.

wavelengths

List of wavelengths.

This list always is sorted.

Raises:ValueError – List of wavelengths was not initialized.