# DiffusionCyl Class¶

class electrical.diffusion.DiffusionCyl(name="")

Calculates carrier pairs concentration in active region using FEM in one-dimensional cylindrical space

## Methods¶

 compute_initial() Perform the initial computation compute_overthreshold() Perform the overthreshold computation compute_threshold() Perform the threshold computation get_total_burning() Compute total power burned over threshold [mW]. initialize() Initialize solver. invalidate() Set the solver back to uninitialized state.

## Attributes¶

 inCurrentDensity Receiver of the current density required for computations [kA/cm²]. inGain Receiver of the material gain required for computations [1/cm]. inLightE Receiver of the electric field required for computations [V/m]. inTemperature Receiver of the temperature required for computations [K]. inWavelength Receiver of the wavelength required for computations [nm].

### Providers¶

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

### Other¶

 abs_accuracy Required absolute minimal concentration accuracy accuracy Required relative accuracy current_mesh Horizontal adaptive mesh) fem_method Finite-element method (linear of parabolic) geometry Geometry provided to the solver id Id of the solver object. initial True if we start from initial computations initialized True if the solver has been initialized. interpolation Interpolation method used for injection current maxiters Maximum number of allowed iterations before attempting to refine mesh maxrefines Maximum number of allowed mesh refinements mesh Mesh provided to the solver mode_burns Power burned over threshold by each mode [mW].

## Descriptions¶

### Method Details¶

DiffusionCyl.compute_initial()

Perform the initial computation

DiffusionCyl.compute_overthreshold()

Perform the overthreshold computation

DiffusionCyl.compute_threshold()

Perform the threshold computation

DiffusionCyl.get_total_burning()

Compute total power burned over threshold [mW].

DiffusionCyl.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. bool
DiffusionCyl.invalidate()

Set the solver back to uninitialized state.

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

DiffusionCyl.inCurrentDensity

Receiver of the current density required for computations [kA/cm²].

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

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inCurrentDensity = other_solver.outCurrentDensity


Receciver class: plask.flow.CurrentDensityReceiverCyl

Provider class: plask.flow.CurrentDensityProviderCyl

Data filter: plask.filter.CurrentDensityFilterCyl

DiffusionCyl.inGain

Receiver of the material gain required for computations [1/cm].

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

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inGain = other_solver.outGain


Receciver class: plask.flow.GainReceiverCyl

Provider class: plask.flow.GainProviderCyl

Data filter: plask.filter.GainFilterCyl

DiffusionCyl.inLightE

Receiver of the electric field required for computations [V/m]. It is required only for the overthreshold computations.

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

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inLightE = other_solver.outModeLightE


Receciver class: plask.flow.ModeLightEReceiverCyl

Provider class: plask.flow.ModeLightEProviderCyl

Data filter: plask.filter.ModeLightEFilterCyl

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


Receciver class: plask.flow.TemperatureReceiverCyl

Provider class: plask.flow.TemperatureProviderCyl

Data filter: plask.filter.TemperatureFilterCyl

DiffusionCyl.inWavelength

Receiver of the wavelength required for computations [nm]. It is required only for the overthreshold computations.

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

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inWavelength = other_solver.outModeWavelength


Receciver class: plask.flow.ModeWavelengthReceiver

Provider class: plask.flow.ModeWavelengthProvider

Data filter: plask.filter.ModeWavelengthFilter

### Provider Details¶

DiffusionCyl.outCarriersConcentration(n=0, mesh, interpolation='default')

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


Test the number of provided values:

>>> len(solver.outCarriersConcentration)
3


### Attribute Details¶

DiffusionCyl.abs_accuracy

Required absolute minimal concentration accuracy

DiffusionCyl.accuracy

Required relative accuracy

DiffusionCyl.current_mesh

DiffusionCyl.fem_method

Finite-element method (linear of parabolic)

DiffusionCyl.geometry

Geometry provided to the solver

DiffusionCyl.id

Id of the solver object. (read only)

Example

>>> mysolver.id
mysolver:category.type

DiffusionCyl.initial

True if we start from initial computations

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

DiffusionCyl.interpolation

Interpolation method used for injection current

DiffusionCyl.maxiters

Maximum number of allowed iterations before attempting to refine mesh

DiffusionCyl.maxrefines

Maximum number of allowed mesh refinements

DiffusionCyl.mesh

Mesh provided to the solver

DiffusionCyl.mode_burns

Power burned over threshold by each mode [mW].