ModeLightEProvider3D Class¶

class plask.flow.ModeLightEProvider3D(data)¶

Provider of the electric field in Cartesian3D geometry [V/m].

This class is used for electric field 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.outModeLightE(n=0, mesh, interpolation='default')¶

Parameters:	n (int) – Number of the mode found with find_mode(). mesh (mesh) – Target mesh to get the field at. interpolation (str) – Requested interpolation method.
Returns:	Data with the electric field on the specified mesh [V/m].

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.inModeLightE = solver.outModeLightE

Obtain the provided field:

>>> solver.outModeLightE(0, mesh)
<plask.Data at 0x1234567>

Test the number of provided values:

>>> len(solver.outModeLightE)
3

See also

Receiver of electric field: plask.flow.ModeLightEReceiver3D Data filter for electric field: plask.flow.ModeLightEFilter3D