PAOFLOW.boltzmann.scattering_channels#

Scattering channels: relaxation rates for transport and optical response.

A scattering channel returns a relaxation rate \(1/\tau\) (1/s) as a function of temperature and, where meaningful, of the carrier energy (DC transport) or of the photon frequency (optical response). Channels combine by Matthiessen’s rule (matthiessen()), and the same objects feed

  • the Boltzmann transport tensors of PAOFLOW.PAOFLOW.transport() (scattering_channels=[...], through get_tau()), and

  • the (extended) Drude dielectric function of metals (PAOFLOW.response.drude).

Channels:

  • ConstantRate, ResidualResistivity – energy- and temperature-independent rates (impurities, defects);

  • FermiLiquidRate – electron-electron scattering, \(\hbar/\tau = b[(E-\mu)^2 + (\pi k_BT)^2]\) (DC) or \(b[(\hbar\omega)^2 + (2\pi k_BT)^2]\) (optical);

  • PhenomenologicalChannel – the semiconductor models of do_tau_models (acoustic and optical deformation potential, polar optical, piezoelectric, ionized impurity) or any f(kT_eV, |E|_eV, params) -> tau function;

  • TransportSpectralChannel – electron-phonon scattering from the transport Eliashberg function \(\alpha^2F_{tr}(\omega)\) (Allen), with the frequency-dependent rate and mass enhancement of the extended Drude model;

  • EnergyResolvedRate – a tabulated \(1/\tau(E, T)\), e.g. the ab initio SERTA/MRTA electron-phonon rates of semiconductors from PAOFLOW.elphon.carrier_scattering.

Units at the interface: temperatures in K, energies and frequencies in eV (\(\hbar\omega\)), rates in 1/s.

Attributes#

Classes#

ScatteringChannel

Interface of a scattering channel: a relaxation rate in 1/s.

ConstantRate

Energy-, frequency- and temperature-independent rate.

ResidualResistivity

Constant rate that gives a residual resistivity \(\rho_0\) with a plasma frequency.

FermiLiquidRate

Electron-electron (Fermi-liquid) scattering.

PhenomenologicalChannel

Adapter for the relaxation-time models of do_tau_models.

TransportSpectralChannel

Electron-phonon scattering from the transport Eliashberg function.

EnergyResolvedRate

Tabulated rate \(1/\tau(E, T)\), e.g. ab initio electron-phonon scattering.

Functions#

matthiessen(channels, temperature_k[, energy_ev, omega_ev])

Total relaxation rate by Matthiessen's rule.

total_mass_enhancement(channels, omega_ev, temperature_k)

Sum of the channels' optical mass enhancements \(\lambda(\omega, T)\).

Module Contents#

PAOFLOW.boltzmann.scattering_channels.HBAR_EV_S = 6.582119569e-16[source]#
PAOFLOW.boltzmann.scattering_channels.KB_EV_K = 8.617333262e-05[source]#
PAOFLOW.boltzmann.scattering_channels.EPSILON0_SI = 8.8541878128e-12[source]#
class PAOFLOW.boltzmann.scattering_channels.ScatteringChannel[source]#

Interface of a scattering channel: a relaxation rate in 1/s.

Subclasses implement rate(). energy_ev (carrier energy relative to the chemical potential) is used by energy-resolved (DC) channels and omega_ev (photon energy) by frequency-resolved (optical) channels; a channel that depends on neither broadcasts its value to the shape of the one given.

name = 'channel'[source]#
abstractmethod rate(temperature_k, energy_ev=None, omega_ev=None)[source]#

Relaxation rate \(1/\tau\) (1/s).

Parameters:
  • temperature_k (float) – Temperature (K).

  • energy_ev (array_like, optional) – Carrier energies relative to the chemical potential (eV).

  • omega_ev (array_like, optional) – Photon energies (eV), for the optical rate.

Returns:

Rates (1/s), shaped like omega_ev or energy_ev.

Return type:

ndarray

mass_enhancement(omega_ev, temperature_k)[source]#

Optical mass enhancement \(\lambda(\omega, T)\) (0 unless overridden).

bind(data_controller)[source]#

Adapt the channel to the band structure of a Boltzmann run (no-op by default).

