Scatter input documentation
===========================


Initialize ab initio Lindbladian scattering.


Used to initialize class :class:`qimpy.transport.material.single_band.Scatter`.

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

.. parsed-literal::

   :yamlparam:`qimpy.transport.material.single_band.Scatter:dE`: [:yamltype:`float`]           :yamlcomment:`# Energy conservation width.`
   :yamlparam:`qimpy.transport.material.single_band.Scatter:epsilon-bg`: [:yamltype:`float`]   :yamlcomment:`# Background dielectric constant.`
   :yamlparam:`qimpy.transport.material.single_band.Scatter:lambda-D`: [:yamltype:`float`]     :yamlcomment:`# Debye screening length of electrons.`
   :yamlparam:`qimpy.transport.material.single_band.Scatter:block-size`: 128       :yamlcomment:`# Number of real-space points to calculate together.`
   :yamlparam:`qimpy.transport.material.single_band.Scatter:conserve-energy`: :yamlkey:`yes`  :yamlcomment:`# Whether to enforce exact energy conservation of e-e scattering.`

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

dE
++

*Type:* :yamltype:`float`

Energy conservation width.
Determines resolution of internal frequency grid.

epsilon-bg
++++++++++

*Type:* :yamltype:`float`

Background dielectric constant.

lambda-D
++++++++

*Type:* :yamltype:`float`

Debye screening length of electrons.

block-size
++++++++++

*Type:* :yamltype:`int`, *Default:*  128

Number of real-space points to calculate together.
Performance should generally increase with block_size,
but so does the memory requirement.

conserve-energy
+++++++++++++++

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

Whether to enforce exact energy conservation of e-e scattering.