meta.shockley._doc Namespace Reference

Variables
str	outLightMagnitude
str	outLoss
str	outWavelength
str	outRefractiveIndex
str	outEpsilon
str	outLightE
str	outNeff

Variable Documentation

outEpsilon

str meta.shockley._doc.outEpsilon

Initial value:

=  """\
Provider of the computed permittivity tensor (-).
 
 
outEpsilon(mesh, interpolation='default')
 
:param mesh mesh: Target mesh to get the field at.
:param str interpolation: Requested interpolation method.
 
:return: Data with the permittivity tensor on the specified mesh **(-)**.
 
Example:
   Connect the provider to a receiver in some other solver:
 
   >>> other_solver.inEpsilon = solver.outEpsilon
 
   Obtain the provided field:
 
   >>> solver.outEpsilon(mesh)
   <plask.Data at 0x1234567>
 
See also:
 
   Provider class: :class:`plask.flow.EpsilonProviderCyl`
 
   Receiver class: :class:`plask.flow.EpsilonReceiverCyl`
"""

Definition at line 151 of file _doc.py.

outLightE

str meta.shockley._doc.outLightE

Definition at line 179 of file _doc.py.

outLightMagnitude

str meta.shockley._doc.outLightMagnitude

Definition at line 16 of file _doc.py.

outLoss

str meta.shockley._doc.outLoss

Definition at line 53 of file _doc.py.

outNeff

str meta.shockley._doc.outNeff

Definition at line 216 of file _doc.py.

outRefractiveIndex

str meta.shockley._doc.outRefractiveIndex

Initial value:

=  """\
Provider of the computed refractive index (-).
 
 
outRefractiveIndex(mesh, interpolation='default')
 
:param mesh mesh: Target mesh to get the field at.
:param str interpolation: Requested interpolation method.
 
:return: 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:
 
   Provider class: :class:`plask.flow.RefractiveIndexProviderCyl`
 
   Receiver class: :class:`plask.flow.RefractiveIndexReceiverCyl`
"""

Definition at line 123 of file _doc.py.

outWavelength

str meta.shockley._doc.outWavelength

Definition at line 88 of file _doc.py.