PLaSK User Manual

PotentialProviderCyl Class

class plask.flow.PotentialProviderCyl(data)

Provider of the potential in Cylindrical geometry [V].

This class is used for potential provider in binary solvers. You can also create a custom provider for your Python solver.

Parameters:dataData 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.outPotential(mesh, interpolation='default')
Parameters:
  • mesh (mesh) – Target mesh to get the field at.
  • interpolation (str) – Requested interpolation method.
Returns:

Data with the potential on the specified mesh [V].

Example

Connect the provider to a receiver in some other solver:

>>> other_solver.inPotential = solver.outPotential

Obtain the provided field:

>>> solver.outPotential(mesh)
<plask.Data at 0x1234567>

See also

Receiver of potential: plask.flow.PotentialReceiverCyl Data filter for potential: plask.flow.PotentialFilterCyl

Methods

__call__(mesh[, interpolation]) Get value from the provider.
set_changed() Inform all connected receivers that the provided value has changed.

Descriptions

Method Details

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

Get value from the provider.

Parameters:
  • mesh (mesh) – Target mesh to get the field at.
  • interpolation (str) – Requested interpolation method.
PotentialProviderCyl.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.