Custom solvers
In this example, we show how to define custom solvers. Our system will again be silicon, because we are not very imaginative
using DFTK, LinearAlgebra
a = 10.26
lattice = a / 2 * [[0 1 1.];
[1 0 1.];
[1 1 0.]]
Si = ElementPsp(:Si, psp=load_psp("hgh/lda/Si-q4"))
atoms = [Si, Si]
positions = [ones(3)/8, -ones(3)/8]
# We take very (very) crude parameters
model = model_LDA(lattice, atoms, positions)
basis = PlaneWaveBasis(model; Ecut=5, kgrid=[1, 1, 1]);
We define our custom fix-point solver: simply a damped fixed-point
function my_fp_solver(f, x0, max_iter; tol)
mixing_factor = .7
x = x0
fx = f(x)
for n = 1:max_iter
inc = fx - x
if norm(inc) < tol
break
end
x = x + mixing_factor * inc
fx = f(x)
end
(fixpoint=x, converged=norm(fx-x) < tol)
end;
Our eigenvalue solver just forms the dense matrix and diagonalizes it explicitly (this only works for very small systems)
function my_eig_solver(A, X0; maxiter, tol, kwargs...)
n = size(X0, 2)
A = Array(A)
E = eigen(A)
λ = E.values[1:n]
X = E.vectors[:, 1:n]
(; λ, X, residual_norms=[], iterations=0, converged=true, n_matvec=0)
end;
Finally we also define our custom mixing scheme. It will be a mixture of simple mixing (for the first 2 steps) and than default to Kerker mixing. In the mixing interface δF
is $(ρ_\text{out} - ρ_\text{in})$, i.e. the difference in density between two subsequent SCF steps and the mix
function returns $δρ$, which is added to $ρ_\text{in}$ to yield $ρ_\text{next}$, the density for the next SCF step.
struct MyMixing
n_simple # Number of iterations for simple mixing
end
MyMixing() = MyMixing(2)
function DFTK.mix_density(mixing::MyMixing, basis, δF; n_iter, kwargs...)
if n_iter <= mixing.n_simple
return δF # Simple mixing -> Do not modify update at all
else
# Use the default KerkerMixing from DFTK
DFTK.mix_density(KerkerMixing(), basis, δF; kwargs...)
end
end
That's it! Now we just run the SCF with these solvers
scfres = self_consistent_field(basis;
tol=1e-4,
solver=my_fp_solver,
eigensolver=my_eig_solver,
mixing=MyMixing());
n Energy log10(ΔE) log10(Δρ) Diag Δtime
--- --------------- --------- --------- ---- ------
1 -7.215597085486 -0.48 0.0
2 -7.246310533608 -1.51 -0.85 0.0 368ms
3 -7.250986455303 -2.33 -1.30 0.0 69.3ms
4 -7.251254252892 -3.57 -1.61 0.0 179ms
5 -7.251318021808 -4.20 -1.92 0.0 56.5ms
6 -7.251333463617 -4.81 -2.21 0.0 75.0ms
7 -7.251337352252 -5.41 -2.50 0.0 76.4ms
8 -7.251338383513 -5.99 -2.78 0.0 68.5ms
9 -7.251338672989 -6.54 -3.05 0.0 68.8ms
10 -7.251338758862 -7.07 -3.31 0.0 149ms
11 -7.251338785611 -7.57 -3.57 0.0 53.0ms
12 -7.251338794282 -8.06 -3.82 0.0 63.6ms
13 -7.251338797181 -8.54 -4.06 0.0 69.8ms
Note that the default convergence criterion is the difference in density. When this gets below tol
, the "driver" self_consistent_field
artificially makes the fixed-point solver think it's converged by forcing f(x) = x
. You can customize this with the is_converged
keyword argument to self_consistent_field
.