LightMagnitudeReceiver3D Class

class plask.flow.LightMagnitudeReceiver3D

Receiver of the optical field magnitude in Cartesian3D 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 LightMagnitudeProvider3D.

Example

Connect the receiver to a provider from some other solver:

>>> solver.inLightMagnitude = other_solver.outLightMagnitude

See also

Provider of optical field magnitude: plask.flow.LightMagnitudeProvider3D

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

Methods

__call__(mesh[, interpolation])	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

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

Get value from the connected provider

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

LightMagnitudeReceiver3D.attach(source)

Attach some provider or constant value to the receiver.

Parameters:

source – source provider or value.

Example

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

>>> solver.inLightMagnitude.attach(other_solver.outLightMagnitude)

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.inLightMagnitude = other_solver.outLightMagnitude

LightMagnitudeReceiver3D.reset()

Disconnect any provider of value from the receiver.