# Shockley3D Class¶

class electrical.shockley.Shockley3D(name="")

Finite element thermal solver for 3D Cartesian geometry.

## Methods¶

 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.

## Attributes¶

 inTemperature Receiver of the temperature required for computations [K].

### Providers¶

 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].

### Other¶

 algorithm Chosen matrix factorization algorithm beta Junction coefficient [1/V]. 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/m2]. logfreq Frequency of iteration progress reporting maxerr Limit for the potential updates mesh Mesh provided to the solver ncond Conductivity of the n-contact pcond Conductivity of the p-contact pnjcond Default effective conductivity of the p-n junction. voltage_boundary Boundary conditions of the first kind (constant potential)

## Descriptions¶

### Method Details¶

Shockley3D.compute(loops=0)

Run electrical calculations

Shockley3D.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.

Shockley3D.get_electrostatic_energy()

Get the energy stored in the electrostatic field in the analyzed structure.

Returns: Total electrostatic energy [J].
Shockley3D.get_total_current(nact=0)

Get total current flowing through active region [mA]

Shockley3D.get_total_heat()

Get the total heat produced by the current flowing in the structure.

Returns: Total produced heat [mW].
Shockley3D.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. bool
Shockley3D.invalidate()

Set the solver back to uninitialized state.

This method frees the memory allocated by the solver and sets initialized to False.

Shockley3D.inTemperature

Receiver of the temperature required for computations [K].

You will find usage details in the documentation of the receiver class TemperatureReceiver3D.

Example

Connect the reveiver to a provider from some other solver:

>>> solver.inTemperature = other_solver.outTemperature


Receciver class: plask.flow.TemperatureReceiver3D

Provider class: plask.flow.TemperatureProvider3D

Data filter: plask.filter.TemperatureFilter3D

### Provider Details¶

Shockley3D.outConductivity(mesh, interpolation='default')

Provider of the computed electrical conductivity [S/m].

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

Shockley3D.outCurrentDensity(mesh, interpolation='default')

Provider of the computed current density [kA/cm²].

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

Shockley3D.outHeat(mesh, interpolation='default')

Provider of the computed heat sources density [W/m³].

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

Shockley3D.outPotential

Not available in this solver. Use outVoltage instead.

Shockley3D.outVoltage(mesh, interpolation='default')

Provider of the computed voltage [V].

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


### Attribute Details¶

Shockley3D.algorithm

Chosen matrix factorization algorithm

Shockley3D.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.

Shockley3D.err

Maximum estimated error

Shockley3D.geometry

Geometry provided to the solver

Shockley3D.id

Id of the solver object. (read only)

Example

>>> mysolver.id
mysolver:category.type

Shockley3D.include_empty

Should empty regions (e.g. air) be included into computation domain?

Shockley3D.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.

Shockley3D.itererr

Allowed residual iteration for iterative method

Shockley3D.iterlim

Maximum number of iterations for iterative method

Shockley3D.js

Reverse bias current density [A/m2].

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.

Shockley3D.logfreq

Frequency of iteration progress reporting

Shockley3D.maxerr

Shockley3D.mesh

Mesh provided to the solver

Shockley3D.ncond

Conductivity of the n-contact

Shockley3D.pcond

Conductivity of the p-contact

Shockley3D.pnjcond

Default effective conductivity of the p-n junction.

Effective junction conductivity will be computed starting from this value. Note that the actual junction conductivity after convergence can be obtained with outConductivity.

Shockley3D.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.RectangularBase3D.Boundary). value Boundary condition value.

When you add new boundary condition, you may use two-argument append, or prepend methods, or three-argument 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