How to add a new Krylov method in Krylov.jl?

[amontoison]

I illustrate what must be modified to add a new Krylov method in Krylov.jl with FGMRES:

• Add a file fgmres.jl in the folder src
• Add include("fgmres.jl") in src/Krylov.jl
• Add a file test_fgmres.jl in the folder test
• Add include("test_fgmres.jl") in test/runtests.jl
• Add a structure FgmresWorkspace in src/krylov_workspaces.jl or src/block_krylov_workspaces.jl
• Add export FgmresWorkspace in src/krylov_workspaces.jl or src/block_krylov_workspaces.jl
• Update the loop for (KS, fun, nsol, ...) in src/workspace_accessors.jl
• Add a dispatch for krylov_workspace, krylov_solve, krylov_solve! and fgmres! in src/interface.jl
• Add the docstring of FgmresWorkspace in docs/src/api.md (section Solver Types)
• Add @docs fgmres fgmres! in the most relevant markdown file of docs/src/solvers or block_krylov.md
• Add an allocation test for FGMRES in test/test_allocations.jl
• Add :fgmres in test/test_mp.jl
• Add tests for FgmresWorkspace in test/test_interface.jl
• Add a test for the warm-start feature of FGMRES in test/test_warm_start.jl (if it's supported)
• Add a test for the verbose mode of FGMRES in test/test_verbose.jl
• Add FGMRES in docs/src/preconditioners.md
• Add FGMRES in docs/src/processes.md
• Add FGMRES in docs/src/matrix_free.md
• Add FGMRES in docs/src/storage.md
• Add a file fgmres.md in the folder docs/src/examples and update docs/make.jl
• Add FgmresWorkspace in a note of docs/src/inplace.md if the solver requires the argument nshifts

If you also need to add a new KrylovStats:

• Add XyzStats in src/krylov_stats.jl
• Add XyzStats in docs/src/api.md (section Stats Types)
• Add a test for XyzStats in test/test_stats.jl