PLaSK User Manual

WasiakOldCyl Class

class gain.wasiak.WasiakOldCyl(name="")

Gain solver based on Fermi Golden Rule for Cylindrical 2D geometry.

Subclasses

Spectrum Gain spectrum class.

Methods

determine_levels(T, n) Determine quasi-Fermi levels and carriers levels inside QW
initialize() Initialize solver.
invalidate() Set the solver back to uninitialized state.
set_levels(*args, **kwargs) Determine quasi-Fermi levels and carriers levels inside QW.
spectrum(…) Get gain spectrum at given point

Attributes

Receivers

inCarriersConcentration Receiver of the carriers concentration required for computations [1/cm³].
inTemperature Receiver of the temperature required for computations [K].

Providers

outGain Provider of the computed material gain [1/cm].

Other

cond_shift Additional conduction band shift for QW [eV]
geometry Geometry provided to the solver
id Id of the solver object.
initialized True if the solver has been initialized.
lifetime Stimulated emission lifetime [ps]
matrix_elem Optical matrix element [m0*eV]
mesh Mesh provided to the solver
strained Consider strain in QW? (True or False)
vale_shift Additional valence band shift for QW [eV]

Descriptions

Method Details

WasiakOldCyl.determine_levels(T, n)

Determine quasi-Fermi levels and carriers levels inside QW

WasiakOldCyl.initialize()

Initialize solver.

This method manually initialized the solver and sets initialized to True. Normally calling it is not necessary, as each solver automatically initializes itself when needed.

Returns:solver initialized state prior to this method call.
Return type:bool
WasiakOldCyl.invalidate()

Set the solver back to uninitialized state.

This method frees the memory allocated by the solver and sets initialized to False.

WasiakOldCyl.set_levels(*args, **kwargs)

Determine quasi-Fermi levels and carriers levels inside QW.

WasiakOldCyl.spectrum(c0, c1)
WasiakOldCyl.spectrum(point)

Get gain spectrum at given point

Receiver Details

WasiakOldCyl.inCarriersConcentration

Receiver of the carriers concentration required for computations [1/cm³].

You will find usage details in the documentation of the receiver class CarriersConcentrationReceiverCyl.

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inCarriersConcentration = other_solver.outCarriersConcentration

See also

Receciver class: plask.flow.CarriersConcentrationReceiverCyl

Provider class: plask.flow.CarriersConcentrationProviderCyl

Data filter: plask.filter.CarriersConcentrationFilterCyl

WasiakOldCyl.inTemperature

Receiver of the temperature required for computations [K].

You will find usage details in the documentation of the receiver class TemperatureReceiverCyl.

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inTemperature = other_solver.outTemperature

See also

Receciver class: plask.flow.TemperatureReceiverCyl

Provider class: plask.flow.TemperatureProviderCyl

Data filter: plask.filter.TemperatureFilterCyl

Provider Details

WasiakOldCyl.outGain(n=0, mesh, wavelength, interpolation='default')

Provider of the computed material gain [1/cm].

Parameters:
  • deriv (str) – Gain derivative to return. can be ‘’ (empty) or ‘conc’. In the latter case, the gain derivative over carriers concentration is returned.
  • mesh (mesh) – Target mesh to get the field at.
  • interpolation (str) – Requested interpolation method.
  • wavelength (float) – The wavelength at which the gain is computed [nm].
Returns:

Data with the material gain on the specified mesh [1/cm].

You may obtain the number of different values this provider can return by testing its length.

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inGain = solver.outGain

Obtain the provided field:

>>> solver.outGain(0, mesh, wavelength)
<plask.Data at 0x1234567>

Test the number of provided values:

>>> len(solver.outGain)
3

See also

Provider class: plask.flow.GainProviderCyl

Receciver class: plask.flow.GainReceiverCyl

Attribute Details

WasiakOldCyl.cond_shift

Additional conduction band shift for QW [eV]

WasiakOldCyl.geometry

Geometry provided to the solver

WasiakOldCyl.id

Id of the solver object. (read only)

Example

>>> mysolver.id
mysolver:category.type
WasiakOldCyl.initialized

True if the solver has been initialized. (read only)

Solvers usually get initialized at the beginning of the computations. You can clean the initialization state and free the memory by calling the invalidate() method.

WasiakOldCyl.lifetime

Stimulated emission lifetime [ps]

WasiakOldCyl.matrix_elem

Optical matrix element [m0*eV]

WasiakOldCyl.mesh

Mesh provided to the solver

WasiakOldCyl.strained

Consider strain in QW? (True or False)

WasiakOldCyl.vale_shift

Additional valence band shift for QW [eV]