JuliaLinearAlgebra / AlgebraicMultigrid.jl

Algebraic Multigrid in Julia
Other
117 stars 23 forks source link

Clean up `solve` API #34

Closed ranjanan closed 6 years ago

ranjanan commented 6 years ago

Now the API goes like:

+Arguments
+=========
+* ml::MultiLevel - the multigrid hierarchy
+* b::Vector - the right hand side
+* cycle -  multigird cycle to execute at each iteration. Defaults to AMG.V()
+
+Keyword Arguments
+=================
+* tol::Float64 - tolerance criteria for convergence
+* maxiter::Int64 - maximum number of iterations to execute
+* verbose::Bool - display residual at each iteration
+* log::Bool - return vector of residuals along with solution

Fixes #30

coveralls commented 6 years ago

Coverage Status

Coverage remained the same at 89.944% when pulling 58b1bb7a78a0fbccf244e8caba0fa21d14e0b27c on kw into c72c8bb254aab080c0c8c90a7dcc3e9d6e6fec11 on master.

codecov-io commented 6 years ago

Codecov Report

Merging #34 into master will not change coverage. The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #34   +/-   ##
=======================================
  Coverage   89.94%   89.94%           
=======================================
  Files          10       10           
  Lines         537      537           
=======================================
  Hits          483      483           
  Misses         54       54
Impacted Files Coverage Δ
src/multilevel.jl 75% <ø> (ø) :arrow_up:
src/preconditioner.jl 66.66% <100%> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update c72c8bb...58b1bb7. Read the comment docs.