PLaSK User Manual

gain

Gain solvers.

This package combines all gain solvers and helper functions that can create solver classes without a need to explicitly import the proper binary module.

Example

>>> import gain
>>> gain.FreeCarrierCyl('mysolver')
<gain.freecarrier.FreeCarrierCyl at 0x42ac2b8>

Solver classes

wasiak.WasiakOld2D([name]) Gain solver based on Fermi Golden Rule for Cartesian 2D geometry.
wasiak.WasiakOldCyl([name]) Gain solver based on Fermi Golden Rule for Cylindrical 2D geometry.
wasiak.WasiakNew2D([name]) Gain solver based on Fermi Golden Rule for Cartesian 2D geometry.
wasiak.WasiakNewCyl([name]) Gain solver based on Fermi Golden Rule for Cylindrical 2D geometry.
freecarrier.FreeCarrier2D([name]) Quantum-well gain using free-carrier approximation for two-dimensional Cartesian geometry.
freecarrier.FreeCarrierCyl([name]) Quantum-well gain using free-carrier approximation for cylindrical geometry.

Functions

FreeCarrier2D([name]) Create FreeCarrier2D solver.
FreeCarrierCyl([name]) Create FreeCarrierCyl solver.
WasiakNew2D([name]) Create WasiakNew2D solver.
WasiakNewCyl([name]) Create WasiakNewCyl solver.
WasiakOld2D([name]) Create WasiakOld2D solver.
WasiakOldCyl([name]) Create WasiakOldCyl solver.

Descriptions

Function Details

gain.FreeCarrier2D(name='')

Create FreeCarrier2D solver.

This function automatically loads freecarrier submodule and creates FreeCarrier2D class.

Parameters:name (str) – Solver name.
gain.FreeCarrierCyl(name='')

Create FreeCarrierCyl solver.

This function automatically loads freecarrier submodule and creates FreeCarrierCyl class.

Parameters:name (str) – Solver name.
gain.WasiakNew2D(name='')

Create WasiakNew2D solver.

This function automatically loads wasiak submodule and creates WasiakNew2D class.

Parameters:name (str) – Solver name.
gain.WasiakNewCyl(name='')

Create WasiakNewCyl solver.

This function automatically loads wasiak submodule and creates WasiakNewCyl class.

Parameters:name (str) – Solver name.
gain.WasiakOld2D(name='')

Create WasiakOld2D solver.

This function automatically loads wasiak submodule and creates WasiakOld2D class.

Parameters:name (str) – Solver name.
gain.WasiakOldCyl(name='')

Create WasiakOldCyl solver.

This function automatically loads wasiak submodule and creates WasiakOldCyl class.

Parameters:name (str) – Solver name.