`FreeCarrierCyl` Class
===============================================================================

.. currentmodule:: gain.freecarrier

.. autoclass:: gain.freecarrier.FreeCarrierCyl

Subclasses
----------

.. autosummary::
   :nosignatures:
   :toctree: FreeCarrierCyl
   :template: class.rst

   ~gain.freecarrier.FreeCarrierCyl.Spectrum

Methods
-------

.. autosummary::

   ~gain.freecarrier.FreeCarrierCyl.get_energy_levels
   ~gain.freecarrier.FreeCarrierCyl.get_fermi_levels
   ~gain.freecarrier.FreeCarrierCyl.initialize
   ~gain.freecarrier.FreeCarrierCyl.invalidate
   ~gain.freecarrier.FreeCarrierCyl.spectrum

Attributes
----------

Receivers
^^^^^^^^^

.. autosummary::

   ~gain.freecarrier.FreeCarrierCyl.inBandEdges
   ~gain.freecarrier.FreeCarrierCyl.inCarriersConcentration
   ~gain.freecarrier.FreeCarrierCyl.inFermiLevels
   ~gain.freecarrier.FreeCarrierCyl.inTemperature

Providers
^^^^^^^^^

.. autosummary::

   ~gain.freecarrier.FreeCarrierCyl.outEnergyLevels
   ~gain.freecarrier.FreeCarrierCyl.outGain

Other
^^^^^

.. autosummary::

   ~gain.freecarrier.FreeCarrierCyl.T0
   ~gain.freecarrier.FreeCarrierCyl.geometry
   ~gain.freecarrier.FreeCarrierCyl.id
   ~gain.freecarrier.FreeCarrierCyl.initialized
   ~gain.freecarrier.FreeCarrierCyl.lifetime
   ~gain.freecarrier.FreeCarrierCyl.matrix_element
   ~gain.freecarrier.FreeCarrierCyl.mesh
   ~gain.freecarrier.FreeCarrierCyl.strained
   ~gain.freecarrier.FreeCarrierCyl.substrate


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

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

.. automethod:: gain.freecarrier.FreeCarrierCyl.get_energy_levels

.. automethod:: gain.freecarrier.FreeCarrierCyl.get_fermi_levels

.. automethod:: gain.freecarrier.FreeCarrierCyl.initialize

.. automethod:: gain.freecarrier.FreeCarrierCyl.invalidate

.. automethod:: gain.freecarrier.FreeCarrierCyl.spectrum

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

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.inBandEdges

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.inCarriersConcentration

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.inFermiLevels

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.inTemperature

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

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.outEnergyLevels
   :show-signature:

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.outGain
   :show-signature:

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

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.T0

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.geometry

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.id

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.initialized

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.lifetime

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.matrix_element

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.mesh

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.strained

.. autoattribute:: gain.freecarrier.FreeCarrierCyl.substrate

.. template class.rst