Skip to content

Commit 43c113c

Browse files
committed
Specify that memory is an optional argument for some KrylovSolvers
1 parent c61359b commit 43c113c

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

src/block_krylov_solvers.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The outer constructors
1717
1818
may be used in order to create these vectors.
1919
`memory` is set to `div(n,p)` if the value given is larger than `div(n,p)`.
20+
`memory` is an optional argument in the second constructor.
2021
"""
2122
mutable struct BlockGmresSolver{T,FC,SV,SM} <: BlockKrylovSolver{T,FC,SV,SM}
2223
m :: Int

src/krylov_solvers.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -498,6 +498,7 @@ The outer constructors
498498
499499
may be used in order to create these vectors.
500500
`memory` is set to `n` if the value given is larger than `n`.
501+
`memory` is an optional argument in the second constructor.
501502
"""
502503
mutable struct DqgmresSolver{T,FC,S} <: KrylovSolver{T,FC,S}
503504
m :: Int
@@ -551,6 +552,7 @@ The outer constructors
551552
552553
may be used in order to create these vectors.
553554
`memory` is set to `n` if the value given is larger than `n`.
555+
`memory` is an optional argument in the second constructor.
554556
"""
555557
mutable struct DiomSolver{T,FC,S} <: KrylovSolver{T,FC,S}
556558
m :: Int
@@ -1692,6 +1694,7 @@ The outer constructors
16921694
16931695
may be used in order to create these vectors.
16941696
`memory` is set to `n` if the value given is larger than `n`.
1697+
`memory` is an optional argument in the second constructor.
16951698
"""
16961699
mutable struct GmresSolver{T,FC,S} <: KrylovSolver{T,FC,S}
16971700
m :: Int
@@ -1746,6 +1749,7 @@ The outer constructors
17461749
17471750
may be used in order to create these vectors.
17481751
`memory` is set to `n` if the value given is larger than `n`.
1752+
`memory` is an optional argument in the second constructor.
17491753
"""
17501754
mutable struct FgmresSolver{T,FC,S} <: KrylovSolver{T,FC,S}
17511755
m :: Int
@@ -1800,6 +1804,7 @@ The outer constructors
18001804
18011805
may be used in order to create these vectors.
18021806
`memory` is set to `n` if the value given is larger than `n`.
1807+
`memory` is an optional argument in the second constructor.
18031808
"""
18041809
mutable struct FomSolver{T,FC,S} <: KrylovSolver{T,FC,S}
18051810
m :: Int
@@ -1851,6 +1856,7 @@ The outer constructors
18511856
18521857
may be used in order to create these vectors.
18531858
`memory` is set to `n + m` if the value given is larger than `n + m`.
1859+
`memory` is an optional argument in the second constructor.
18541860
"""
18551861
mutable struct GpmrSolver{T,FC,S} <: KrylovSolver{T,FC,S}
18561862
m :: Int

0 commit comments

Comments
 (0)