# PLaSK User Manual

#### Page Contents

- DriftDiffusionCyl Class
  - `DriftDiffusionCyl`
  - Methods
  - Attributes
    - Receivers
    - Providers
    - Other
  - Descriptions
    - Method Details
      - `DriftDiffusionCyl.compute()`
      - `DriftDiffusionCyl.find_energy_levels()`
      - `DriftDiffusionCyl.get_total_current()`
      - `DriftDiffusionCyl.initialize()`
      - `DriftDiffusionCyl.invalidate()`
    - Receiver Details
      - `DriftDiffusionCyl.inTemperature`
    - Provider Details
      - `DriftDiffusionCyl.outBandEdges`
      - `DriftDiffusionCyl.outCarriersConcentration`
      - `DriftDiffusionCyl.outCurrentDensityForElectrons`
      - `DriftDiffusionCyl.outCurrentDensityForHoles`
      - `DriftDiffusionCyl.outFermiLevels`
      - `DriftDiffusionCyl.outHeat`
      - `DriftDiffusionCyl.outPotential`
    - Attribute Details
      - `DriftDiffusionCyl.FullIon`
      - `DriftDiffusionCyl.Pol`
      - `DriftDiffusionCyl.Raug`
      - `DriftDiffusionCyl.Rrad`
      - `DriftDiffusionCyl.Rsrh`
      - `DriftDiffusionCyl.SchottkyN`
      - `DriftDiffusionCyl.SchottkyP`
      - `DriftDiffusionCyl.algorithm`
      - `DriftDiffusionCyl.geometry`
      - `DriftDiffusionCyl.id`
      - `DriftDiffusionCyl.initialized`
      - `DriftDiffusionCyl.iterative`
      - `DriftDiffusionCyl.loopsFn`
      - `DriftDiffusionCyl.loopsFp`
      - `DriftDiffusionCyl.loopsV`
      - `DriftDiffusionCyl.loopsV0`
      - `DriftDiffusionCyl.loopsVi`
      - `DriftDiffusionCyl.maxerrFn`
      - `DriftDiffusionCyl.maxerrFp`
      - `DriftDiffusionCyl.maxerrV`
      - `DriftDiffusionCyl.maxerrV0`
      - `DriftDiffusionCyl.maxerrVi`
      - `DriftDiffusionCyl.mesh`
      - `DriftDiffusionCyl.voltage_boundary`

# DriftDiffusionCyl Class

class electrical.ddm2d.DriftDiffusionCyl(name='')

  Finite element drift-diffusion electrical solver for 2D cylindrical geometry.

## Methods

`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.

## Attributes

### Receivers

`inTemperature` | Receiver of the temperature required for computations [K].

### Providers

`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].

### Other

`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 contact
`SchottkyP` | Schottky barrier for p-type contact
`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.
`iterative` | Iterative matrix parameters (see `IterativeParams`)
`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)

## Descriptions

### Method Details

DriftDiffusionCyl.compute(loops=0)

  Run drift-diffusion calculations

DriftDiffusionCyl.find_energy_levels()

  Run energy levels calculations - TEST

DriftDiffusionCyl.get_total_current(nact=0)

  Get total current flowing through active region (mA)

DriftDiffusionCyl.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

DriftDiffusionCyl.invalidate()

  Set the solver back to uninitialized state.

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

### Receiver Details

DriftDiffusionCyl.inTemperature = <property object>

  Receiver of the temperature required for computations [K].

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

  Example

  Connect the receiver 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

DriftDiffusionCyl.outBandEdges(n=0, mesh, interpolation='default') = <property object>

  Provider of the computed conduction and valence band edges [eV].

  Parameters:

    - n (int) – Value number.

    - mesh (mesh) – Target mesh to get the field at.

    - interpolation (str) – Requested interpolation method.

  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.BandEdgesProviderCyl`

  Receciver class: `plask.flow.BandEdgesReceiverCyl`

DriftDiffusionCyl.outCarriersConcentration(n=0, mesh, interpolation='default') = <property object>

  Provider of the computed carriers concentration [1/cm³].

  Parameters:

    - type (str) – Detailed information which carriers are returned. It can be ‘majority’ to return majority carriers in given material, ‘pairs’ for the concentration of electron-hole pairs, ‘electrons’, or ‘holes’ for particular carriers type.

    - mesh (mesh) – Target mesh to get the field at.

    - interpolation (str) – Requested interpolation method.

  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.CarriersConcentrationProviderCyl`

  Receciver class: `plask.flow.CarriersConcentrationReceiverCyl`

DriftDiffusionCyl.outCurrentDensityForElectrons(mesh, interpolation='default') = <property object>

  Provider of the computed current density [kA/cm²].

  Parameters:

    - mesh (mesh) – Target mesh to get the field at.

    - interpolation (str) – Requested interpolation method.

  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.CurrentDensityProviderCyl`

  Receciver class: `plask.flow.CurrentDensityReceiverCyl`

