electrical.shockley.
ShockleyCyl
(name="")¶Finite element thermal solver for 2D cylindrical geometry.
compute ([loops]) 
Run electrical calculations 
get_capacitance () 
Get the structure capacitance. 
get_electrostatic_energy () 
Get the energy stored in the electrostatic field in the analyzed structure. 
get_total_current ([nact]) 
Get total current flowing through active region [mA] 
get_total_heat () 
Get the total heat produced by the current flowing in the structure. 
initialize () 
Initialize solver. 
invalidate () 
Set the solver back to uninitialized state. 
inTemperature 
Receiver of the temperature required for computations [K]. 
outConductivity 
Provider of the computed electrical conductivity [S/m]. 
outCurrentDensity 
Provider of the computed current density [kA/cm²]. 
outHeat 
Provider of the computed heat sources density [W/m³]. 
outPotential 
Not available in this solver. 
outVoltage 
Provider of the computed voltage [V]. 
algorithm 
Chosen matrix factorization algorithm 
beta 
Junction coefficient [1/V]. 
convergence 
Convergence method. 
err 
Maximum estimated error 
geometry 
Geometry provided to the solver 
id 
Id of the solver object. 
include_empty 
Should empty regions (e.g. 
initialized 
True if the solver has been initialized. 
itererr 
Allowed residual iteration for iterative method 
iterlim 
Maximum number of iterations for iterative method 
js 
Reverse bias current density [A/m^{2}]. 
logfreq 
Frequency of iteration progress reporting 
maxerr 
Limit for the potential updates 
mesh 
Mesh provided to the solver 
ncond 
Conductivity of the ncontact 
pcond 
Conductivity of the pcontact 
pnjcond 
Default effective conductivity of the active region. 
start_cond 
Default effective conductivity of the active region. 
voltage_boundary 
Boundary conditions of the first kind (constant potential) 
ShockleyCyl.
compute
(loops=0)¶Run electrical calculations
ShockleyCyl.
get_capacitance
()¶Get the structure capacitance.
Returns:  Total capacitance [pF]. 

Note
This method can only be used it there are exactly two boundary conditions
specifying the voltage. Otherwise use get_electrostatic_energy()
to
obtain the stored energy \(W\) and compute the capacitance as:
\(C = 2 \, W / U^2\), where \(U\) is the applied voltage.
ShockleyCyl.
get_electrostatic_energy
()¶Get the energy stored in the electrostatic field in the analyzed structure.
Returns:  Total electrostatic energy [J]. 

ShockleyCyl.
get_total_current
(nact=0)¶Get total current flowing through active region [mA]
ShockleyCyl.
get_total_heat
()¶Get the total heat produced by the current flowing in the structure.
Returns:  Total produced heat [mW]. 

ShockleyCyl.
initialize
()¶Initialize solver.
This method manually initialized the solver and sets initialized
to
True. Normally calling it is not necessary, as each solver automatically
initializes itself when needed.
Returns:  solver initialized state prior to this method call. 

Return type:  bool 
ShockleyCyl.
invalidate
()¶Set the solver back to uninitialized state.
This method frees the memory allocated by the solver and sets
initialized
to False.
ShockleyCyl.
inTemperature
¶Receiver of the temperature required for computations [K].
You will find usage details in the documentation of the receiver class
TemperatureReceiverCyl
.
Example
Connect the reveiver to a provider from some other solver:
>>> solver.inTemperature = other_solver.outTemperature
See also
Receciver class: plask.flow.TemperatureReceiverCyl
Provider class: plask.flow.TemperatureProviderCyl
Data filter: plask.filter.TemperatureFilterCyl
ShockleyCyl.
outConductivity
(mesh, interpolation='default')¶Provider of the computed electrical conductivity [S/m].
Parameters: 


Returns:  Data with the electrical conductivity on the specified mesh [S/m]. 
Example
Connect the provider to a receiver in some other solver:
>>> other_solver.inConductivity = solver.outConductivity
Obtain the provided field:
>>> solver.outConductivity(mesh)
<plask.Data at 0x1234567>
See also
Provider class: plask.flow.ConductivityProviderCyl
Receciver class: plask.flow.ConductivityReceiverCyl
ShockleyCyl.
outCurrentDensity
(mesh, interpolation='default')¶Provider of the computed current density [kA/cm²].
Parameters: 


Returns:  Data with the current density on the specified mesh [kA/cm²]. 
Example
Connect the provider to a receiver in some other solver:
>>> other_solver.inCurrentDensity = solver.outCurrentDensity
Obtain the provided field:
>>> solver.outCurrentDensity(mesh)
<plask.Data at 0x1234567>
See also
Provider class: plask.flow.CurrentDensityProviderCyl
Receciver class: plask.flow.CurrentDensityReceiverCyl
ShockleyCyl.
outHeat
(mesh, interpolation='default')¶Provider of the computed heat sources density [W/m³].
Parameters: 


Returns:  Data with the heat sources density on the specified mesh [W/m³]. 
Example
Connect the provider to a receiver in some other solver:
>>> other_solver.inHeat = solver.outHeat
Obtain the provided field:
>>> solver.outHeat(mesh)
<plask.Data at 0x1234567>
ShockleyCyl.
outPotential
¶Not available in this solver. Use outVoltage
instead.
ShockleyCyl.
outVoltage
(mesh, interpolation='default')¶Provider of the computed voltage [V].
Parameters: 


Returns:  Data with the voltage on the specified mesh [V]. 
Example
Connect the provider to a receiver in some other solver:
>>> other_solver.inVoltage = solver.outVoltage
Obtain the provided field:
>>> solver.outVoltage(mesh)
<plask.Data at 0x1234567>
See also
Provider class: plask.flow.VoltageProviderCyl
Receciver class: plask.flow.VoltageReceiverCyl
ShockleyCyl.
algorithm
¶Chosen matrix factorization algorithm
ShockleyCyl.
beta
¶Junction coefficient [1/V].
In case, there is more than one junction you may set $beta$ parameter for any
of them by using beta#
property, where # is the junction number (specified
by a role junction#
or active#
).
beta
is an alias for beta0
.
ShockleyCyl.
convergence
¶Convergence method.
If stable, covergence is slown down to ensure stability.
ShockleyCyl.
err
¶Maximum estimated error
ShockleyCyl.
geometry
¶Geometry provided to the solver
ShockleyCyl.
id
¶Id of the solver object. (read only)
Example
>>> mysolver.id
mysolver:category.type
ShockleyCyl.
include_empty
¶Should empty regions (e.g. air) be included into computation domain?
ShockleyCyl.
initialized
¶True if the solver has been initialized. (read only)
Solvers usually get initialized at the beginning of the computations.
You can clean the initialization state and free the memory by calling
the invalidate()
method.
ShockleyCyl.
itererr
¶Allowed residual iteration for iterative method
ShockleyCyl.
iterlim
¶Maximum number of iterations for iterative method
ShockleyCyl.
js
¶Reverse bias current density [A/m^{2}].
In case, there is more than one junction you may set $j_s$ parameter for any
of them by using js#
property, where # is the junction number (specified
by a role junction#
or active#
).
js
is an alias for js0
.
ShockleyCyl.
logfreq
¶Frequency of iteration progress reporting
ShockleyCyl.
maxerr
¶Limit for the potential updates
ShockleyCyl.
mesh
¶Mesh provided to the solver
ShockleyCyl.
ncond
¶Conductivity of the ncontact
ShockleyCyl.
pcond
¶Conductivity of the pcontact
ShockleyCyl.
pnjcond
¶Default effective conductivity of the active region.
Effective junction conductivity will be computed starting from this value.
Note that the actual junction conductivity after convergence can be obtained
with outConductivity
.
ShockleyCyl.
start_cond
¶Default effective conductivity of the active region.
Effective junction conductivity will be computed starting from this value.
Note that the actual junction conductivity after convergence can be obtained
with outConductivity
.
ShockleyCyl.
voltage_boundary
¶Boundary conditions of the first kind (constant potential)
This field holds a list of boundary conditions for the solver. You may access and alter is elements a normal Python list. Each element is a special class that has two attributes:
place 
Boundary condition location (plask.mesh.RectangularBase2D.Boundary ). 
value 
Boundary condition value. 
When you add new boundary condition, you may use twoargument append
, or
prepend
methods, or threeargument insert
method, where you separately
specify the place and the value. See the below example for clarification.
Example
>>> solver.voltage_boundary.clear()
>>> solver.voltage_boundary.append(solver.mesh.Bottom(), some_value)
>>> solver.voltage_boundary[0].value = different_value
>>> solver.voltage_boundary.insert(0, solver.mesh.Top(), new_value)
>>> solver.voltage_boundary[1].value == different_value
True