RelaxationTime input documentation
==================================


Initialize relaxation time approximation for scattering.


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

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

.. parsed-literal::

   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:tau-e`: inf          :yamlcomment:`# Conduction bands relaxation time.`
   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:tau-h`: inf          :yamlcomment:`# Valance bands relaxation time.`
   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:tau-s-e`: inf        :yamlcomment:`# Electron spin relaxation time.`
   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:tau-s-h`: inf        :yamlcomment:`# Hole spin relaxation time.`
   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:tau-eh`: inf         :yamlcomment:`# Relaxation time of conduction-valance off diagonal terms.`
   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:max-dmu`: 0.001      :yamlcomment:`# Maximum mu change in Newton-Rhapson method.`
   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:tau-recomb`: inf     :yamlcomment:`# Recombination time.`
   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:nv`: 0               :yamlcomment:`# Number of valance bands.`
   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:eps`: 1e-12          :yamlcomment:`# Precision in the determination of mu_e and mu_h.`
   :yamlparam:`qimpy.transport.material.ab_initio.RelaxationTime:only-diagonal`: :yamlkey:`yes`  :yamlcomment:`# Whether only diagonal terms change.`

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

tau-e
+++++

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

Conduction bands relaxation time.

tau-h
+++++

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

Valance bands relaxation time.

tau-s-e
+++++++

*Type:* :yamltype:`float` or :yamltype:`list` of :yamltype:`float`, *Default:*  inf

Electron spin relaxation time.
Note that `tau_e` must also be set to use this.
Can be a single number, or three components for each spin direction.

tau-s-h
+++++++

*Type:* :yamltype:`float` or :yamltype:`list` of :yamltype:`float`, *Default:*  inf

Hole spin relaxation time.
Note that `tau_h` must also be set to use this.
Can be a single number, or three components for each spin direction.

tau-eh
++++++

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

Relaxation time of conduction-valance off diagonal terms.

max-dmu
+++++++

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

Maximum mu change in Newton-Rhapson method.

tau-recomb
++++++++++

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

Recombination time.

nv
++

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

Number of valance bands.

eps
+++

*Type:* :yamltype:`float`, *Default:*  1e-12

Precision in the determination of mu_e and mu_h.

only-diagonal
+++++++++++++

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

Whether only diagonal terms change.