[PSs] setup! -> update!

Author: fverdugo

PartitionedSolvers/src/PartitionedSolvers.jl

@@ -6,14 +6,11 @@ using LinearAlgebra
 
 export setup
 export solve!
-export setup!
+export update!
 export finalize!
 export AbstractLinearSolver
 export linear_solver
-export attach_nullspace
 export default_nullspace
-export preconditioner
-export matrix
 export nullspace
 include("interfaces.jl")
 

PartitionedSolvers/src/amg.jl

@@ -337,10 +337,10 @@ function amg(;
         coarse_params=amg_coarse_params(),)
     amg_params = (;fine_params,coarse_params)
     setup(x,O,b,options) = amg_setup(x,O,b,nullspace(options),amg_params)
-    setup! = amg_setup!
+    update! = amg_update!
     solve! = amg_solve!
     finalize! = amg_finalize!
-    linear_solver(;setup,setup!,solve!,finalize!)
+    linear_solver(;setup,update!,solve!,finalize!)
 end
 
 function amg_setup(x,A,b,::Nothing,amg_params)
@@ -459,7 +459,7 @@ end
     amg_cycle!(args...)
 end
 
-function amg_setup!(setup,A,options)
+function amg_update!(setup,A,options)
     amg_params = setup.amg_params
     nlevels = setup.nlevels
     for level in 1:(nlevels-1)
@@ -468,13 +468,13 @@ function amg_setup!(setup,A,options)
         (;coarsening) = level_params
         _, coarsen! = coarsening
         (;R,P,A,Ac,Ac_setup,pre_setup,pos_setup) = level_setup
-        setup!(pre_setup,A)
-        setup!(pos_setup,A)
+        update!(pre_setup,A)
+        update!(pos_setup,A)
         coarsen!(A,Ac,R,P,Ac_setup)
         A = Ac
     end
     coarse_solver_setup = setup.coarse_level.coarse_solver_setup
-    setup!(coarse_solver_setup,A)
+    update!(coarse_solver_setup,A)
     setup
 end
 

PartitionedSolvers/src/interfaces.jl

@@ -15,16 +15,16 @@ abstract type AbstractLinearSolver end
 function linear_solver(;
         setup,
         solve!,
-        setup!,
+        update!,
         finalize! = ls_setup->nothing,
     )
-    LinearSolver(setup,solve!,setup!,finalize!)
+    LinearSolver(setup,solve!,update!,finalize!)
 end
 
 struct LinearSolver{A,B,C,D} <: AbstractLinearSolver
     setup::A
     solve!::B
-    setup!::C
+    update!::C
     finalize!::D
 end
 
@@ -47,9 +47,9 @@ function setup(solver::LinearSolver,x,A,b;kwargs...)
     Preconditioner(solver,solver_setup)
 end
 
-function setup!(P::Preconditioner,A;kwargs...)
+function update!(P::Preconditioner,A;kwargs...)
     options = setup_options(;kwargs...)
-    P.solver.setup!(P.solver_setup,A,options)
+    P.solver.update!(P.solver_setup,A,options)
     P
 end
 

PartitionedSolvers/src/smoothers.jl

@@ -1,18 +1,18 @@
 
 function lu_solver()
     setup(x,op,b,options) = lu(op)
-    setup!(state,op,options) = lu!(state,op)
+    update!(state,op,options) = lu!(state,op)
     solve!(x,P,b,options) = ldiv!(x,P,b)
-    linear_solver(;setup,solve!,setup!)
+    linear_solver(;setup,solve!,update!)
 end
 
 function jacobi_correction()
     setup(x,op,b,options) = dense_diag!(similar(b),op)
-    setup!(state,op,options) = dense_diag!(state,op)
+    update!(state,op,options) = dense_diag!(state,op)
     function solve!(x,state,b,options)
         x .= state .\ b
     end
-    linear_solver(;setup,setup!,solve!)
+    linear_solver(;setup,update!,solve!)
 end
 
 function richardson(solver;iters,omega=1)
@@ -23,10 +23,10 @@ function richardson(solver;iters,omega=1)
         P = PartitionedSolvers.setup(solver,dx,A,r)
         state = (r,dx,P,A_ref)
     end
-    function setup!(state,A,options)
+    function update!(state,A,options)
         (r,dx,P,A_ref) = state
         A_ref[] = A
-        PartitionedSolvers.setup!(P,A)
+        PartitionedSolvers.update!(P,A)
         state
     end
     function solve!(x,state,b,options)
@@ -45,7 +45,7 @@ function richardson(solver;iters,omega=1)
         (r,dx,P,A_ref) = state
         PartitionedSolvers.finalize!(P)
     end
