`ShockleyCyl` Class
===============================================================================

.. currentmodule:: electrical.shockley

.. autoclass:: electrical.shockley.ShockleyCyl

Methods
-------

.. autosummary::

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

Attributes
----------

Receivers
^^^^^^^^^

.. autosummary::

   ~electrical.shockley.ShockleyCyl.inTemperature

Providers
^^^^^^^^^

.. autosummary::

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

Other
^^^^^

.. autosummary::

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


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

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

.. automethod:: electrical.shockley.ShockleyCyl.compute

.. automethod:: electrical.shockley.ShockleyCyl.get_capacitance

.. automethod:: electrical.shockley.ShockleyCyl.get_electrostatic_energy

.. automethod:: electrical.shockley.ShockleyCyl.get_total_current

.. automethod:: electrical.shockley.ShockleyCyl.get_total_heat

.. automethod:: electrical.shockley.ShockleyCyl.initialize

.. automethod:: electrical.shockley.ShockleyCyl.invalidate

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

.. autoattribute:: electrical.shockley.ShockleyCyl.inTemperature

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

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

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

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

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

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

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

.. autoattribute:: electrical.shockley.ShockleyCyl.algorithm

.. autoattribute:: electrical.shockley.ShockleyCyl.beta

.. autoattribute:: electrical.shockley.ShockleyCyl.convergence

.. autoattribute:: electrical.shockley.ShockleyCyl.empty_elements

.. autoattribute:: electrical.shockley.ShockleyCyl.err

.. autoattribute:: electrical.shockley.ShockleyCyl.geometry

.. autoattribute:: electrical.shockley.ShockleyCyl.id

.. autoattribute:: electrical.shockley.ShockleyCyl.initialized

.. autoattribute:: electrical.shockley.ShockleyCyl.iterative

.. autoattribute:: electrical.shockley.ShockleyCyl.js

.. autoattribute:: electrical.shockley.ShockleyCyl.maxerr

.. autoattribute:: electrical.shockley.ShockleyCyl.mesh

.. autoattribute:: electrical.shockley.ShockleyCyl.ncond

.. autoattribute:: electrical.shockley.ShockleyCyl.pcond

.. autoattribute:: electrical.shockley.ShockleyCyl.pnjcond

.. autoattribute:: electrical.shockley.ShockleyCyl.start_cond

.. autoattribute:: electrical.shockley.ShockleyCyl.voltage_boundary

.. template class.rst