Skip to content

Commit

Permalink
[ITensors][Docs] More information in docs about krylovdim and critica…
Browse files Browse the repository at this point in the history
…lity (#1235)
  • Loading branch information
jtschneider authored Nov 3, 2023
1 parent 9d4fed1 commit 9a7380f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/src/faq/DMRG.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ We list some of these with the most fundamental and important ones first:
If 10 sweeps made a difference, try 20 sweeps.

* Try setting the `eigsolve_krylovdim` keyword argument to a higher value (the default is 3).
This can be particularily helpful when the Hamiltonian is close to a critical point.
This may make slowly-converging calculations converge in fewer sweeps, but setting it
too high can make each sweep run slowly.

Expand Down
2 changes: 1 addition & 1 deletion src/mps/dmrg.jl
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Optional keyword arguments:
or threshold to use for truncating the bond dimension or rank of the MPS.
- `eigsolve_krylovdim::Int = 3` - maximum dimension of Krylov space used to
locally solve the eigenvalue problem. Try setting to a higher value if
convergence is slow. [^krylovkit]
convergence is slow or the Hamiltonian is close to a critical point. [^krylovkit]
- `eigsolve_tol::Number = 1e-14` - Krylov eigensolver tolerance. [^krylovkit]
- `eigsolve_maxiter::Int = 1` - number of times the Krylov subspace can be
rebuilt. [^krylovkit]
Expand Down

0 comments on commit 9a7380f

Please sign in to comment.