RefractiveIndexProviderCyl Class¶
- class plask.flow.RefractiveIndexProviderCyl(data)¶
Provider of the refractive index in Cylindrical geometry (-).
This class is used for refractive index provider in binary solvers. You can also create a custom provider for your Python solver.
- Parameters:
data –
Data
object to interpolate or callable returning it for given mesh. The callable must accept the same arguments as the provider__call__
method (see below).
To obtain the value from the provider simply call it. The call signature is as follows:
- solver.outRefractiveIndex(mesh, interpolation='default')¶
- Parameters:
mesh (mesh) – Target mesh to get the field at.
interpolation (str) – Requested interpolation method.
- Returns:
Data with the refractive index on the specified mesh (-).
Example
Connect the provider to a receiver in some other solver:
>>> other_solver.inRefractiveIndex = solver.outRefractiveIndex
Obtain the provided field:
>>> solver.outRefractiveIndex(mesh) <plask.Data at 0x1234567>
See also
Receiver of refractive index:
plask.flow.RefractiveIndexReceiverCyl
Data filter for refractive index:plask.flow.RefractiveIndexFilterCyl
Methods¶
|
Get value from the provider. |
Inform all connected receivers that the provided value has changed. |
Descriptions¶
Method Details¶
- RefractiveIndexProviderCyl.__call__(mesh, interpolation='DEFAULT')¶
Get value from the provider.
- Parameters:
mesh (mesh) – Target mesh to get the field at.
interpolation (str) – Requested interpolation method.
- RefractiveIndexProviderCyl.set_changed()¶
Inform all connected receivers that the provided value has changed.
The receivers will have its changed attribute set to True and solvers will call the provider again if they need its value (otherwise they might take it from the cache.