`FreeCarrier2D` Class
===============================================================================

.. currentmodule:: gain.freecarrier

.. autoclass:: gain.freecarrier.FreeCarrier2D

Subclasses
----------

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

   ~gain.freecarrier.FreeCarrier2D.Spectrum

Methods
-------

.. autosummary::

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

Attributes
----------

Receivers
^^^^^^^^^

.. autosummary::

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

Providers
^^^^^^^^^

.. autosummary::

   ~gain.freecarrier.FreeCarrier2D.outEnergyLevels
   ~gain.freecarrier.FreeCarrier2D.outGain

Other
^^^^^

.. autosummary::

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


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

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

.. automethod:: gain.freecarrier.FreeCarrier2D.get_energy_levels

.. automethod:: gain.freecarrier.FreeCarrier2D.get_fermi_levels

.. automethod:: gain.freecarrier.FreeCarrier2D.initialize

.. automethod:: gain.freecarrier.FreeCarrier2D.invalidate

.. automethod:: gain.freecarrier.FreeCarrier2D.spectrum

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

.. autoattribute:: gain.freecarrier.FreeCarrier2D.inBandEdges

.. autoattribute:: gain.freecarrier.FreeCarrier2D.inCarriersConcentration

.. autoattribute:: gain.freecarrier.FreeCarrier2D.inFermiLevels

.. autoattribute:: gain.freecarrier.FreeCarrier2D.inTemperature

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

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

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

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

.. autoattribute:: gain.freecarrier.FreeCarrier2D.T0

.. autoattribute:: gain.freecarrier.FreeCarrier2D.geometry

.. autoattribute:: gain.freecarrier.FreeCarrier2D.id

.. autoattribute:: gain.freecarrier.FreeCarrier2D.initialized

.. autoattribute:: gain.freecarrier.FreeCarrier2D.lifetime

.. autoattribute:: gain.freecarrier.FreeCarrier2D.matrix_element

.. autoattribute:: gain.freecarrier.FreeCarrier2D.mesh

.. autoattribute:: gain.freecarrier.FreeCarrier2D.strained

.. autoattribute:: gain.freecarrier.FreeCarrier2D.substrate

.. template class.rst