Light input documentation
=========================


Initialize coherent light interaction.


Used to initialize class :class:`qimpy.transport.material.ab_initio.Light`.

YAML template:
--------------

.. parsed-literal::

   :yamlparam:`qimpy.transport.material.ab_initio.Light:coherent`: :yamlkey:`yes`    :yamlcomment:`# Switch between coherent and Lindbladian implementations.`
   :yamlparam:`qimpy.transport.material.ab_initio.Light:gauge`: velocity  :yamlcomment:`# Switch between 'velocity' or 'length' gauge.`
   :yamlparam:`qimpy.transport.material.ab_initio.Light:A0`: :yamlkey:`null`         :yamlcomment:`# Vector potential amplitude.`
   :yamlparam:`qimpy.transport.material.ab_initio.Light:E0`: :yamlkey:`null`         :yamlcomment:`# Electric-field amplitude.`
   :yamlparam:`qimpy.transport.material.ab_initio.Light:omega`: 0.0       :yamlcomment:`# Angular frequency / photon energy of the light.`
   :yamlparam:`qimpy.transport.material.ab_initio.Light:t0`: 0.0          :yamlcomment:`# Center of Gaussian pulse, used only if sigma is non-zero.`
   :yamlparam:`qimpy.transport.material.ab_initio.Light:sigma`: 0.0       :yamlcomment:`# Time width of Gaussian pulse, if non-zero.`
   :yamlparam:`qimpy.transport.material.ab_initio.Light:smearing`: 0.001  :yamlcomment:`# Width of Gaussian function to represent delta function.`

Parameters:
-----------

coherent
++++++++

*Type:* :yamltype:`bool`, *Default:*  :yamlkey:`yes`

Switch between coherent and Lindbladian implementations.

gauge
+++++

*Type:* :yamltype:`string`, *Default:*  velocity

Switch between 'velocity' or 'length' gauge.

A0
++

*Type:* :yamltype:`list` of <class 'complex'>, or :yamltype:`null`, *Default:*  :yamlkey:`null`

Vector potential amplitude.
TODO: specify details about differences in CW vs pulse mode.
Exactly one of A0 or E0 must be specified.

E0
++

*Type:* :yamltype:`list` of <class 'complex'>, or :yamltype:`null`, *Default:*  :yamlkey:`null`

Electric-field amplitude.
Exactly one of A0 or E0 must be specified.

omega
+++++

*Type:* :yamltype:`float`, *Default:*  0.0

Angular frequency / photon energy of the light.

t0
++

*Type:* :yamltype:`float`, *Default:*  0.0

Center of Gaussian pulse, used only if sigma is non-zero.

sigma
+++++

*Type:* :yamltype:`float`, *Default:*  0.0

Time width of Gaussian pulse, if non-zero.

smearing
++++++++

*Type:* :yamltype:`float`, *Default:*  0.001

Width of Gaussian function to represent delta function.