-    linear_solver(;setup,setup!,solve!,finalize!)
+    linear_solver(;setup,update!,solve!,finalize!)
 end
 
 function jacobi(;kwargs...)
@@ -60,7 +60,7 @@ function gauss_seidel(;iters=1,sweep=:symmetric)
         A_ref = Ref(A)
         (diagA,A_ref)
     end
-    function setup!(state,A,options)
+    function update!(state,A,options)
         (diagA,A_ref) = state
         dense_diag!(diagA,A)
         A_ref[] = A
@@ -96,7 +96,7 @@ function gauss_seidel(;iters=1,sweep=:symmetric)
         end
         x
     end
-    linear_solver(;setup,setup!,solve!)
+    linear_solver(;setup,update!,solve!)
 end
 
 function additive_schwarz(local_solver;iters=1)
@@ -137,9 +137,9 @@ function additive_schwarz_correction(local_solver)
             local_setup_options(A,options),
            ) |> AdditiveSchwarzSetup
     end
-    function setup!(state::AdditiveSchwarzSetup,A,options)
+    function update!(state::AdditiveSchwarzSetup,A,options)
         map(
-            local_solver.setup!,
+            local_solver.update!,
             state.local_setups,
             own_own_values(A),
             local_setup_options(A,options),
@@ -165,8 +165,8 @@ function additive_schwarz_correction(local_solver)
     function setup(x,A,b,options)
         local_solver.setup(x,A,b,options)
     end
-    function setup!(state,A,options)
-        local_solver.setup!(state,A,options)
+    function update!(state,A,options)
+        local_solver.update!(state,A,options)
     end
     function solve!(x,state,b,options)
         local_solver.solve!(x,state,b,options)
@@ -176,6 +176,6 @@ function additive_schwarz_correction(local_solver)
         local_solver.finalize!(state)
         nothing
     end
-    linear_solver(;setup,setup!,solve!,finalize!)
+    linear_solver(;setup,update!,solve!,finalize!)
 end
 

PartitionedSolvers/test/amg_tests.jl

@@ -20,7 +20,7 @@ y .= 0
 solver = amg()
 S = setup(solver,y,A,b)
 solve!(y,S,b)
-setup!(S,2*A)
+update!(S,2*A)
 solve!(y,S,b)
 finalize!(S)
 
@@ -49,7 +49,7 @@ solver = amg(;fine_params,coarse_params)
 B = default_nullspace(A)
 S = setup(solver,y,A,b;nullspace=B)
 solve!(y,S,b)
-setup!(S,2*A)
+update!(S,2*A)
 solve!(y,S,b)
 finalize!(S)
 
@@ -83,7 +83,7 @@ solver = amg()
 S = setup(solver,y,A,b)
 amg_statistics(S) |> display
 solve!(y,S,b)
-setup!(S,2*A)
+update!(S,2*A)
 solve!(y,S,b)
 finalize!(S)
 
@@ -93,7 +93,7 @@ B = default_nullspace(A)
 solver = amg()
 S = setup(solver,y,A,b;nullspace=B)
 solve!(y,S,b)
-setup!(S,2*A)
+update!(S,2*A)
 solve!(y,S,b)
 finalize!(S)
 

PartitionedSolvers/test/smoothers_tests.jl

@@ -21,7 +21,7 @@ S = setup(solver,y,A,b)
 solve!(y,S,b)
 tol = 1.e-8
 @test norm(y-x)/norm(x) < tol
-setup!(S,2*A)
+update!(S,2*A)
 solve!(y,S,b)
 @test norm(y-x/2)/norm(x/2) < tol
 finalize!(S)
@@ -33,7 +33,7 @@ S = setup(solver,y,A,b)
 solve!(y,S,b)
 tol = 1.e-8
 @test norm(y-x)/norm(x) < tol
-setup!(S,2*A)
+update!(S,2*A)
 solve!(y,S,b)
 @test norm(y-x/2)/norm(x/2) < tol
 finalize!(S)
@@ -45,7 +45,7 @@ S = setup(solver,y,A,b)
 solve!(y,S,b)
 tol = 1.e-8
 @test norm(y-x)/norm(x) < tol
-setup!(S,2*A)
+update!(S,2*A)
 solve!(y,S,b)
 @test norm(y-x/2)/norm(x/2) < tol
 finalize!(S)
@@ -55,7 +55,7 @@ y = similar(x)
 y .= 0
 S = setup(solver,y,A,b)
 solve!(y,S,b)
-setup!(S,2*A)
+update!(S,2*A)
 solve!(y,S,b)
 finalize!(S)
 
@@ -64,7 +64,7 @@ y = similar(x)
 y .= 0
 S = setup(solver,y,A,b)
 solve!(y,S,b)
-setup!(S,2*A)
+update!(S,2*A)
 solve!(y,S,b)
 finalize!(S)