rename to pcg

Author: jalvesz

example/linalg/CMakeLists.txt

@@ -42,7 +42,7 @@ ADD_EXAMPLE(solve1)
 ADD_EXAMPLE(solve2)
 ADD_EXAMPLE(solve3)
 ADD_EXAMPLE(solve_cg)
-ADD_EXAMPLE(solve_pccg)
+ADD_EXAMPLE(solve_pcg)
 ADD_EXAMPLE(solve_custom)
 ADD_EXAMPLE(sparse_from_ijv)
 ADD_EXAMPLE(sparse_data_accessors)

example/linalg/example_solve_cg.f90

@@ -1,4 +1,4 @@
-program example_solve_pccg
+program example_solve_pcg
     use stdlib_kinds, only: dp
     use stdlib_linalg_iterative_solvers, only: solve_cg
 

example/linalg/example_solve_custom.f90

@@ -3,11 +3,11 @@ module custom_solver
     use stdlib_sparse
     use stdlib_linalg_iterative_solvers, only: linop_dp, &
                     solver_workspace_dp, &
-                    solve_pccg_kernel, &
-                    size_wksp_pccg
+                    solve_pcg_kernel, &
+                    size_wksp_pcg
     implicit none
 contains
-    subroutine solve_pccg_custom(A,b,x,di,tol,maxiter,restart,workspace)
+    subroutine solve_pcg_custom(A,b,x,di,tol,maxiter,restart,workspace)
         type(CSR_dp_type), intent(in) :: A
         real(dp), intent(in) :: b(:)
         real(dp), intent(inout) :: x(:)
@@ -48,15 +48,15 @@ subroutine solve_pccg_custom(A,b,x,di,tol,maxiter,restart,workspace)
         else
             allocate( workspace_ )
         end if
-        if(.not.allocated(workspace_%tmp)) allocate( workspace_%tmp(n,size_wksp_pccg) , source = 0.d0 )
+        if(.not.allocated(workspace_%tmp)) allocate( workspace_%tmp(n,size_wksp_pcg) , source = 0.d0 )
         workspace_%callback => my_logger
         !-------------------------
         ! Jacobi preconditionner factorization
         call diag(A,diagonal)
         where(abs(diagonal)>epsilon(0.d0)) diagonal = 1._dp/diagonal
         !-------------------------
         ! main call to the solver
-        call solve_pccg_kernel(op,M,b,x,tol_,maxiter_,workspace_)
+        call solve_pcg_kernel(op,M,b,x,tol_,maxiter_,workspace_)
 
         !-------------------------
         ! internal memory cleanup
@@ -126,7 +126,7 @@ program example_solve_custom
     dirichlet = .false._1 
     dirichlet([1,5]) = .true._1
 
-    call solve_pccg_custom(laplacian_csr, load, x, tol=1.d-6, di=dirichlet)
+    call solve_pcg_custom(laplacian_csr, load, x, tol=1.d-6, di=dirichlet)
     print *, x !> solution: [0.0, 2.5, 5.0, 2.5, 0.0]
 
 end program example_solve_custom

example/linalg/example_solve_pccg.f90 renamed to example/linalg/example_solve_pcg.f90

@@ -1,7 +1,7 @@
-program example_solve_pccg
+program example_solve_pcg
     use stdlib_kinds, only: dp
     use stdlib_sparse
-    use stdlib_linalg_iterative_solvers, only: solve_pccg
+    use stdlib_linalg_iterative_solvers, only: solve_pcg
 
     type(CSR_dp_type) :: laplacian_csr
     type(COO_dp_type) :: COO
@@ -23,10 +23,10 @@ program example_solve_pccg
     dirichlet = .false._1 
     dirichlet([1,5]) = .true._1
 
-    call solve_pccg(laplacian, load, x, tol=1.d-6, di=dirichlet)
+    call solve_pcg(laplacian, load, x, tol=1.d-6, di=dirichlet)
     print *, x !> solution: [0.0, 2.5, 5.0, 2.5, 0.0]
     x = 0._dp
 
-    call solve_pccg(laplacian_csr, load, x, tol=1.d-6, di=dirichlet)
+    call solve_pcg(laplacian_csr, load, x, tol=1.d-6, di=dirichlet)
     print *, x !> solution: [0.0, 2.5, 5.0, 2.5, 0.0]
 end program

src/CMakeLists.txt

@@ -95,7 +95,7 @@ set(cppFiles
     stdlib_linalg_iterative_aux.fypp
     stdlib_linalg_iterative_solvers.fypp
     stdlib_linalg_iterative_solvers_cg.fypp
-    stdlib_linalg_iterative_solvers_pccg.fypp
+    stdlib_linalg_iterative_solvers_pcg.fypp
 )
 
 add_subdirectory(blas)

src/stdlib_linalg_iterative_solvers.fypp

@@ -14,9 +14,9 @@ module stdlib_linalg_iterative_solvers
     !> details The size of the workspace is defined by the number of vectors used in the iterative solver.
     enum, bind(c)
         enumerator :: size_wksp_cg = 3
-        enumerator :: size_wksp_pccg = 4
+        enumerator :: size_wksp_pcg = 4
     end enum
