gain.freecarrier.
FreeCarrier2D
(name="")¶Quantumwell gain using freecarrier approximation for twodimensional Cartesian geometry.
get_energy_levels ([T]) 
Get energy levels in quantum wells. 
get_fermi_levels (n[, T, reg]) 
Get quasi Fermi levels. 
initialize () 
Initialize solver. 
invalidate () 
Set the solver back to uninitialized state. 
spectrum (…) 
Get gain spectrum at given point. 
inCarriersConcentration 
Receiver of the carriers concentration required for computations [1/cm³]. 
inTemperature 
Receiver of the temperature required for computations [K]. 
T0 
Reference temperature. 
geometry 
Geometry provided to the solver 
id 
Id of the solver object. 
initialized 
True if the solver has been initialized. 
lifetime 
Average carriers lifetime. 
matrix_element 
Momentum matrix element. 
mesh 
Mesh provided to the solver 
strained 
Boolean attribute indicating if the solver should consider strain in the active region. 
FreeCarrier2D.
get_energy_levels
(T=None)¶Get energy levels in quantum wells.
Compute energy levels in quantum wells for electrons, heavy holes and light holes.
Parameters:  T (float or None ) – Temperature to get the levels. If this argument is
None , the estimates for temperature T0
are returned. 

Returns: 

Return type:  list 
FreeCarrier2D.
get_fermi_levels
(n, T=None, reg=0)¶Get quasi Fermi levels.
Compute quasiFermi levels in specified active region.
Parameters: 


Returns:  Twoelement tuple with quasiFermi levels for electrons and holes. 
Return type:  tuple 
FreeCarrier2D.
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 
FreeCarrier2D.
invalidate
()¶Set the solver back to uninitialized state.
This method frees the memory allocated by the solver and sets
initialized
to False.
FreeCarrier2D.
inCarriersConcentration
¶Receiver of the carriers concentration required for computations [1/cm³].
You will find usage details in the documentation of the receiver class
CarriersConcentrationReceiver2D
.
Example
Connect the reveiver to a provider from some other solver:
>>> solver.inCarriersConcentration = other_solver.outCarriersConcentration
See also
Receciver class: plask.flow.CarriersConcentrationReceiver2D
Provider class: plask.flow.CarriersConcentrationProvider2D
Data filter: plask.filter.CarriersConcentrationFilter2D
FreeCarrier2D.
inTemperature
¶Receiver of the temperature required for computations [K].
You will find usage details in the documentation of the receiver class
TemperatureReceiver2D
.
Example
Connect the reveiver to a provider from some other solver:
>>> solver.inTemperature = other_solver.outTemperature
See also
Receciver class: plask.flow.TemperatureReceiver2D
Provider class: plask.flow.TemperatureProvider2D
Data filter: plask.filter.TemperatureFilter2D
FreeCarrier2D.
outGain
(n=0, mesh, wavelength, interpolation='default')¶Provider of the computed material gain [1/cm].
Parameters: 


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
FreeCarrier2D.
T0
¶Reference temperature.
In this temperature levels estimates are computed.
FreeCarrier2D.
geometry
¶Geometry provided to the solver
FreeCarrier2D.
id
¶Id of the solver object. (read only)
Example
>>> mysolver.id
mysolver:category.type
FreeCarrier2D.
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.
FreeCarrier2D.
lifetime
¶Average carriers lifetime.
This parameter is used for gain spectrum broadening. (float [ps])
FreeCarrier2D.
matrix_element
¶Momentum matrix element.
Value of the squared matrix element in gain computations. If it is not set it is estimated automatically. (float [eV×m0])
FreeCarrier2D.
mesh
¶Mesh provided to the solver
FreeCarrier2D.
strained
¶Boolean attribute indicating if the solver should consider strain in the active region.
If set to True
then there must a layer with the role substrate in
the geometry. The strain is computed by comparing the atomic lattice constants
of the substrate and the quantum wells.