`EffectiveIndex2D` Class
===============================================================================

.. currentmodule:: optical.effective

.. autoclass:: optical.effective.EffectiveIndex2D

Subclasses
----------

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

   ~optical.effective.EffectiveIndex2D.Mode

Methods
-------

.. autosummary::

   ~optical.effective.EffectiveIndex2D.clear_modes
   ~optical.effective.EffectiveIndex2D.find_mode
   ~optical.effective.EffectiveIndex2D.find_modes
   ~optical.effective.EffectiveIndex2D.get_delta_neff
   ~optical.effective.EffectiveIndex2D.get_determinant
   ~optical.effective.EffectiveIndex2D.get_total_absorption
   ~optical.effective.EffectiveIndex2D.get_vert_determinant
   ~optical.effective.EffectiveIndex2D.initialize
   ~optical.effective.EffectiveIndex2D.invalidate
   ~optical.effective.EffectiveIndex2D.search_vneff
   ~optical.effective.EffectiveIndex2D.set_mode
   ~optical.effective.EffectiveIndex2D.set_simple_mesh

Attributes
----------

Receivers
^^^^^^^^^

.. autosummary::

   ~optical.effective.EffectiveIndex2D.inCarriersConcentration
   ~optical.effective.EffectiveIndex2D.inGain
   ~optical.effective.EffectiveIndex2D.inTemperature

Providers
^^^^^^^^^

.. autosummary::

   ~optical.effective.EffectiveIndex2D.outElectricField
   ~optical.effective.EffectiveIndex2D.outHeat
   ~optical.effective.EffectiveIndex2D.outLightE
   ~optical.effective.EffectiveIndex2D.outLightMagnitude
   ~optical.effective.EffectiveIndex2D.outNeff
   ~optical.effective.EffectiveIndex2D.outRefractiveIndex

Other
^^^^^

.. autosummary::

   ~optical.effective.EffectiveIndex2D.emission
   ~optical.effective.EffectiveIndex2D.geometry
   ~optical.effective.EffectiveIndex2D.id
   ~optical.effective.EffectiveIndex2D.initialized
   ~optical.effective.EffectiveIndex2D.mesh
   ~optical.effective.EffectiveIndex2D.mirrors
   ~optical.effective.EffectiveIndex2D.modes
   ~optical.effective.EffectiveIndex2D.polarization
   ~optical.effective.EffectiveIndex2D.root
   ~optical.effective.EffectiveIndex2D.stripe_root
   ~optical.effective.EffectiveIndex2D.vat
   ~optical.effective.EffectiveIndex2D.vneff
   ~optical.effective.EffectiveIndex2D.wavelength


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

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

.. automethod:: optical.effective.EffectiveIndex2D.clear_modes

.. automethod:: optical.effective.EffectiveIndex2D.find_mode

.. automethod:: optical.effective.EffectiveIndex2D.find_modes

.. automethod:: optical.effective.EffectiveIndex2D.get_delta_neff

.. automethod:: optical.effective.EffectiveIndex2D.get_determinant

.. automethod:: optical.effective.EffectiveIndex2D.get_total_absorption

.. automethod:: optical.effective.EffectiveIndex2D.get_vert_determinant

.. automethod:: optical.effective.EffectiveIndex2D.initialize

.. automethod:: optical.effective.EffectiveIndex2D.invalidate

.. automethod:: optical.effective.EffectiveIndex2D.search_vneff

.. automethod:: optical.effective.EffectiveIndex2D.set_mode

.. automethod:: optical.effective.EffectiveIndex2D.set_simple_mesh

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

.. autoattribute:: optical.effective.EffectiveIndex2D.inCarriersConcentration

.. autoattribute:: optical.effective.EffectiveIndex2D.inGain

.. autoattribute:: optical.effective.EffectiveIndex2D.inTemperature

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

.. autoattribute:: optical.effective.EffectiveIndex2D.outElectricField
   :show-signature:

.. autoattribute:: optical.effective.EffectiveIndex2D.outHeat
   :show-signature:

.. autoattribute:: optical.effective.EffectiveIndex2D.outLightE
   :show-signature:

.. autoattribute:: optical.effective.EffectiveIndex2D.outLightMagnitude
   :show-signature:

.. autoattribute:: optical.effective.EffectiveIndex2D.outNeff
   :show-signature:

.. autoattribute:: optical.effective.EffectiveIndex2D.outRefractiveIndex
   :show-signature:

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

.. autoattribute:: optical.effective.EffectiveIndex2D.emission

.. autoattribute:: optical.effective.EffectiveIndex2D.geometry

.. autoattribute:: optical.effective.EffectiveIndex2D.id

.. autoattribute:: optical.effective.EffectiveIndex2D.initialized

.. autoattribute:: optical.effective.EffectiveIndex2D.mesh

.. autoattribute:: optical.effective.EffectiveIndex2D.mirrors

.. autoattribute:: optical.effective.EffectiveIndex2D.modes

.. autoattribute:: optical.effective.EffectiveIndex2D.polarization

.. autoattribute:: optical.effective.EffectiveIndex2D.root

.. autoattribute:: optical.effective.EffectiveIndex2D.stripe_root

.. autoattribute:: optical.effective.EffectiveIndex2D.vat

.. autoattribute:: optical.effective.EffectiveIndex2D.vneff

.. autoattribute:: optical.effective.EffectiveIndex2D.wavelength

.. template class.rst