`EffectiveFrequencyCyl` Class
===============================================================================

.. currentmodule:: optical.effective

.. autoclass:: optical.effective.EffectiveFrequencyCyl

Subclasses
----------

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

   ~optical.effective.EffectiveFrequencyCyl.Mode

Methods
-------

.. autosummary::

   ~optical.effective.EffectiveFrequencyCyl.clear_modes
   ~optical.effective.EffectiveFrequencyCyl.find_mode
   ~optical.effective.EffectiveFrequencyCyl.find_modes
   ~optical.effective.EffectiveFrequencyCyl.get_delta_neff
   ~optical.effective.EffectiveFrequencyCyl.get_determinant
   ~optical.effective.EffectiveFrequencyCyl.get_gain_integral
   ~optical.effective.EffectiveFrequencyCyl.get_nng
   ~optical.effective.EffectiveFrequencyCyl.get_total_absorption
   ~optical.effective.EffectiveFrequencyCyl.get_vert_determinant
   ~optical.effective.EffectiveFrequencyCyl.initialize
   ~optical.effective.EffectiveFrequencyCyl.invalidate
   ~optical.effective.EffectiveFrequencyCyl.set_mode
   ~optical.effective.EffectiveFrequencyCyl.set_simple_mesh

Attributes
----------

Receivers
^^^^^^^^^

.. autosummary::

   ~optical.effective.EffectiveFrequencyCyl.inCarriersConcentration
   ~optical.effective.EffectiveFrequencyCyl.inGain
   ~optical.effective.EffectiveFrequencyCyl.inTemperature

Providers
^^^^^^^^^

.. autosummary::

   ~optical.effective.EffectiveFrequencyCyl.outElectricField
   ~optical.effective.EffectiveFrequencyCyl.outHeat
   ~optical.effective.EffectiveFrequencyCyl.outLightE
   ~optical.effective.EffectiveFrequencyCyl.outLightMagnitude
   ~optical.effective.EffectiveFrequencyCyl.outLoss
   ~optical.effective.EffectiveFrequencyCyl.outRefractiveIndex
   ~optical.effective.EffectiveFrequencyCyl.outWavelength

Other
^^^^^

.. autosummary::

   ~optical.effective.EffectiveFrequencyCyl.determinant_mode
   ~optical.effective.EffectiveFrequencyCyl.emission
   ~optical.effective.EffectiveFrequencyCyl.geometry
   ~optical.effective.EffectiveFrequencyCyl.id
   ~optical.effective.EffectiveFrequencyCyl.initialized
   ~optical.effective.EffectiveFrequencyCyl.k0
   ~optical.effective.EffectiveFrequencyCyl.lam0
   ~optical.effective.EffectiveFrequencyCyl.mesh
   ~optical.effective.EffectiveFrequencyCyl.modes
   ~optical.effective.EffectiveFrequencyCyl.root
   ~optical.effective.EffectiveFrequencyCyl.stripe_root
   ~optical.effective.EffectiveFrequencyCyl.vat
   ~optical.effective.EffectiveFrequencyCyl.vlam


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

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

.. automethod:: optical.effective.EffectiveFrequencyCyl.clear_modes

.. automethod:: optical.effective.EffectiveFrequencyCyl.find_mode

.. automethod:: optical.effective.EffectiveFrequencyCyl.find_modes

.. automethod:: optical.effective.EffectiveFrequencyCyl.get_delta_neff

.. automethod:: optical.effective.EffectiveFrequencyCyl.get_determinant

.. automethod:: optical.effective.EffectiveFrequencyCyl.get_gain_integral

.. automethod:: optical.effective.EffectiveFrequencyCyl.get_nng

.. automethod:: optical.effective.EffectiveFrequencyCyl.get_total_absorption

.. automethod:: optical.effective.EffectiveFrequencyCyl.get_vert_determinant

.. automethod:: optical.effective.EffectiveFrequencyCyl.initialize

.. automethod:: optical.effective.EffectiveFrequencyCyl.invalidate

.. automethod:: optical.effective.EffectiveFrequencyCyl.set_mode

.. automethod:: optical.effective.EffectiveFrequencyCyl.set_simple_mesh

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

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.inCarriersConcentration

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.inGain

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.inTemperature

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

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

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

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

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

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.outLoss
   :show-signature:

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

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.outWavelength
   :show-signature:

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

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.determinant_mode

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.emission

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.geometry

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.id

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.initialized

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.k0

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.lam0

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.mesh

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.modes

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.root

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.stripe_root

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.vat

.. autoattribute:: optical.effective.EffectiveFrequencyCyl.vlam

.. template class.rst