PAOFLOW.elphon.self_energy#

Electron-phonon self-energies for spectral functions and ARPES.

Three levels, all returning Sigma(omega, T) on an energy grid relative to the Fermi level:

  1. eliashberg_self_energy(): the isotropic (or per-state) Engelsberg-Schrieffer form from an Eliashberg function \(\alpha^2F(\Omega)\) (constant density of states),

    \[\Sigma(\omega, T) = \int_0^\infty d\Omega\,\alpha^2F(\Omega)\Big[-2\pi i\,(n_\Omega + \tfrac12) + \psi\Big(\tfrac12 + i\frac{\Omega-\omega}{2\pi k_BT}\Big) - \psi\Big(\tfrac12 - i\frac{\Omega+\omega}{2\pi k_BT}\Big)\Big],\]

    with \(\psi\) the digamma function, \(\mathrm{Re}\,\Sigma'(0) = -\lambda\) and \(\mathrm{Im}\,\Sigma(\omega) \to -\pi\int_0^{|\omega|}\alpha^2F\) at \(T = 0\) (Grimvall, The electron-phonon interaction in metals, 1981);

  2. fan_migdal_kernel(): the state-resolved Fan-Migdal self-energy of a block of states from the coupling at one q,

    \[\Sigma_{n\mathbf k}(\omega) = \sum_{m\nu\mathbf q} w_{\mathbf q}\, \frac{|g_{mn\nu}(\mathbf k,\mathbf q)|^2}{2\omega_{\mathbf q\nu}}\Big[ \frac{n_{\mathbf q\nu} + f_{m\mathbf k+\mathbf q}}{\omega - \varepsilon_{m\mathbf k+\mathbf q} + \omega_{\mathbf q\nu} + i\eta} + \frac{n_{\mathbf q\nu} + 1 - f_{m\mathbf k+\mathbf q}}{\omega - \varepsilon_{m\mathbf k+\mathbf q} - \omega_{\mathbf q\nu} + i\eta}\Big],\]

    EPW selfen_elec / specfun_el (no Debye-Waller term); its on-shell imaginary part is the scattering rate of scattering_rate_kernel() with a Lorentzian delta of width \(\eta\);

  3. fan_migdal_self_energy(): the dense-q driver evaluating 2 at arbitrary k-points (an ARPES path or mesh, no grid commensurability) with the interpolated vertex of prepare_dense_vertex().

TabulatedSelfEnergy adapts the result to the self-energy protocol of PAOFLOW.arpes (f(w, energies, kpoints, bands)).

Classes#

TabulatedSelfEnergy

Self-energy of fan_migdal_self_energy() in the protocol of PAOFLOW.arpes.

Functions#

eliashberg_self_energy(omega_ev, a2f, w_ev, temperature_k)

Engelsberg-Schrieffer self-energy of an Eliashberg function (eV).

mass_enhancement(w_ev, sigma)

(lambda, Z) from the slope of Re Sigma at the Fermi level: lambda = -dRe Sigma/dw, Z = 1/(1 + lambda).

fan_migdal_kernel(energy_kq, g2, phonon_energy, ...[, ...])

Fan-Migdal self-energy of a block of states from one q (eV).

fan_migdal_self_energy(A, HRs, kpts_cryst, bg, at, ...)

Band-resolved Fan-Migdal self-energy at arbitrary k-points from the dense-q vertex.

Module Contents#

PAOFLOW.elphon.self_energy.eliashberg_self_energy(omega_ev, a2f, w_ev, temperature_k)[source]#

Engelsberg-Schrieffer self-energy of an Eliashberg function (eV).

Parameters:
  • omega_ev (ndarray (nomega,)) – Phonon energies of the Eliashberg function (eV, positive).

  • a2f (ndarray (..., nomega)) – \(\alpha^2F(\Omega)\); leading axes (states) are broadcast.

  • w_ev (ndarray (nw,)) – Electron energies relative to the Fermi level.

  • temperature_k (float) – 0 selects the zero-temperature closed form.

Returns:

Sigma(w); Im Sigma <= 0.

Return type:

ndarray (..., nw), complex

Notes

At \(T = 0\): \(\mathrm{Re}\,\Sigma(\omega) = \int d\Omega\,\alpha^2F(\Omega) \ln|(\Omega - \omega)/(\Omega + \omega)|\) and \(\mathrm{Im}\,\Sigma(\omega) = -\pi\int_0^{|\omega|} d\Omega\,\alpha^2F(\Omega)\).

PAOFLOW.elphon.self_energy.mass_enhancement(w_ev, sigma)[source]#

(lambda, Z) from the slope of Re Sigma at the Fermi level: lambda = -dRe Sigma/dw, Z = 1/(1 + lambda).

PAOFLOW.elphon.self_energy.fan_migdal_kernel(energy_kq, g2, phonon_energy, temps_ev, occupation_energy_kq, w, eta, eps_acoustic, weight=1.0)[source]#

Fan-Migdal self-energy of a block of states from one q (eV).

Parameters:
  • energy_kq (ndarray (nb, nband_kq)) – Energies of the intermediate states m at k+q (eV, same scale as w).

  • g2 (ndarray (nb, nmode, nband_kq, nband_k)) – |g|^2 (eV^2) with the zero-point factor 1 / 2 omega.

  • phonon_energy (ndarray (nmode,)) – Phonon energies (eV); modes below eps_acoustic are skipped.

  • temps_ev (sequence of float) – k_B T values.

  • occupation_energy_kq (ndarray (ntemp, nb, nband_kq)) – e_m - mu(T) of the intermediate states.

  • w (ndarray (nw,)) – Energies at which the self-energy is evaluated (same scale as energy_kq).

  • eta (float or ndarray (nb, nband_kq)) – Lorentzian width (eV), one value or one per intermediate state (adaptive smearing).

  • eps_acoustic (float)

  • weight (float, optional) – q-point weight.

Return type:

ndarray (ntemp, nb, nband_k, nw), complex

PAOFLOW.elphon.self_energy.fan_migdal_self_energy(A, HRs, kpts_cryst, bg, at, alat, cell_volume, coupling_dir, qgrid_coarse, ng, *, masses_amu, nelec, k_cryst, w_ev, temps_k=(300.0,), nq_dense=24, eta_ev=0.01, adaptive_smearing=None, bands=None, window_margin_ev=0.5, doping_cm3=0.0, scissor_ev=None, target_gap_ev=None, eps_acoustic_cm=5.0, screening_eps=None, screening_eps_dft=None, spin_degeneracy=2.0, tau_cryst=None, species=None, orbital_positions=None, ispin=0, comm=None, allow_missing_long_range=False, coupling_source='epw', save_dir=None, pseudo_dir=None, prefix=None, basis='auto', unfold='full', basis_shells=None, unfold_tol=1e-06, cache_dir=None, cache_tag=None, long_range=None)[source]#

Band-resolved Fan-Migdal self-energy at arbitrary k-points from the dense-q vertex.

Parameters:

:param : :param ispin: :param comm: :param allow_missing_long_range: :param coupling_source: :param save_dir: :param pseudo_dir: :param prefix: :param basis: :param : :param unfold: As carrier_scattering_dense_q(). :param basis_shells: As carrier_scattering_dense_q(). :param unfold_tol: As carrier_scattering_dense_q(). :param cache_dir: As carrier_scattering_dense_q(). :param cache_tag: As carrier_scattering_dense_q(). :param long_range: As carrier_scattering_dense_q().

Returns:

sigma_ev (ntemp, nk, nband, nw) complex, energies_ev (nk, nband) relative to the Fermi level of the first temperature (energies_abs_ev on the PAO scale), bands, w_ev, temps_k, fermi_levels_ev (ntemp,), k_cryst, eta_ev, adaptive_smearing, nq_dense, metal, coupling_screening.

Return type:

dict

Notes

The intermediate states k+q are diagonalised at every (k, q) with the cached Bloch Hamiltonian (bloch_states_at()), so k need not be commensurate with any grid; the sum runs over all bands m. The work is split over the dense q-points between the MPI ranks.

class PAOFLOW.elphon.self_energy.TabulatedSelfEnergy(kpoints, bands, w_grid, sigma, missing=0.0)[source]#

Self-energy of fan_migdal_self_energy() in the protocol of PAOFLOW.arpes.

Parameters:
  • kpoints (ndarray (nk, 3)) – The momenta the self-energy was computed at, in the units the ARPES driver uses (Cartesian, 1/Å) and the same order or any order (rows are matched).

  • bands (sequence of int) – Band indices of the second axis of sigma.

  • w_grid (ndarray (nw,))

  • sigma (ndarray (nk, nband, nw), complex) – One temperature.

  • missing (complex, optional) – Value for bands or k-points not in the table.

kpoints[source]#
bands[source]#
w_grid[source]#
sigma[source]#
missing[source]#
classmethod from_result(result, kpoints, temperature_index=0)[source]#

From the dict of fan_migdal_self_energy() and the Cartesian momenta it was run at.