ModeLightMagnitudeReceiver2D Class

class plask.flow.ModeLightMagnitudeReceiver2D

Receiver of the optical field magnitude in Cartesian2D geometry (W/m²).

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

Example

Connect the receiver to a provider from some other solver:

>>> solver.inModeLightMagnitude = other_solver.outModeLightMagnitude

See also

Provider of optical field magnitude: plask.flow.ModeLightMagnitudeProvider2D

Data filter for optical field magnitude: plask.flow.ModeLightMagnitudeFilter2D

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

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

ModeLightMagnitudeReceiver2D.__call__(mesh, interpolation='DEFAULT')

Get value from the connected provider

Get value from the connected provider

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

ModeLightMagnitudeReceiver2D.attach(source)

Attach some provider or constant value to the receiver.

Parameters:

source – source provider or value.

Example

>>> solver.inModeLightMagnitude.attach(300.)
>>> solver.inModeLightMagnitude(any_mesh)[0]
300.
>>> solver.inModeLightMagnitude(any_mesh)[-1]
300.

>>> solver.inModeLightMagnitude.attach(other_solver.outModeLightMagnitude)

Note

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

>>> solver.inModeLightMagnitude = other_solver.outModeLightMagnitude

ModeLightMagnitudeReceiver2D.reset()

Disconnect any provider of value from the receiver.