`Shockley2D` Class
===============================================================================

.. currentmodule:: electrical.shockley

.. autoclass:: electrical.shockley.Shockley2D

Methods
-------

.. autosummary::

   ~electrical.shockley.Shockley2D.compute
   ~electrical.shockley.Shockley2D.get_capacitance
   ~electrical.shockley.Shockley2D.get_electrostatic_energy
   ~electrical.shockley.Shockley2D.get_total_current
   ~electrical.shockley.Shockley2D.get_total_heat
   ~electrical.shockley.Shockley2D.initialize
   ~electrical.shockley.Shockley2D.invalidate

Attributes
----------

Receivers
^^^^^^^^^

.. autosummary::

   ~electrical.shockley.Shockley2D.inTemperature

Providers
^^^^^^^^^

.. autosummary::

   ~electrical.shockley.Shockley2D.outConductivity
   ~electrical.shockley.Shockley2D.outCurrentDensity
   ~electrical.shockley.Shockley2D.outHeat
   ~electrical.shockley.Shockley2D.outPotential
   ~electrical.shockley.Shockley2D.outVoltage

Other
^^^^^

.. autosummary::

   ~electrical.shockley.Shockley2D.algorithm
   ~electrical.shockley.Shockley2D.beta
   ~electrical.shockley.Shockley2D.convergence
   ~electrical.shockley.Shockley2D.empty_elements
   ~electrical.shockley.Shockley2D.err
   ~electrical.shockley.Shockley2D.geometry
   ~electrical.shockley.Shockley2D.id
   ~electrical.shockley.Shockley2D.initialized
   ~electrical.shockley.Shockley2D.iterative
   ~electrical.shockley.Shockley2D.js
   ~electrical.shockley.Shockley2D.maxerr
   ~electrical.shockley.Shockley2D.mesh
   ~electrical.shockley.Shockley2D.ncond
   ~electrical.shockley.Shockley2D.pcond
   ~electrical.shockley.Shockley2D.pnjcond
   ~electrical.shockley.Shockley2D.start_cond
   ~electrical.shockley.Shockley2D.voltage_boundary


Descriptions
------------

Method Details
^^^^^^^^^^^^^^

.. automethod:: electrical.shockley.Shockley2D.compute

.. automethod:: electrical.shockley.Shockley2D.get_capacitance

.. automethod:: electrical.shockley.Shockley2D.get_electrostatic_energy

.. automethod:: electrical.shockley.Shockley2D.get_total_current

.. automethod:: electrical.shockley.Shockley2D.get_total_heat

.. automethod:: electrical.shockley.Shockley2D.initialize

.. automethod:: electrical.shockley.Shockley2D.invalidate

Receiver Details
^^^^^^^^^^^^^^^^

.. autoattribute:: electrical.shockley.Shockley2D.inTemperature

Provider Details
^^^^^^^^^^^^^^^^

.. autoattribute:: electrical.shockley.Shockley2D.outConductivity
   :show-signature:

.. autoattribute:: electrical.shockley.Shockley2D.outCurrentDensity
   :show-signature:

.. autoattribute:: electrical.shockley.Shockley2D.outHeat
   :show-signature:

.. autoattribute:: electrical.shockley.Shockley2D.outPotential
   :show-signature:

.. autoattribute:: electrical.shockley.Shockley2D.outVoltage
   :show-signature:

Attribute Details
^^^^^^^^^^^^^^^^^

.. autoattribute:: electrical.shockley.Shockley2D.algorithm

.. autoattribute:: electrical.shockley.Shockley2D.beta

.. autoattribute:: electrical.shockley.Shockley2D.convergence

.. autoattribute:: electrical.shockley.Shockley2D.empty_elements

.. autoattribute:: electrical.shockley.Shockley2D.err

.. autoattribute:: electrical.shockley.Shockley2D.geometry

.. autoattribute:: electrical.shockley.Shockley2D.id

.. autoattribute:: electrical.shockley.Shockley2D.initialized

.. autoattribute:: electrical.shockley.Shockley2D.iterative

.. autoattribute:: electrical.shockley.Shockley2D.js

.. autoattribute:: electrical.shockley.Shockley2D.maxerr

.. autoattribute:: electrical.shockley.Shockley2D.mesh

.. autoattribute:: electrical.shockley.Shockley2D.ncond

.. autoattribute:: electrical.shockley.Shockley2D.pcond

.. autoattribute:: electrical.shockley.Shockley2D.pnjcond

.. autoattribute:: electrical.shockley.Shockley2D.start_cond

.. autoattribute:: electrical.shockley.Shockley2D.voltage_boundary

.. template class.rst