PLaSK User Manual

EnergyLevelsReceiver2D Class

class plask.flow.EnergyLevelsReceiver2D

Receiver of the energy levels for electrons and holes in Cartesian2D geometry [eV].

You may connect a provider to this receiver usign either the connect method or an assignement operator. Then, you can read the provided value by calling this receiver with arguments identical as the ones of the corresponding provider EnergyLevelsProvider2D.

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inEnergyLevels = other_solver.outEnergyLevels

See also

Provider of energy levels for electrons and holes: plask.flow.EnergyLevelsProvider2D

Data filter for energy levels for electrons and holes: plask.flow.EnergyLevelsFilter2D

Methods

__call__(…) Get value from the connected provider
add_watch(callable) Connect callable to watch receiver changes.
attach(source) Attach some provider or constant value to the receiver.
reset() Disconnect any provider of value from the receiver.

Descriptions

Method Details

EnergyLevelsReceiver2D.__call__(n, mesh, interpolation='DEFAULT')
EnergyLevelsReceiver2D.__call__(mesh, interpolation='DEFAULT')

Get value from the connected provider

Get value from the connected provider

EnergyLevelsReceiver2D.add_watch(callable)

Connect callable to watch receiver changes.

The callable will be called each time the value received by this receiver changes.

The callable should accept two arguments: the first one will be the receiver and the second one gives information what is changed.

EnergyLevelsReceiver2D.attach(source)

Attach some provider or constant value to the receiver.

Parameters:source – source provider or value.

Example

>>> solver.inEnergyLevels.attach(300.)
>>> solver.inEnergyLevels(any_mesh)[0]
300.
>>> solver.inEnergyLevels(any_mesh)[-1]
300.
>>> solver.inEnergyLevels.attach(other_solver.outEnergyLevels)

Note

You may achieve the same effect by using the asignmnent operator if you put an exisiting provider at the right side of this operator:

>>> solver.inEnergyLevels = other_solver.outEnergyLevels
EnergyLevelsReceiver2D.reset()

Disconnect any provider of value from the receiver.