ModeLightMagnitudeProvider3D Class

class plask.flow.ModeLightMagnitudeProvider3D(data)

Provider of the optical field magnitude in Cartesian3D geometry (W/m²).

This class is used for optical field magnitude 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.outModeLightMagnitude(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 optical field magnitude on the specified mesh (W/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.inModeLightMagnitude = solver.outModeLightMagnitude

Obtain the provided field:

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

Test the number of provided values:

>>> len(solver.outModeLightMagnitude)
3

See also

Receiver of optical field magnitude: plask.flow.ModeLightMagnitudeReceiver3D Data filter for optical field magnitude: plask.flow.ModeLightMagnitudeFilter3D

Methods

__call__(...)

Get value from the provider.

set_changed()

Inform all connected receivers that the provided value has changed.

Descriptions

Method Details

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

Get value from the provider.

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.

ModeLightMagnitudeProvider3D.set_changed()

Inform all connected receivers that the provided value has changed.

The receivers will have its changed attribute set to True and solvers will call the provider again if they need its value (otherwise they might take it from the cache.