https://github.com/freude/NanoNet
Tip revision: 736fe9f6800a0229c9bd5ae9712a5ba6b3e014c1 authored by Mykhailo Klymenko on 24 September 2023, 06:50:24 UTC
Update python-publish.yml
Update python-publish.yml
Tip revision: 736fe9f
pole_and_int_comparison_2.py
'''
This example script computes the efficient density matrix
evaluation using both numerical integration and complex pole
summation. It serves as a demonstration and a validation of
the pole summation method. For the given parameters below,
the numerical energy grid contains easily 10x the energy
points of complex pole summation. Not only do these
results agree within 1 part in 10,000 at 1/13th the compu-
tational cost, due to its construction, the complex pole sum-
mation is more accurate. Where possible, the complex pole
summation method should be used over numerical integration.
'''
import matplotlib.pyplot as plt
import numpy as np
import nanonet.tb as tb
from nanonet.negf.greens_functions import simple_iterative_greens_function, surface_greens_function
from nanonet.negf import pole_summation_method
from nanonet.negf.pole_summation_method import fermi_fun
# First we design a tight-binding model. We choose a 15 site model
# so that it is symmetric and that features may be clearly ob-
# served, one or two site models would look to similar to clearly
# differentiate whether something erroneously similar was happening
a = tb.Orbitals('A')
a.add_orbital('s', 0)
tb.Orbitals.orbital_sets = {'A': a}
tb.set_tb_params(PARAMS_A_A={'ss_sigma': -1})
xyz_file = """15
A cell
A1 0.0000000000 0.0000000000 0.0000000000
A2 1.0000000000 0.0000000000 0.0000000000
A3 2.0000000000 0.0000000000 0.0000000000
A4 3.0000000000 0.0000000000 0.0000000000
A5 4.0000000000 0.0000000000 0.0000000000
A6 5.0000000000 0.0000000000 0.0000000000
A7 6.0000000000 0.0000000000 0.0000000000
A8 7.0000000000 0.0000000000 0.0000000000
A9 8.0000000000 0.0000000000 0.0000000000
A10 9.0000000000 0.0000000000 0.0000000000
A11 10.0000000000 0.0000000000 0.0000000000
A12 11.0000000000 0.0000000000 0.0000000000
A13 12.0000000000 0.0000000000 0.0000000000
A14 13.0000000000 0.0000000000 0.0000000000
A15 14.0000000000 0.0000000000 0.0000000000
"""
h = tb.Hamiltonian(xyz=xyz_file, nn_distance=1.1)
h.initialize()
h.set_periodic_bc([[0, 0, 1.0]])
h_l, h_0, h_r = h.get_hamiltonians()
# Now that the Hamiltonian is constructed within the TB
# framework, we set our numerical parameters to be
# examined. We choose two endpoints mu +/- dmu,
# the temperature being evaluated, the relative tolerance
# of the pole summation and the numerical integration
Emin = -3.98
ChemPot = -3.91
kT = 0.005
reltol = 10**-10
p = np.ceil(-np.log(reltol)) # Integer number of kT away to get the desired relative tolerance.
# We chose to have our energy spacing be at most 3*kT/40
numE = round((ChemPot - Emin + p*kT)/(0.05*kT)) + 1
# We generate our grid for numerical integration, paying mind about the FD tails at muL-p*kT and muR + p*kT.
energy = np.linspace(Emin, ChemPot + p*kT, numE)
# Initialize the storage of the surface Green's funs.
sgf_l = []
sgf_r = []
# We compute the numerical evaluation of the Green's
# function on the real energy grid. This is by far
# the most expensive part of this example.
#
for E in energy:
# Note that though the surface Green's function technique is very fast, it can
# have slight errors due to choice of numerical cutoffs, if the solution is
# accurate the simple iterative will return the same answer immediately
# the user can comment it out if they wish to trust those evaluations.
sf = surface_greens_function(E, h_l, h_0, h_r, damp=0.00001j)
L = sf[0]
R = sf[1]
L = simple_iterative_greens_function(E, h_l, h_0, h_r, damp=0.00001j, initialguess=L)
R = simple_iterative_greens_function(E, h_r, h_0, h_l, damp=0.00001j, initialguess=R)
sgf_l.append(L)
sgf_r.append(R)
# Convert the lists into arrays
sgf_l = np.array(sgf_l)
sgf_r = np.array(sgf_r)
# Compute the energy-wise Green's function
num_sites = h_0.shape[0]
gf = np.linalg.pinv(np.multiply.outer(energy, np.identity(num_sites)) - h_0 - sgf_l - sgf_r)
# We preallocate the arrays to store our integrated solutions
densityint = np.zeros(num_sites)
LDOS = []
# The integral is just a sum of the weighted diagonals for whichever integral we are computing
for j, E in enumerate(energy):
gf0 = gf[j, :, :]
gdiag = np.diag(gf0)
densityint = densityint + gdiag*fermi_fun(E, ChemPot, kT)
LDOS.append(sum(gdiag))
# Now we have completed our numerical integration,
# we move onto pole summation, simply choose the
# chemical potentials the temperature and the rel-
# ative error as before and the method spits out
# one set of poles and two sets of residues for
# the backwards and forwards differences with the
# central being their sum.
poles, residues = pole_summation_method.pole_order_one(Emin, ChemPot, kT, p)
# Allocate the surface green's functions for poles.
sgf2_l = []
sgf2_r = []
# Do each of the poles, note that the imaginary
# part of the energy is the damping parameter
# and the real part works as normal.
for E in poles:
# Note that though the surface Green's function technique is very fast, it can
# have slight errors due to choice of numerical cutoffs, if the solution is
# accurate the simple iterative will return the same answer immediately
sf = surface_greens_function(np.real(E), h_l, h_0, h_r, damp=1j*np.imag(E))
L2 = sf[0]
R2 = sf[1]
L2 = simple_iterative_greens_function(np.real(E), h_l, h_0, h_r, damp=1j*np.imag(E), initialguess=L2)
R2 = simple_iterative_greens_function(np.real(E), h_r, h_0, h_l, damp=1j*np.imag(E), initialguess=R2)
sgf2_l.append(L2)
sgf2_r.append(R2)
sgf2_l = np.array(sgf2_l)
sgf2_r = np.array(sgf2_r)
gf2 = np.linalg.pinv(np.multiply.outer(poles, np.identity(num_sites)) - h_0 - sgf2_l - sgf2_r)
densitypole = np.zeros(num_sites)
# Add up the weighted contributions
for j, E in enumerate(poles):
gf00 = gf2[j, :, :]
gdiag2 = np.diag(gf00)
densitypole = densitypole + residues[j]*gdiag2
# dE to correct numerical integration
dE = (energy[1]-energy[0])
# Density
densityint = -2*np.imag(densityint)*dE
densitypole = -2*np.imag(densitypole)
# LDOS
LDOS = -2*np.imag(LDOS)
#
plt.plot(densitypole, color='#00AEC7')
plt.plot(densityint, color='#951158', linestyle='dashed')
plt.show()
# Now we compute the relative difference between the two answers, note this isn't really an error
# as we're computing the same approximate thing two different ways, it's to check if they agree.
errcomp = np.log10(0.5*np.linalg.norm(densityint-densitypole)/np.linalg.norm(densityint+densitypole))
print("Relative evaluation discrepancy = 10^"+f'{errcomp:.3f}')
# # Extra stuff
# plt.plot(energy, LDOS) # Show the LDOS of the region
# plt.scatter(np.real(poles), np.imag(poles)) # Show the pole locations