DriftDiffusionCyl.outCurrentDensityForHoles(mesh, interpolation='default') = <property object>

  Provider of the computed current density [kA/cm²].

  Parameters:

    - mesh (mesh) – Target mesh to get the field at.

    - interpolation (str) – Requested interpolation method.

  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.CurrentDensityProviderCyl`

  Receciver class: `plask.flow.CurrentDensityReceiverCyl`

DriftDiffusionCyl.outFermiLevels(n=0, mesh, interpolation='default') = <property object>

  Provider of the computed quasi-Fermi levels for electrons and holes [eV].

  Parameters:

    - n (int) – Value number.

    - mesh (mesh) – Target mesh to get the field at.

    - interpolation (str) – Requested interpolation method.

  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.FermiLevelsProviderCyl`

  Receciver class: `plask.flow.FermiLevelsReceiverCyl`

DriftDiffusionCyl.outHeat(mesh, interpolation='default') = <property object>

  Provider of the computed heat sources density [W/m³].

  Parameters:

    - mesh (mesh) – Target mesh to get the field at.

    - interpolation (str) – Requested interpolation method.

  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>

  See also

  Provider class: `plask.flow.HeatProviderCyl`

  Receciver class: `plask.flow.HeatReceiverCyl`

DriftDiffusionCyl.outPotential(mesh, interpolation='default') = <property object>

  Provider of the computed potential [V].

  Parameters:

    - mesh (mesh) – Target mesh to get the field at.

    - interpolation (str) – Requested interpolation method.

  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.PotentialProviderCyl`

  Receciver class: `plask.flow.PotentialReceiverCyl`

### Attribute Details

DriftDiffusionCyl.FullIon = <property object>

  True if dopants are completely ionized

DriftDiffusionCyl.Pol = <property object>

  True if polarization effects are taken into account

DriftDiffusionCyl.Raug = <property object>

  True if Auger recombination is taken into account

DriftDiffusionCyl.Rrad = <property object>

  True if radiative recombination is taken into account

DriftDiffusionCyl.Rsrh = <property object>

  True if SRH recombination is taken into account

DriftDiffusionCyl.SchottkyN = <property object>

  Schottky barrier for n-type contact

DriftDiffusionCyl.SchottkyP = <property object>

  Schottky barrier for p-type contact

DriftDiffusionCyl.algorithm = <property object>

  Chosen matrix factorization algorithm

DriftDiffusionCyl.geometry = <property object>

  Geometry provided to the solver

DriftDiffusionCyl.id = <property object>

  Id of the solver object. (read only)

  Example

      >>> mysolver.id
      mysolver:category.type

DriftDiffusionCyl.initialized = <property object>

  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.

DriftDiffusionCyl.iterative = <property object>

  Iterative matrix parameters (see `IterativeParams`)

DriftDiffusionCyl.loopsFn = <property object>

  Loops limit for the electrons quasi-Fermi level

DriftDiffusionCyl.loopsFp = <property object>

  Loops limit for the holes quasi-Fermi level

DriftDiffusionCyl.loopsV = <property object>

  Loops limit for the potential

DriftDiffusionCyl.loopsV0 = <property object>

  Loops limit for the built-in potential

DriftDiffusionCyl.loopsVi = <property object>

  Loops limit for the initial potential estimate

DriftDiffusionCyl.maxerrFn = <property object>

  Limit for the electrons quasi-Fermi level updates

DriftDiffusionCyl.maxerrFp = <property object>

  Limit for the holes quasi-Fermi level updates

DriftDiffusionCyl.maxerrV = <property object>

  Limit for the potential updates

DriftDiffusionCyl.maxerrV0 = <property object>

  Limit for the built-in potential updates

DriftDiffusionCyl.maxerrVi = <property object>

  Limit for the initial potential estimate updates

DriftDiffusionCyl.mesh = <property object>

  Mesh provided to the solver

DriftDiffusionCyl.voltage_boundary = <property object>

  Boundary conditions of the first kind (constant potential)

  This field holds a list of boundary conditions for the solver. You may access and alter its 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