plask.flow.GainReceiverCyl¶Receiver of the material gain in Cylindrical geometry [1/cm].
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 GainProviderCyl.
Example
Connect the reveiver to a provider from some other solver:
>>> solver.inGain = other_solver.outGain
See also
Provider of material gain: plask.flow.GainProviderCyl
Data filter for material gain: plask.flow.GainFilterCyl
__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. |
GainReceiverCyl.__call__(mesh, wavelength, interpolation='DEFAULT')¶GainReceiverCyl.__call__(deriv, mesh, wavelength, interpolation='DEFAULT')Get value from the connected provider
Get value from the connected provider
GainReceiverCyl.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.
GainReceiverCyl.attach(source)¶Attach some provider or constant value to the receiver.
| Parameters: | source – source provider or value. |
|---|
Example
>>> solver.inGain.attach(300.)
>>> solver.inGain(any_mesh)[0]
300.
>>> solver.inGain(any_mesh)[-1]
300.
>>> solver.inGain.attach(other_solver.outGain)
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.inGain = other_solver.outGain
GainReceiverCyl.reset()¶Disconnect any provider of value from the receiver.