-    public :: size_wksp_cg, size_wksp_pccg
+    public :: size_wksp_cg, size_wksp_pcg
 
     !> linear operator class for the iterative solvers
     #:for k, t, s in R_KINDS_TYPES
@@ -93,9 +93,9 @@ module stdlib_linalg_iterative_solvers
     end interface
     public :: solve_cg
 
-    interface solve_pccg_kernel
+    interface solve_pcg_kernel
         #:for k, t, s in R_KINDS_TYPES
-        module subroutine solve_pccg_kernel_${s}$(A,M,b,x,tol,maxiter,workspace)
+        module subroutine solve_pcg_kernel_${s}$(A,M,b,x,tol,maxiter,workspace)
             class(linop_${s}$), intent(in) :: A
             class(linop_${s}$), intent(in) :: M !> preconditionner
             ${t}$, intent(in) :: b(:)
@@ -106,12 +106,12 @@ module stdlib_linalg_iterative_solvers
         end subroutine
         #:endfor
     end interface
-    public :: solve_pccg_kernel
+    public :: solve_pcg_kernel
 
-    interface solve_pccg
+    interface solve_pcg
         #:for matrix in MATRIX_TYPES
         #:for k, t, s in R_KINDS_TYPES
-        module subroutine solve_pccg_${matrix}$_${s}$(A,b,x,di,tol,maxiter,restart,precond,M,workspace)
+        module subroutine solve_pcg_${matrix}$_${s}$(A,b,x,di,tol,maxiter,restart,precond,M,workspace)
             #:if matrix == "dense"
             ${t}$, intent(in) :: A(:,:)
             #:else 
@@ -130,7 +130,7 @@ module stdlib_linalg_iterative_solvers
         #:endfor
         #:endfor
     end interface
-    public :: solve_pccg 
+    public :: solve_pcg 
 
     interface solve_forward_triangular
         !> Solve the system L x = b, where L is a strictly lower triangular matrix (diagonal assumed = 1).

src/stdlib_linalg_iterative_solvers_pccg.fypp renamed to src/stdlib_linalg_iterative_solvers_pcg.fypp

@@ -4,7 +4,7 @@
 #:set MATRIX_TYPES = ["dense", "CSR"]
 #:set RANKS = range(1, 2+1)
 
-submodule(stdlib_linalg_iterative_solvers) stdlib_linalg_iterative_pccg
+submodule(stdlib_linalg_iterative_solvers) stdlib_linalg_iterative_pcg
     use stdlib_kinds
     use stdlib_sparse
     use stdlib_constants
@@ -21,7 +21,7 @@ submodule(stdlib_linalg_iterative_solvers) stdlib_linalg_iterative_pccg
 contains
 
     #:for k, t, s in R_KINDS_TYPES
-    module subroutine solve_pccg_kernel_${s}$(A,M,b,x,tol,maxiter,workspace)
+    module subroutine solve_pcg_kernel_${s}$(A,M,b,x,tol,maxiter,workspace)
         class(linop_${s}$), intent(in) :: A
         class(linop_${s}$), intent(in) :: M !> preconditionner
         ${t}$, intent(in) :: b(:), tol
@@ -85,7 +85,7 @@ contains
 
     #:for matrix in MATRIX_TYPES
     #:for k, t, s in R_KINDS_TYPES
-    module subroutine solve_pccg_${matrix}$_${s}$(A,b,x,di,tol,maxiter,restart,precond,M,workspace)
+    module subroutine solve_pcg_${matrix}$_${s}$(A,b,x,di,tol,maxiter,restart,precond,M,workspace)
         #:if matrix == "dense"
         use stdlib_linalg, only: diag
         ${t}$, intent(in) :: A(:,:)
@@ -175,12 +175,12 @@ contains
         else
             allocate( workspace_ )
         end if
-        if(.not.allocated(workspace_%tmp)) allocate( workspace_%tmp(n,size_wksp_pccg) , source = zero_${s}$ )
+        if(.not.allocated(workspace_%tmp)) allocate( workspace_%tmp(n,size_wksp_pcg) , source = zero_${s}$ )
         !-------------------------
         ! main call to the solver
         if(restart_) x = zero_${s}$
         x = merge( b, x, di_ ) !> copy dirichlet load conditions encoded in B and indicated by di
-        call solve_pccg_kernel(op,M_,b,x,tol_,maxiter_,workspace_)
+        call solve_pcg_kernel(op,M_,b,x,tol_,maxiter_,workspace_)
 
         !-------------------------
         ! internal memory cleanup
@@ -236,4 +236,4 @@ contains
     #:endfor
     #:endfor
 
-end submodule stdlib_linalg_iterative_pccg
+end submodule stdlib_linalg_iterative_pcg

test/linalg/test_linalg_solve_iterative.fypp

@@ -97,7 +97,7 @@ module test_linalg_solve_iterative
         #:endfor
     end subroutine test_solve_ldlt
 
-    ! TODO: add tests for solve_cg, solve_pccg, etc.
+    ! TODO: add tests for solve_cg, solve_pcg, etc.
 
 end module test_linalg_solve_iterative