Receivers¶

Providers¶

Other¶

Method Details¶

Diffusion2D.compute_initial()¶

Perform the initial computation

Diffusion2D.compute_overthreshold()¶

Perform the overthreshold computation

Diffusion2D.compute_threshold()¶

Perform the threshold computation

Diffusion2D.get_total_burning()¶

Compute total power burned over threshold [mW].

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

Diffusion2D.invalidate()¶

Set the solver back to uninitialized state.

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

Receiver Details¶

Diffusion2D.inCurrentDensity¶

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

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

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inCurrentDensity = other_solver.outCurrentDensity

See also

Receciver class: plask.flow.CurrentDensityReceiver2D

Provider class: plask.flow.CurrentDensityProvider2D

Data filter: plask.filter.CurrentDensityFilter2D

Diffusion2D.inGain¶

Receiver of the material gain required for computations [1/cm]. It is required only for the overthreshold computations.

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

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inGain = other_solver.outGain

See also

Receciver class: plask.flow.GainReceiver2D

Provider class: plask.flow.GainProvider2D

Data filter: plask.filter.GainFilter2D

Diffusion2D.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 ModeLightEReceiver2D.

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inLightE = other_solver.outModeLightE

See also

Receciver class: plask.flow.ModeLightEReceiver2D

Provider class: plask.flow.ModeLightEProvider2D

Data filter: plask.filter.ModeLightEFilter2D

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

Provider Details¶

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

Attribute Details¶

Diffusion2D.abs_accuracy¶

Required absolute minimal concentration accuracy

Diffusion2D.accuracy¶

Required relative accuracy

Diffusion2D.current_mesh¶

Horizontal adaptive mesh)

Diffusion2D.fem_method¶

Finite-element method (linear of parabolic)

Diffusion2D.geometry¶

Geometry provided to the solver

Diffusion2D.id¶

Id of the solver object. (read only)

Example

>>> mysolver.id
mysolver:category.type

Diffusion2D.initial¶

True if we start from initial computations

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

Diffusion2D.interpolation¶

Interpolation method used for injection current

Diffusion2D.maxiters¶

Maximum number of allowed iterations before attempting to refine mesh

Diffusion2D.maxrefines¶

Maximum number of allowed mesh refinements

Diffusion2D.mesh¶

Mesh provided to the solver

Diffusion2D.mode_burns¶

Power burned over threshold by each mode [mW].