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:
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);
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 ofscattering_rate_kernel()with a Lorentzian delta of width \(\eta\);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 ofprepare_dense_vertex().
TabulatedSelfEnergy adapts the result to the self-energy protocol of
PAOFLOW.arpes (f(w, energies, kpoints, bands)).
Classes#
Self-energy of |
Functions#
|
Engelsberg-Schrieffer self-energy of an Eliashberg function (eV). |
|
|
|
Fan-Migdal self-energy of a block of states from one q (eV). |
|
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) –
0selects 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 ofRe Sigmaat 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 statesmatk+q(eV, same scale asw).g2 (ndarray
(nb, nmode, nband_kq, nband_k)) –|g|^2(eV^2) with the zero-point factor1 / 2 omega.phonon_energy (ndarray
(nmode,)) – Phonon energies (eV); modes beloweps_acousticare skipped.temps_ev (sequence of float) –
k_B Tvalues.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 asenergy_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:
A – As
carrier_scattering_dense_q().HRs – As
carrier_scattering_dense_q().kpts_cryst – As
carrier_scattering_dense_q().bg – As
carrier_scattering_dense_q().at – As
carrier_scattering_dense_q().alat – As
carrier_scattering_dense_q().cell_volume – As
carrier_scattering_dense_q().coupling_dir – As
carrier_scattering_dense_q().qgrid_coarse – As
carrier_scattering_dense_q().ng – As
carrier_scattering_dense_q().masses_amu – Masses (one per atom) and valence electrons.
nelec – Masses (one per atom) and valence electrons.
k_cryst (ndarray
(nk, 3)) – k-points (crystal coordinates) of the states, e.g. an ARPES path or mesh.w_ev (ndarray
(nw,)) – Energies relative to the Fermi level of each temperature.temps_k (sequence of float, optional)
nq_dense (int, optional) – Dense q-grid (full grid, no symmetry reduction: the k-points are arbitrary).
eta_ev (float, optional) – Lorentzian width of the denominators (EPW
degaussw); the floor of the widths withadaptive_smearing.adaptive_smearing (float, optional) – Adaptive widths
a |v_{m k+q}| dqper intermediate state (Yates prefactora, 0.7 for Gaussians;adaptive_smearing), floored ateta_ev, with the group velocities by finite differences atk+q(group_velocities_at()). Metals need it: a fixed width far below the level spacing|v_F| dqof the q-grid gives a noisy self-energy.bands (sequence of int, optional) – Bands
nto resolve; default: every band with a state within[w_min - margin, w_max + margin]of the Fermi level at the given k-points.window_margin_ev (float, optional)
doping_cm3 – Carrier statistics of the intermediate states (
fermi_levels_for_doping()).scissor_ev – Carrier statistics of the intermediate states (
fermi_levels_for_doping()).target_gap_ev – Carrier statistics of the intermediate states (
fermi_levels_for_doping()).spin_degeneracy – Carrier statistics of the intermediate states (
fermi_levels_for_doping()).eps_acoustic_cm
screening_eps
screening_eps_dft
tau_cryst
species
orbital_positions
: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: Ascarrier_scattering_dense_q(). :param unfold_tol: Ascarrier_scattering_dense_q(). :param cache_dir: Ascarrier_scattering_dense_q(). :param cache_tag: Ascarrier_scattering_dense_q(). :param long_range: Ascarrier_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_evon 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:
Notes
The intermediate states
k+qare diagonalised at every (k, q) with the cached Bloch Hamiltonian (bloch_states_at()), sokneed not be commensurate with any grid; the sum runs over all bandsm. 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 ofPAOFLOW.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.
- 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.