`Fourier3D` Class
===============================================================================

.. currentmodule:: optical.modal

.. autoclass:: optical.modal.Fourier3D

Subclasses
----------

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

   ~optical.modal.Fourier3D.Eigenmodes
   ~optical.modal.Fourier3D.Mode
   ~optical.modal.Fourier3D.Oversampling
   ~optical.modal.Fourier3D.PMLs
   ~optical.modal.Fourier3D.Scattering
   ~optical.modal.Fourier3D.Sizes
   ~optical.modal.Fourier3D.Symmetries

Methods
-------

.. autosummary::

   ~optical.modal.Fourier3D.compute_reflectivity
   ~optical.modal.Fourier3D.compute_transmittivity
   ~optical.modal.Fourier3D.find_mode
   ~optical.modal.Fourier3D.gaussian
   ~optical.modal.Fourier3D.get_determinant
   ~optical.modal.Fourier3D.get_raw_E
   ~optical.modal.Fourier3D.get_raw_H
   ~optical.modal.Fourier3D.initialize
   ~optical.modal.Fourier3D.integrateEE
   ~optical.modal.Fourier3D.integrateHH
   ~optical.modal.Fourier3D.invalidate
   ~optical.modal.Fourier3D.layer_eigenmodes
   ~optical.modal.Fourier3D.scattering
   ~optical.modal.Fourier3D.scattering_gaussian
   ~optical.modal.Fourier3D.set_interface
   ~optical.modal.Fourier3D.set_mode

Attributes
----------

Receivers
^^^^^^^^^

.. autosummary::

   ~optical.modal.Fourier3D.inCarriersConcentration
   ~optical.modal.Fourier3D.inEpsilon
   ~optical.modal.Fourier3D.inGain
   ~optical.modal.Fourier3D.inTemperature

Providers
^^^^^^^^^

.. autosummary::

   ~optical.modal.Fourier3D.outDownwardsLightE
   ~optical.modal.Fourier3D.outDownwardsLightH
   ~optical.modal.Fourier3D.outEpsilon
   ~optical.modal.Fourier3D.outGradients
   ~optical.modal.Fourier3D.outLightE
   ~optical.modal.Fourier3D.outLightH
   ~optical.modal.Fourier3D.outLightMagnitude
   ~optical.modal.Fourier3D.outRefractiveIndex
   ~optical.modal.Fourier3D.outUpwardsLightE
   ~optical.modal.Fourier3D.outUpwardsLightH
   ~optical.modal.Fourier3D.outWavelength

Other
^^^^^

.. autosummary::

   ~optical.modal.Fourier3D.dct
   ~optical.modal.Fourier3D.determinant_type
   ~optical.modal.Fourier3D.emission
   ~optical.modal.Fourier3D.geometry
   ~optical.modal.Fourier3D.grad_smooth
   ~optical.modal.Fourier3D.group_layers
   ~optical.modal.Fourier3D.id
   ~optical.modal.Fourier3D.initialized
   ~optical.modal.Fourier3D.interface
   ~optical.modal.Fourier3D.k0
   ~optical.modal.Fourier3D.klong
   ~optical.modal.Fourier3D.ktran
   ~optical.modal.Fourier3D.lam
   ~optical.modal.Fourier3D.lam0
   ~optical.modal.Fourier3D.layer_centers
   ~optical.modal.Fourier3D.layer_edges
   ~optical.modal.Fourier3D.modes
   ~optical.modal.Fourier3D.pmls
   ~optical.modal.Fourier3D.refine
   ~optical.modal.Fourier3D.root
   ~optical.modal.Fourier3D.rule
   ~optical.modal.Fourier3D.size
   ~optical.modal.Fourier3D.smooth
   ~optical.modal.Fourier3D.stack
   ~optical.modal.Fourier3D.symmetry
   ~optical.modal.Fourier3D.temp_diff
   ~optical.modal.Fourier3D.temp_dist
   ~optical.modal.Fourier3D.temp_layer
   ~optical.modal.Fourier3D.transfer
   ~optical.modal.Fourier3D.update_gain
   ~optical.modal.Fourier3D.vpml
   ~optical.modal.Fourier3D.wavelength


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

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

