FermiLevelsProvider3D Class¶

class plask.flow.FermiLevelsProvider3D(data)¶

Provider of the quasi-Fermi levels for electrons and holes in Cartesian3D geometry [eV].

This class is used for quasi-Fermi levels for electrons and holes provider in binary solvers. You can also create a custom provider for your Python solver.

Parameters:	data – Data object to interpolate or callable returning it for given mesh. The callable must accept the same arguments as the provider __call__ method (see below). It must also be able to give its length (i.e. have the __len__ method defined) that gives the number of different provided values.

To obtain the value from the provider simply call it. The call signature is as follows:

solver.outFermiLevels(n=0, mesh, interpolation='default')¶

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

Receiver of quasi-Fermi levels for electrons and holes: plask.flow.FermiLevelsReceiver3D Data filter for quasi-Fermi levels for electrons and holes: plask.flow.FermiLevelsFilter3D