`FreeCarrier3D` Class
===============================================================================

.. currentmodule:: gain.freecarrier

.. autoclass:: gain.freecarrier.FreeCarrier3D

Subclasses
----------

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

   ~gain.freecarrier.FreeCarrier3D.Spectrum

Methods
-------

.. autosummary::

   ~gain.freecarrier.FreeCarrier3D.det_El
   ~gain.freecarrier.FreeCarrier3D.det_Hh
   ~gain.freecarrier.FreeCarrier3D.det_Lh
   ~gain.freecarrier.FreeCarrier3D.getN
   ~gain.freecarrier.FreeCarrier3D.getP
   ~gain.freecarrier.FreeCarrier3D.get_energy_levels
   ~gain.freecarrier.FreeCarrier3D.get_fermi_levels
   ~gain.freecarrier.FreeCarrier3D.initialize
   ~gain.freecarrier.FreeCarrier3D.invalidate
   ~gain.freecarrier.FreeCarrier3D.spectrum

Attributes
----------

Receivers
^^^^^^^^^

.. autosummary::

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

Providers
^^^^^^^^^

.. autosummary::

   ~gain.freecarrier.FreeCarrier3D.outEnergyLevels
   ~gain.freecarrier.FreeCarrier3D.outGain

Other
^^^^^

.. autosummary::

   ~gain.freecarrier.FreeCarrier3D.T0
   ~gain.freecarrier.FreeCarrier3D.geometry
   ~gain.freecarrier.FreeCarrier3D.id
   ~gain.freecarrier.FreeCarrier3D.initialized
   ~gain.freecarrier.FreeCarrier3D.lifetime
   ~gain.freecarrier.FreeCarrier3D.matrix_element
   ~gain.freecarrier.FreeCarrier3D.strained


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

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

.. automethod:: gain.freecarrier.FreeCarrier3D.det_El

.. automethod:: gain.freecarrier.FreeCarrier3D.det_Hh

.. automethod:: gain.freecarrier.FreeCarrier3D.det_Lh

.. automethod:: gain.freecarrier.FreeCarrier3D.getN

.. automethod:: gain.freecarrier.FreeCarrier3D.getP

.. automethod:: gain.freecarrier.FreeCarrier3D.get_energy_levels

.. automethod:: gain.freecarrier.FreeCarrier3D.get_fermi_levels

.. automethod:: gain.freecarrier.FreeCarrier3D.initialize

.. automethod:: gain.freecarrier.FreeCarrier3D.invalidate

.. automethod:: gain.freecarrier.FreeCarrier3D.spectrum

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

.. autoattribute:: gain.freecarrier.FreeCarrier3D.inBandEdges

.. autoattribute:: gain.freecarrier.FreeCarrier3D.inCarriersConcentration

.. autoattribute:: gain.freecarrier.FreeCarrier3D.inFermiLevels

.. autoattribute:: gain.freecarrier.FreeCarrier3D.inTemperature

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

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

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

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

.. autoattribute:: gain.freecarrier.FreeCarrier3D.T0

.. autoattribute:: gain.freecarrier.FreeCarrier3D.geometry

.. autoattribute:: gain.freecarrier.FreeCarrier3D.id

.. autoattribute:: gain.freecarrier.FreeCarrier3D.initialized

.. autoattribute:: gain.freecarrier.FreeCarrier3D.lifetime

.. autoattribute:: gain.freecarrier.FreeCarrier3D.matrix_element

.. autoattribute:: gain.freecarrier.FreeCarrier3D.strained

.. template class.rst