FermiCircle input documentation
===============================


Initialize Fermi-circle model material.


Used to initialize class :class:`qimpy.transport.material.FermiCircle`.

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

.. parsed-literal::

   :yamlparam:`qimpy.transport.material.FermiCircle:kF`: [:yamltype:`float`]       :yamlcomment:`# Fermi wave vector in atomic units.`
   :yamlparam:`qimpy.transport.material.FermiCircle:vF`: [:yamltype:`float`]       :yamlcomment:`# Fermi velocity in atomic units.`
   :yamlparam:`qimpy.transport.material.FermiCircle:N-theta`: [:yamltype:`int`]    :yamlcomment:`# Number of k along Fermi circle.`
   :yamlparam:`qimpy.transport.material.FermiCircle:r-c`: inf          :yamlcomment:`# Cyclotron radius, corresponding to external magnetic field`
   :yamlparam:`qimpy.transport.material.FermiCircle:theta0`: 0.0       :yamlcomment:`# Angle of first k-point.`
   :yamlparam:`qimpy.transport.material.FermiCircle:specularity`: 1.0  :yamlcomment:`# Specularity of reflection at all surfaces.`

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

kF
++

*Type:* :yamltype:`float`

Fermi wave vector in atomic units.

vF
++

*Type:* :yamltype:`float`

Fermi velocity in atomic units.

N-theta
+++++++

*Type:* :yamltype:`int`

Number of k along Fermi circle.

r-c
+++

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

Cyclotron radius, corresponding to external magnetic field.
If infinite, disable magentic field (default).

theta0
++++++

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

Angle of first k-point.

specularity
+++++++++++

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

Specularity of reflection at all surfaces.
Should be in the range of 0 for fully diffuse scattering,
to 1 for perfectly specular reflection.