ModeEffectiveIndexReceiver Class

class plask.flow.ModeEffectiveIndexReceiver

Receiver of the effective index (-).

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

Example

Connect the receiver to a provider from some other solver:

>>> solver.inModeEffectiveIndex = other_solver.outModeEffectiveIndex

See also

Provider of effective index: plask.flow.ModeEffectiveIndexProvider

Data filter for effective index: plask.flow.ModeEffectiveIndexFilter

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

ModeEffectiveIndexReceiver.__call__(n)

ModeEffectiveIndexReceiver.__call__()

Get value from the connected provider

Get value from the connected provider

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

ModeEffectiveIndexReceiver.attach(source)

Attach some provider or constant value to the receiver.

Parameters:

source – source provider or value.

Example

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

>>> solver.inModeEffectiveIndex.attach(other_solver.outModeEffectiveIndex)

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.inModeEffectiveIndex = other_solver.outModeEffectiveIndex

ModeEffectiveIndexReceiver.reset()

Disconnect any provider of value from the receiver.