Called by get_tau() on every rank before the rates are evaluated.

class PAOFLOW.boltzmann.scattering_channels.ConstantRate(rate_per_s, name='constant')[source]#

Bases: ScatteringChannel

Energy-, frequency- and temperature-independent rate.

Parameters:
  • rate_per_s (float) – Relaxation rate (1/s).

  • name (str, optional) – Label.

rate_per_s[source]#
name = 'constant'[source]#
rate(temperature_k, energy_ev=None, omega_ev=None)[source]#

Relaxation rate \(1/\tau\) (1/s).

Parameters:
  • temperature_k (float) – Temperature (K).

  • energy_ev (array_like, optional) – Carrier energies relative to the chemical potential (eV).

  • omega_ev (array_like, optional) – Photon energies (eV), for the optical rate.

Returns:

Rates (1/s), shaped like omega_ev or energy_ev.

Return type:

ndarray

class PAOFLOW.boltzmann.scattering_channels.ResidualResistivity(rho0_ohm_m, plasma_ev)[source]#

Bases: ConstantRate

Constant rate that gives a residual resistivity \(\rho_0\) with a plasma frequency.

Parameters:
  • rho0_ohm_m (float) – Residual resistivity (Ohm m).

  • plasma_ev (float) – Plasma frequency \(\hbar\omega_p\) (eV).

Notes

From the Drude resistivity \(\rho = 1/(\varepsilon_0\omega_p^2\tau)\), \(1/\tau_0 = \varepsilon_0\,\omega_p^2\,\rho_0\).

rho0_ohm_m[source]#
class PAOFLOW.boltzmann.scattering_channels.FermiLiquidRate(coefficient_per_ev, name='electron-electron')[source]#

Bases: ScatteringChannel

Electron-electron (Fermi-liquid) scattering.

Parameters:

coefficient_per_ev (float) – \(b\) (1/eV) in \(\hbar/\tau = b\,[\ldots]\).

Notes

\[\frac{\hbar}{\tau_{DC}} = b\left[(E-\mu)^2 + (\pi k_BT)^2\right], \qquad \frac{\hbar}{\tau(\omega)} = b\left[(\hbar\omega)^2 + (2\pi k_BT)^2\right]\]

(Gurzhi); the optical form applies when omega_ev is given.

coefficient_per_ev[source]#
name = 'electron-electron'[source]#
rate(temperature_k, energy_ev=None, omega_ev=None)[source]#

Relaxation rate \(1/\tau\) (1/s).

Parameters:
  • temperature_k (float) – Temperature (K).

  • energy_ev (array_like, optional) – Carrier energies relative to the chemical potential (eV).

  • omega_ev (array_like, optional) – Photon energies (eV), for the optical rate.

Returns:

Rates (1/s), shaped like omega_ev or energy_ev.

Return type:

ndarray

class PAOFLOW.boltzmann.scattering_channels.PhenomenologicalChannel(model, params=None, weight=1.0)[source]#

Bases: ScatteringChannel

Adapter for the relaxation-time models of do_tau_models.

Parameters:
  • model (str, callable or TauModel) – A built-in label ('acoustic', 'optical', 'polar_optical', 'polar_acoustic', 'impurity'), a function f(kT_eV, |E|_eV, params) -> tau (s) or a TauModel.

  • params (dict, optional) – Model parameters (see do_tau_models).

  • weight (float, optional) – Weight \(w\) of the channel, \(1/\tau = w/\tau_{model}\).

Notes

The models depend on \(|E|\) measured from the energy zero of the calculation and on \(k_BT\); they need energy_ev (they have no optical form).

weight[source]#
rate(temperature_k, energy_ev=None, omega_ev=None)[source]#

Relaxation rate \(1/\tau\) (1/s).

Parameters:
  • temperature_k (float) – Temperature (K).

  • energy_ev (array_like, optional) – Carrier energies relative to the chemical potential (eV).

  • omega_ev (array_like, optional) – Photon energies (eV), for the optical rate.

Returns:

Rates (1/s), shaped like omega_ev or energy_ev.

Return type:

ndarray

class PAOFLOW.boltzmann.scattering_channels.TransportSpectralChannel(omega_ev, a2f_tr, name='e-ph')[source]#

