PLaSK User Manual

RefractiveIndexReceiver2D Class

class plask.flow.RefractiveIndexReceiver2D

Receiver of the refractive index in Cartesian2D geometry [-].

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

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inRefractiveIndex = other_solver.outRefractiveIndex

See also

Provider of refractive index: plask.flow.RefractiveIndexProvider2D

Data filter for refractive index: plask.flow.RefractiveIndexFilter2D

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

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

Get value from the connected provider

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

RefractiveIndexReceiver2D.attach(source)

Attach some provider or constant value to the receiver.

Parameters:source – source provider or value.

Example

>>> solver.inRefractiveIndex.attach(300.)
>>> solver.inRefractiveIndex(any_mesh)[0]
300.
>>> solver.inRefractiveIndex(any_mesh)[-1]
300.
>>> solver.inRefractiveIndex.attach(other_solver.outRefractiveIndex)

Note

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

>>> solver.inRefractiveIndex = other_solver.outRefractiveIndex
RefractiveIndexReceiver2D.reset()

Disconnect any provider of value from the receiver.