Skip to content

Commit

Permalink
Add comment on GMRES solver (#4254)
Browse files Browse the repository at this point in the history
Additional comment on how the preconditioners in GMRES should be
implemented.
  • Loading branch information
ajnonaka authored Dec 3, 2024
1 parent eebfeb3 commit 81cc845
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions Src/LinearSolvers/AMReX_GMRES.H
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ namespace amrex {
* returns the 2-norm of v. For example, `return v.norm2()`.
*
* - `void precond(V& lhs, V const& rhs)`\n
* applies preconditioner to rhs. If there is no preconditioner,
* this function should do lhs = rhs.
* applies right-preconditioning, i.e.,
* solve P(lhs) = rhs, where P is an approximation to A
* If there is no preconditioner, P = I and thus this function should do lhs = rhs.
*
* - `void scale(V& v, RT fac)`\n
* scales v by fac. For example, `v.mult(fac)`.
Expand Down

0 comments on commit 81cc845

Please sign in to comment.