electrical.ddm2d.
DriftDiffusion2D
(name="")¶Finite element drift-diffusion electrical solver for 2D Cartesian geometry.
compute ([loops]) |
Run drift-diffusion calculations |
find_energy_levels () |
Run energy levels calculations - TEST |
get_total_current ([nact]) |
Get total current flowing through active region [mA] |
initialize () |
Initialize solver. |
invalidate () |
Set the solver back to uninitialized state. |
inTemperature |
Receiver of the temperature required for computations [K]. |
outBandEdges |
Provider of the computed conduction and valence band edges [eV]. |
outCarriersConcentration |
Provider of the computed carriers concentration [1/cm³]. |
outCurrentDensityForElectrons |
Provider of the computed current density [kA/cm²]. |
outCurrentDensityForHoles |
Provider of the computed current density [kA/cm²]. |
outFermiLevels |
Provider of the computed quasi-Fermi levels for electrons and holes [eV]. |
outHeat |
Provider of the computed heat sources density [W/m³]. |
outPotential |
Provider of the computed potential [V]. |
FullIon |
True if dopants are completely ionized |
Pol |
True if polarization effects are taken into account |
Raug |
True if Auger recombination is taken into account |
Rrad |
True if radiative recombination is taken into account |
Rsrh |
True if SRH recombination is taken into account |
SchottkyN |
Schottky barrier for n-type constact |
SchottkyP |
Schottky barrier for p-type constact |
algorithm |
Chosen matrix factorization algorithm |
geometry |
Geometry provided to the solver |
id |
Id of the solver object. |
initialized |
True if the solver has been initialized. |
itererr |
Allowed residual iteration for iterative method |
iterlim |
Maximum number of iterations for iterative method |
logfreq |
Frequency of iteration progress reporting |
loopsFn |
Loops limit for the electrons quasi-Fermi level |
loopsFp |
Loops limit for the holes quasi-Fermi level |
loopsV |
Loops limit for the potential |
loopsV0 |
Loops limit for the built-in potential |
loopsVi |
Loops limit for the initial potential estimate |
maxerrFn |
Limit for the electrons quasi-Fermi level updates |
maxerrFp |
Limit for the holes quasi-Fermi level updates |
maxerrV |
Limit for the potential updates |
maxerrV0 |
Limit for the built-in potential updates |
maxerrVi |
Limit for the initial potential estimate updates |
mesh |
Mesh provided to the solver |
voltage_boundary |
Boundary conditions of the first kind (constant potential) |
DriftDiffusion2D.
compute
(loops=0)¶Run drift-diffusion calculations
DriftDiffusion2D.
find_energy_levels
()¶Run energy levels calculations - TEST
DriftDiffusion2D.
get_total_current
(nact=0)¶Get total current flowing through active region [mA]
DriftDiffusion2D.
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 |
DriftDiffusion2D.
invalidate
()¶Set the solver back to uninitialized state.
This method frees the memory allocated by the solver and sets
initialized
to False.
DriftDiffusion2D.
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
DriftDiffusion2D.
outBandEdges
(n=0, mesh, interpolation='default')¶Provider of the computed conduction and valence band edges [eV].
Parameters: |
|
---|---|
Returns: | Data with the conduction and valence band edges on the specified mesh [eV]. |
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.inBandEdges = solver.outBandEdges
Obtain the provided field:
>>> solver.outBandEdges(0, mesh)
<plask.Data at 0x1234567>
Test the number of provided values:
>>> len(solver.outBandEdges)
3
See also
Provider class: plask.flow.BandEdgesProvider2D
Receciver class: plask.flow.BandEdgesReceiver2D
DriftDiffusion2D.
outCarriersConcentration
(n=0, mesh, interpolation='default')¶Provider of the computed carriers concentration [1/cm³].
Parameters: |
|
---|---|
Returns: | Data with the carriers concentration 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.inCarriersConcentration = solver.outCarriersConcentration
Obtain the provided field:
>>> solver.outCarriersConcentration(0, mesh)
<plask.Data at 0x1234567>
Test the number of provided values:
>>> len(solver.outCarriersConcentration)
3
See also
Provider class: plask.flow.CarriersConcentrationProvider2D
Receciver class: plask.flow.CarriersConcentrationReceiver2D
DriftDiffusion2D.
outCurrentDensityForElectrons
(mesh, interpolation='default')¶Provider of the computed current density [kA/cm²].
Parameters: |
|
---|---|
Returns: | Data with the current density on the specified mesh [kA/cm²]. |
Example
Connect the provider to a receiver in some other solver:
>>> other_solver.inCurrentDensity = solver.outCurrentDensityForElectrons
Obtain the provided field:
>>> solver.outCurrentDensityForElectrons(mesh)
<plask.Data at 0x1234567>
See also
Provider class: plask.flow.CurrentDensityProvider2D
Receciver class: plask.flow.CurrentDensityReceiver2D
DriftDiffusion2D.
outCurrentDensityForHoles
(mesh, interpolation='default')¶Provider of the computed current density [kA/cm²].
Parameters: |
|
---|---|
Returns: | Data with the current density on the specified mesh [kA/cm²]. |
Example
Connect the provider to a receiver in some other solver:
>>> other_solver.inCurrentDensity = solver.outCurrentDensityForHoles
Obtain the provided field:
>>> solver.outCurrentDensityForHoles(mesh)
<plask.Data at 0x1234567>
See also
Provider class: plask.flow.CurrentDensityProvider2D
Receciver class: plask.flow.CurrentDensityReceiver2D
DriftDiffusion2D.
outFermiLevels
(n=0, mesh, interpolation='default')¶Provider of the computed quasi-Fermi levels for electrons and holes [eV].
Parameters: |
|
---|---|
Returns: | Data with the quasi-Fermi levels for electrons and holes on the specified mesh [eV]. |
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.inFermiLevels = solver.outFermiLevels
Obtain the provided field:
>>> solver.outFermiLevels(0, mesh)
<plask.Data at 0x1234567>
Test the number of provided values:
>>> len(solver.outFermiLevels)
3
See also
Provider class: plask.flow.FermiLevelsProvider2D
Receciver class: plask.flow.FermiLevelsReceiver2D
DriftDiffusion2D.
outHeat
(mesh, interpolation='default')¶Provider of the computed heat sources density [W/m³].
Parameters: |
|
---|---|
Returns: | Data with the heat sources density on the specified mesh [W/m³]. |
Example
Connect the provider to a receiver in some other solver:
>>> other_solver.inHeat = solver.outHeat
Obtain the provided field:
>>> solver.outHeat(mesh)
<plask.Data at 0x1234567>
DriftDiffusion2D.
outPotential
(mesh, interpolation='default')¶Provider of the computed potential [V].
Parameters: |
|
---|---|
Returns: | Data with the potential on the specified mesh [V]. |
Example
Connect the provider to a receiver in some other solver:
>>> other_solver.inPotential = solver.outPotential
Obtain the provided field:
>>> solver.outPotential(mesh)
<plask.Data at 0x1234567>
See also
Provider class: plask.flow.PotentialProvider2D
Receciver class: plask.flow.PotentialReceiver2D
DriftDiffusion2D.
FullIon
¶True if dopants are completely ionized
DriftDiffusion2D.
Pol
¶True if polarization effects are taken into account
DriftDiffusion2D.
Raug
¶True if Auger recombination is taken into account
DriftDiffusion2D.
Rrad
¶True if radiative recombination is taken into account
DriftDiffusion2D.
Rsrh
¶True if SRH recombination is taken into account
DriftDiffusion2D.
SchottkyN
¶Schottky barrier for n-type constact
DriftDiffusion2D.
SchottkyP
¶Schottky barrier for p-type constact
DriftDiffusion2D.
algorithm
¶Chosen matrix factorization algorithm
DriftDiffusion2D.
geometry
¶Geometry provided to the solver
DriftDiffusion2D.
id
¶Id of the solver object. (read only)
Example
>>> mysolver.id
mysolver:category.type
DriftDiffusion2D.
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.
DriftDiffusion2D.
itererr
¶Allowed residual iteration for iterative method
DriftDiffusion2D.
iterlim
¶Maximum number of iterations for iterative method
DriftDiffusion2D.
logfreq
¶Frequency of iteration progress reporting
DriftDiffusion2D.
loopsFn
¶Loops limit for the electrons quasi-Fermi level
DriftDiffusion2D.
loopsFp
¶Loops limit for the holes quasi-Fermi level
DriftDiffusion2D.
loopsV
¶Loops limit for the potential
DriftDiffusion2D.
loopsV0
¶Loops limit for the built-in potential
DriftDiffusion2D.
loopsVi
¶Loops limit for the initial potential estimate
DriftDiffusion2D.
maxerrFn
¶Limit for the electrons quasi-Fermi level updates
DriftDiffusion2D.
maxerrFp
¶Limit for the holes quasi-Fermi level updates
DriftDiffusion2D.
maxerrV
¶Limit for the potential updates
DriftDiffusion2D.
maxerrV0
¶Limit for the built-in potential updates
DriftDiffusion2D.
maxerrVi
¶Limit for the initial potential estimate updates
DriftDiffusion2D.
mesh
¶Mesh provided to the solver
DriftDiffusion2D.
voltage_boundary
¶Boundary conditions of the first kind (constant potential)
This field holds a list of boundary conditions for the solver. You may access and alter is elements a normal Python list. Each element is a special class that has two attributes:
place |
Boundary condition location (plask.mesh.RectangularBase2D.Boundary ). |
value |
Boundary condition value. |
When you add new boundary condition, you may use two-argument append
, or
prepend
methods, or three-argument insert
method, where you separately
specify the place and the value. See the below example for clarification.
Example
>>> solver.voltage_boundary.clear()
>>> solver.voltage_boundary.append(solver.mesh.Bottom(), some_value)
>>> solver.voltage_boundary[0].value = different_value
>>> solver.voltage_boundary.insert(0, solver.mesh.Top(), new_value)
>>> solver.voltage_boundary[1].value == different_value
True