.. automethod:: optical.modal.Fourier3D.compute_reflectivity

.. automethod:: optical.modal.Fourier3D.compute_transmittivity

.. automethod:: optical.modal.Fourier3D.find_mode

.. automethod:: optical.modal.Fourier3D.gaussian

.. automethod:: optical.modal.Fourier3D.get_determinant

.. automethod:: optical.modal.Fourier3D.get_raw_E

.. automethod:: optical.modal.Fourier3D.get_raw_H

.. automethod:: optical.modal.Fourier3D.initialize

.. automethod:: optical.modal.Fourier3D.integrateEE

.. automethod:: optical.modal.Fourier3D.integrateHH

.. automethod:: optical.modal.Fourier3D.invalidate

.. automethod:: optical.modal.Fourier3D.layer_eigenmodes

.. automethod:: optical.modal.Fourier3D.scattering

.. automethod:: optical.modal.Fourier3D.scattering_gaussian

.. automethod:: optical.modal.Fourier3D.set_interface

.. automethod:: optical.modal.Fourier3D.set_mode

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

.. autoattribute:: optical.modal.Fourier3D.inCarriersConcentration

.. autoattribute:: optical.modal.Fourier3D.inEpsilon

.. autoattribute:: optical.modal.Fourier3D.inGain

.. autoattribute:: optical.modal.Fourier3D.inTemperature

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

.. autoattribute:: optical.modal.Fourier3D.outDownwardsLightE
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outDownwardsLightH
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outEpsilon
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outGradients
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outLightE
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outLightH
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outLightMagnitude
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outRefractiveIndex
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outUpwardsLightE
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outUpwardsLightH
   :show-signature:

.. autoattribute:: optical.modal.Fourier3D.outWavelength
   :show-signature:

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

.. autoattribute:: optical.modal.Fourier3D.dct

.. autoattribute:: optical.modal.Fourier3D.determinant_type

.. autoattribute:: optical.modal.Fourier3D.emission

.. autoattribute:: optical.modal.Fourier3D.geometry

.. autoattribute:: optical.modal.Fourier3D.grad_smooth

.. autoattribute:: optical.modal.Fourier3D.group_layers

.. autoattribute:: optical.modal.Fourier3D.id

.. autoattribute:: optical.modal.Fourier3D.initialized

.. autoattribute:: optical.modal.Fourier3D.interface

.. autoattribute:: optical.modal.Fourier3D.k0

.. autoattribute:: optical.modal.Fourier3D.klong

.. autoattribute:: optical.modal.Fourier3D.ktran

.. autoattribute:: optical.modal.Fourier3D.lam

.. autoattribute:: optical.modal.Fourier3D.lam0

.. autoattribute:: optical.modal.Fourier3D.layer_centers

.. autoattribute:: optical.modal.Fourier3D.layer_edges

.. autoattribute:: optical.modal.Fourier3D.modes

.. autoattribute:: optical.modal.Fourier3D.pmls

.. autoattribute:: optical.modal.Fourier3D.refine

.. autoattribute:: optical.modal.Fourier3D.root

.. autoattribute:: optical.modal.Fourier3D.rule

.. autoattribute:: optical.modal.Fourier3D.size

.. autoattribute:: optical.modal.Fourier3D.smooth

.. autoattribute:: optical.modal.Fourier3D.stack

.. autoattribute:: optical.modal.Fourier3D.symmetry

.. autoattribute:: optical.modal.Fourier3D.temp_diff

.. autoattribute:: optical.modal.Fourier3D.temp_dist

.. autoattribute:: optical.modal.Fourier3D.temp_layer

.. autoattribute:: optical.modal.Fourier3D.transfer

.. autoattribute:: optical.modal.Fourier3D.update_gain

.. autoattribute:: optical.modal.Fourier3D.vpml

.. autoattribute:: optical.modal.Fourier3D.wavelength

.. template class.rst