Bases: ScatteringChannel

Electron-phonon scattering from the transport Eliashberg function.

Parameters:
  • omega_ev (array_like, shape (nw,)) – Phonon energies (eV), increasing.

  • a2f_tr (array_like, shape (nw,)) – \(\alpha^2F_{tr}(\omega)\) (dimensionless), e.g. from eliashberg_dense_q() with transport=True.

  • name (str, optional) – Label.

Notes

DC rate (Allen; Grimvall), with \(x = \hbar\omega/2k_BT\):

\[\frac{1}{\tau_{tr}(T)} = \frac{4\pi k_BT}{\hbar}\int\frac{d\omega}{\omega}\, \alpha^2F_{tr}(\omega)\left[\frac{x}{\sinh x}\right]^2 \;\xrightarrow{\;k_BT \gg \hbar\omega\;}\; \frac{2\pi\lambda_{tr}k_BT}{\hbar}.\]

Optical rate (Allen 1971; Shulga, Dolgov and Maksimov 1991):

\[\frac{1}{\tau(\omega, T)} = \frac{\pi}{\hbar\omega}\int d\Omega\, \alpha^2F_{tr}(\Omega)\Big[2\omega\coth\frac{\Omega}{2k_BT} - (\omega+\Omega)\coth\frac{\omega+\Omega}{2k_BT} + (\omega-\Omega)\coth\frac{\omega-\Omega}{2k_BT}\Big],\]

whose \(\omega \to 0\) limit is the DC rate and which at \(T = 0\) is \((2\pi/\hbar\omega)\int_0^\omega(\omega-\Omega)\alpha^2F_{tr}\). The mass enhancement \(\lambda(\omega, T)\) follows by causality (mass_enhancement()).

name = 'e-ph'[source]#
classmethod from_npz(path, key='a2F_tr')[source]#

Channel from an eliashberg.npz (keys omega in eV and a2F_tr).

property lambda_tr: float[source]#

\(\lambda_{tr} = 2\int\alpha^2F_{tr}(\omega)/\omega\,d\omega\).

dc_rate(temperature_k)[source]#

DC transport rate \(1/\tau_{tr}(T)\) (1/s).

optical_rate_ev(omega_ev, temperature_k)[source]#

\(\hbar/\tau(\omega, T)\) (eV) of the extended Drude model.

rate(temperature_k, energy_ev=None, omega_ev=None)[source]#

Relaxation rate \(1/\tau\) (1/s).

Parameters:
  • temperature_k (float) – Temperature (K).

  • energy_ev (array_like, optional) – Carrier energies relative to the chemical potential (eV).

  • omega_ev (array_like, optional) – Photon energies (eV), for the optical rate.

Returns:

Rates (1/s), shaped like omega_ev or energy_ev.

Return type:

ndarray

mass_enhancement(omega_ev, temperature_k, omega_max_ev=None, max_points=20000)[source]#

Optical mass enhancement \(\lambda(\omega, T)\) of the extended Drude model.

Parameters:
  • omega_ev (array_like) – Photon energies (eV).

  • temperature_k (float) – Temperature (K).

  • omega_max_ev (float, optional) – Upper end of the Kramers-Kronig integral (default: 40 times the largest phonon energy, at least twice the largest omega_ev).

  • max_points (int, optional) – Largest number of samples of the integration grid.

Returns:

\(\lambda(\omega, T)\), shaped like omega_ev.

Return type:

ndarray

Notes

The memory function \(M = 1/\tau(\omega) - i\omega\lambda(\omega)\) is causal, so with \(r(\omega) = \hbar/\tau(\omega)\)

