Skip to content

Commit 58b1bb7

Browse files
committed
Add docs for solve
1 parent 462e229 commit 58b1bb7

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/multilevel.jl

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,25 @@ abstract type Cycle end
6060
struct V <: Cycle
6161
end
6262

63+
"""
64+
solve(ml::MultiLevel, b::Vector, cycle, kwargs...)
65+
66+
Execute multigrid cycling.
67+
68+
Arguments
69+
=========
70+
* ml::MultiLevel - the multigrid hierarchy
71+
* b::Vector - the right hand side
72+
* cycle - multigird cycle to execute at each iteration. Defaults to AMG.V()
73+
74+
Keyword Arguments
75+
=================
76+
* tol::Float64 - tolerance criteria for convergence
77+
* maxiter::Int64 - maximum number of iterations to execute
78+
* verbose::Bool - display residual at each iteration
79+
* log::Bool - return vector of residuals along with solution
80+
81+
"""
6382
function solve{T}(ml::MultiLevel, b::Vector{T},
6483
cycle::Cycle = V();
6584
maxiter::Int = 100,

0 commit comments

Comments
 (0)