\[\lambda(\omega) = \frac{2}{\pi}\int_0^\infty \frac{r(\omega') - r(\omega)}{\omega'^2 - \omega^2}\,d\omega',\]

(a constant has zero principal value, which removes the singularity); beyond \(W\) the rate is taken constant, which adds \((2/\pi)\,[r(W) - r(\omega)]\,\mathrm{artanh}(\omega/W)/\omega\). At \(T = 0\), \(\lambda(0) = \lambda_{tr}\).

class PAOFLOW.boltzmann.scattering_channels.EnergyResolvedRate(energy_ev, temps_k, rate_per_s, name='e-ph (energy-resolved)', energy_shift_ev=0.0, band_edges=None)[source]#

Bases: ScatteringChannel

Tabulated rate \(1/\tau(E, T)\), e.g. ab initio electron-phonon scattering.

Parameters:
  • energy_ev (array_like, shape (ne,)) – Carrier energies (eV), increasing, on the scale of PAOFLOW’s band energies E_k (zero at the DFT Fermi level of the PAO Hamiltonian).

  • temps_k (array_like, shape (nt,)) – Temperatures (K), increasing.

  • rate_per_s (array_like, shape (nt, ne)) – Rates (1/s).

  • name (str, optional) – Label.

  • energy_shift_ev (float, optional) – Added to energy_ev, to align a table computed with a different energy zero.

  • band_edges (tuple of float, optional) – (vbm, cbm) (eV) of the band structure of the table, for a gapped material. The rates of electrons are then a function of the energy above the conduction-band minimum and those of holes of the energy below the valence-band maximum, aligned to the band edges of the band structure that uses them (align_to(), or bind() in PAOFLOW.PAOFLOW.transport()).

Notes

The rate is interpolated linearly in energy (held constant beyond the tabulated range) and in temperature; a temperature outside the table raises. PAOFLOW.elphon.carrier_scattering.energy_resolved_rates() builds the table as the transport-weighted average of the state-resolved SERTA/MRTA rates,

\[\tau_{eff}(E) = \frac{\sum_{n\mathbf k} v^2_{n\mathbf k}\tau_{n\mathbf k} \delta(E - \varepsilon_{n\mathbf k})} {\sum_{n\mathbf k} v^2_{n\mathbf k}\delta(E - \varepsilon_{n\mathbf k})},\]

which reproduces the trace of the k-resolved RTA conductivity in an energy-only relaxation-time model (PAOFLOW.PAOFLOW.transport()). Aligning the band edges matters because the Boltzmann run usually has a different band structure (PAOFLOW’s zero-padding interpolation, or another QE run) from the Wigner-Seitz interpolation of the electron-phonon run: a few tens of meV in the gap change the carrier densities, not the rates.

energy_ev[source]#
temps_k[source]#
rate_per_s[source]#
name = 'e-ph (energy-resolved)'[source]#
band_edges = None[source]#
target_edges = None[source]#
classmethod from_npz(path, kind='mrta', energy_shift_ev=0.0, align=True)[source]#

Channel from a scattering_rates.npz (energy_ev, temps_k, rate_<kind>).

With align (default) and a gapped table (vbm_ev, cbm_ev, metal in the file), the energies are aligned to the band edges of the band structure that uses the channel.

align_to(vbm_ev, cbm_ev)[source]#

Use the band edges (vbm_ev, cbm_ev) of the target band structure.

bind(data_controller)[source]#

Align to the band edges of a PAOFLOW run (E_k, nelec; MPI-reduced).

rate(temperature_k, energy_ev=None, omega_ev=None)[source]#

Relaxation rate \(1/\tau\) (1/s).

Parameters:
  • temperature_k (float) – Temperature (K).

  • energy_ev (array_like, optional) – Carrier energies relative to the chemical potential (eV).

  • omega_ev (array_like, optional) – Photon energies (eV), for the optical rate.

Returns:

Rates (1/s), shaped like omega_ev or energy_ev.

Return type:

ndarray

PAOFLOW.boltzmann.scattering_channels.matthiessen(channels, temperature_k, energy_ev=None, omega_ev=None)[source]#

Total relaxation rate by Matthiessen’s rule.

Parameters:
  • channels (sequence of ScatteringChannel) – Channels to combine.

  • temperature_k (float) – Temperature (K).

  • energy_ev (array_like, optional) – Carrier energies (DC) or photon energies (optical), eV.

  • omega_ev (array_like, optional) – Carrier energies (DC) or photon energies (optical), eV.

Returns:

\(1/\tau = \sum_c 1/\tau_c\) (1/s).

Return type:

ndarray

PAOFLOW.boltzmann.scattering_channels.total_mass_enhancement(channels, omega_ev, temperature_k)[source]#

Sum of the channels’ optical mass enhancements \(\lambda(\omega, T)\).