add _type suffix

Author: jalvesz

doc/specs/stdlib_linalg_iterative_solvers.md

@@ -17,7 +17,7 @@ The `stdlib_linalg_iterative_solvers` module provides base implementations for k
 <!-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -->
 ### The `linop` derived type
 
-The `linop_<kind>` derive type is an auxiliary class enabling to abstract the definition of the linear system and the actual implementation of the solvers.
+The `linop_<kind>_type` derive type is an auxiliary class enabling to abstract the definition of the linear system and the actual implementation of the solvers.
 
 #### Type-bound procedures
 
@@ -70,7 +70,7 @@ The output is a scalar of `type` and `kind` same as to that of `x` and `y`.
 <!-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -->
 ### The `solver_workspace` derived type
 
-The `solver_workspace_<kind>` derive type is an auxiliary class enabling to hold the data associated to the working arrays needed by the solvers to operate.
+The `solver_workspace_<kind>_type` derive type is an auxiliary class enabling to hold the data associated to the working arrays needed by the solvers to operate.
 
 #### Type-bound procedures
 
@@ -109,7 +109,7 @@ Subroutine
 
 #### Argument(s)
 
-`A`: `class(linop_<kind>)` defining the linear operator. This argument is `intent(in)`.
+`A`: `class(linop_<kind>_type)` defining the linear operator. This argument is `intent(in)`.
 
 `b`: 1-D array of `real(<kind>)` defining the loading conditions of the linear system. This argument is `intent(in)`.
 
@@ -119,7 +119,7 @@ Subroutine
 
 `maxiter`: scalar of type `integer` defining the maximum allowed number of iterations. This argument is `intent(in)`.
 
-`workspace`: `type(solver_workspace_<kind>)` holding the work temporal array for the solver. This argument is `intent(inout)`.
+`workspace`: `type(solver_workspace_<kind>_type)` holding the work temporal array for the solver. This argument is `intent(inout)`.
 
 <!-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -->
 ### `solve_cg` subroutine
@@ -154,7 +154,7 @@ Subroutine
 
 `maxiter` (optional): scalar of type `integer` defining the maximum allowed number of iterations. If no value is given, a default of `N` is set, where `N = size(b)`. This argument is `intent(in)`.
 
-`workspace` (optional): `type(solver_workspace_<kind>)` holding the work temporal array for the solver. If the user passes its own `workspace`, then internally a pointer is set to it, otherwise, memory will be internally allocated and deallocated before exiting the procedure. This argument is `intent(inout)`.
+`workspace` (optional): `type(solver_workspace_<kind>_type)` holding the work temporal array for the solver. If the user passes its own `workspace`, then internally a pointer is set to it, otherwise, memory will be internally allocated and deallocated before exiting the procedure. This argument is `intent(inout)`.
 
 #### Example
 
@@ -183,9 +183,9 @@ Subroutine
 
 #### Argument(s)
 
-`A`: `class(linop_<kind>)` defining the linear operator. This argument is `intent(in)`.
+`A`: `class(linop_<kind>_type)` defining the linear operator. This argument is `intent(in)`.
 
-`M`: `class(linop_<kind>)` defining the preconditionner linear operator. This argument is `intent(in)`.
+`M`: `class(linop_<kind>_type)` defining the preconditionner linear operator. This argument is `intent(in)`.
 
 `b`: 1-D array of `real(<kind>)` defining the loading conditions of the linear system. This argument is `intent(in)`.
 
@@ -195,7 +195,7 @@ Subroutine
 
 `maxiter`: scalar of type `integer` defining the maximum allowed number of iterations. This argument is `intent(in)`.
 
-`workspace`: `type(solver_workspace_<kind>)` holding the work temporal array for the solver. This argument is `intent(inout)`.
+`workspace`: `type(solver_workspace_<kind>_type)` holding the work temporal array for the solver. This argument is `intent(inout)`.
 
 #### Example
 
@@ -238,9 +238,9 @@ Subroutine
 
 `precond` (optional): scalar of type `integer` enabling to switch among the default preconditionners available. If no value is given, no preconditionning will be applied. This argument is `intent(in)`.
 
-`M` (optional): `class(linop_<kind>)` defining a custom preconditionner linear operator. If given, `precond` will have no effect, a pointer is set to this custom preconditionner.
+`M` (optional): `class(linop_<kind>_type)` defining a custom preconditionner linear operator. If given, `precond` will have no effect, a pointer is set to this custom preconditionner.
 
-`workspace` (optional): `type(solver_workspace_<kind>)` holding the work temporal array for the solver. If the user passes its own `workspace`, then internally a pointer is set to it, otherwise, memory will be internally allocated and deallocated before exiting the procedure. This argument is `intent(inout)`.
+`workspace` (optional): `type(solver_workspace_<kind>_type)` holding the work temporal array for the solver. If the user passes its own `workspace`, then internally a pointer is set to it, otherwise, memory will be internally allocated and deallocated before exiting the procedure. This argument is `intent(inout)`.
 
 #### Example
 

example/linalg/example_solve_custom.f90

@@ -1,8 +1,8 @@
 module custom_solver
     use stdlib_kinds, only: dp
     use stdlib_sparse
-    use stdlib_linalg_iterative_solvers, only: linop_dp, &
-                    solver_workspace_dp, &
+    use stdlib_linalg_iterative_solvers, only: linop_dp_type, &
+                    solver_workspace_dp_type, &
                     solve_pcg_kernel, &
                     size_wksp_pcg
     implicit none
@@ -15,11 +15,11 @@ subroutine solve_pcg_custom(A,b,x,di,tol,maxiter,restart,workspace)
         logical(1), intent(in), optional, target  :: di(:)
         integer, intent(in), optional  :: maxiter
         logical, intent(in), optional  :: restart
-        type(solver_workspace_dp), optional, intent(inout), target :: workspace
+        type(solver_workspace_dp_type), optional, intent(inout), target :: workspace
         !-------------------------
-        type(linop_dp) :: op
-        type(linop_dp) :: M
-        type(solver_workspace_dp), pointer :: workspace_
+        type(linop_dp_type) :: op
+        type(linop_dp_type) :: M
+        type(solver_workspace_dp_type), pointer :: workspace_
         integer :: n, maxiter_
         real(dp) :: tol_
         logical :: restart_

src/stdlib_linalg_iterative_solvers.fypp

@@ -23,7 +23,7 @@ module stdlib_linalg_iterative_solvers
     !! linop type holding the linear operator and its associated methods.
     !! The `linop` type is used to define the linear operator for the iterative solvers.
     #:for k, t, s in R_KINDS_TYPES
-    type, public :: linop_${s}$
+    type, public :: linop_${s}$_type
         procedure(vector_sub_${s}$), nopass, pointer    :: apply => null()
         procedure(reduction_sub_${s}$), nopass, pointer :: inner_product => default_dot_${s}$
     end type
@@ -33,7 +33,7 @@ module stdlib_linalg_iterative_solvers
     !!
     !! solver_workspace type holding temporal array data for the iterative solvers.
     #:for k, t, s in R_KINDS_TYPES
-    type, public :: solver_workspace_${s}$
+    type, public :: solver_workspace_${s}$_type
         ${t}$, allocatable :: tmp(:,:)
         procedure(logger_sub_${s}$), pointer, nopass :: callback => null()
     end type 
@@ -70,12 +70,12 @@ module stdlib_linalg_iterative_solvers
     interface solve_cg_kernel
         #:for k, t, s in R_KINDS_TYPES
         module subroutine solve_cg_kernel_${s}$(A,b,x,tol,maxiter,workspace)
-            class(linop_${s}$), intent(in) :: A !! linear operator
+            class(linop_${s}$_type), intent(in) :: A !! linear operator
             ${t}$, intent(in) :: b(:) !! right-hand side vector
             ${t}$, intent(inout) :: x(:) !! solution vector and initial guess
             ${t}$, intent(in) :: tol !! tolerance for convergence
             integer, intent(in) :: maxiter !! maximum number of iterations
-            type(solver_workspace_${s}$), intent(inout) :: workspace !! workspace for the solver
+            type(solver_workspace_${s}$_type), intent(inout) :: workspace !! workspace for the solver
         end subroutine
         #:endfor
     end interface
@@ -97,7 +97,7 @@ module stdlib_linalg_iterative_solvers
             logical(1), intent(in), optional, target  :: di(:) !! dirichlet conditions mask
             integer, intent(in), optional :: maxiter !! maximum number of iterations
             logical, intent(in), optional :: restart !! restart flag
-            type(solver_workspace_${s}$), optional, intent(inout), target :: workspace !! workspace for the solver
+            type(solver_workspace_${s}$_type), optional, intent(inout), target :: workspace !! workspace for the solver
         end subroutine
         #:endfor
         #:endfor
@@ -111,13 +111,13 @@ module stdlib_linalg_iterative_solvers
     interface solve_pcg_kernel
         #:for k, t, s in R_KINDS_TYPES
         module subroutine solve_pcg_kernel_${s}$(A,M,b,x,tol,maxiter,workspace)
-            class(linop_${s}$), intent(in) :: A !! linear operator
-            class(linop_${s}$), intent(in) :: M !! preconditionner linear operator
+            class(linop_${s}$_type), intent(in) :: A !! linear operator
+            class(linop_${s}$_type), intent(in) :: M !! preconditionner linear operator
             ${t}$, intent(in) :: b(:) !! right-hand side vector
             ${t}$, intent(inout) :: x(:) !! solution vector and initial guess
             ${t}$, intent(in) :: tol !! tolerance for convergence
             integer, intent(in) :: maxiter !! maximum number of iterations
-            type(solver_workspace_${s}$), intent(inout) :: workspace !! workspace for the solver
+            type(solver_workspace_${s}$_type), intent(inout) :: workspace !! workspace for the solver
         end subroutine
         #:endfor
     end interface
@@ -140,8 +140,8 @@ module stdlib_linalg_iterative_solvers
             integer, intent(in), optional  :: maxiter !! maximum number of iterations
             logical, intent(in), optional :: restart !! restart flag
             integer, intent(in), optional  :: precond !! preconditionner method enumerator
-            class(linop_${s}$), optional , intent(in), target :: M !! preconditionner linear operator
-            type(solver_workspace_${s}$), optional, intent(inout), target :: workspace !! workspace for the solver
+            class(linop_${s}$_type), optional , intent(in), target :: M !! preconditionner linear operator
+            type(solver_workspace_${s}$_type), optional, intent(inout), target :: workspace !! workspace for the solver
         end subroutine
         #:endfor
         #:endfor

src/stdlib_linalg_iterative_solvers_cg.fypp

@@ -15,11 +15,11 @@ contains
 
     #:for k, t, s in R_KINDS_TYPES
     module subroutine solve_cg_kernel_${s}$(A,b,x,tol,maxiter,workspace)
-        class(linop_${s}$), intent(in) :: A
+        class(linop_${s}$_type), intent(in) :: A
         ${t}$, intent(in) :: b(:), tol
         ${t}$, intent(inout) :: x(:)
         integer, intent(in) :: maxiter
-        type(solver_workspace_${s}$), intent(inout) :: workspace
+        type(solver_workspace_${s}$_type), intent(inout) :: workspace
         !-------------------------
         integer :: iter
         ${t}$ :: norm_sq, norm_sq_old, norm_sq0
@@ -78,10 +78,10 @@ contains
         logical(1), intent(in), optional, target  :: di(:)
         integer, intent(in), optional :: maxiter
         logical, intent(in), optional  :: restart
-        type(solver_workspace_${s}$), optional, intent(inout), target :: workspace
+        type(solver_workspace_${s}$_type), optional, intent(inout), target :: workspace
         !-------------------------
-        type(linop_${s}$) :: op
-        type(solver_workspace_${s}$), pointer :: workspace_
+        type(linop_${s}$_type) :: op
+        type(solver_workspace_${s}$_type), pointer :: workspace_
         integer :: n, maxiter_
         ${t}$ :: tol_
         logical :: restart_

src/stdlib_linalg_iterative_solvers_pcg.fypp

@@ -22,12 +22,12 @@ contains
 
     #:for k, t, s in R_KINDS_TYPES
     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 
+        class(linop_${s}$_type), intent(in) :: A
+        class(linop_${s}$_type), intent(in) :: M 
         ${t}$, intent(in) :: b(:), tol
         ${t}$, intent(inout) :: x(:)
         integer, intent(in) :: maxiter
-        type(solver_workspace_${s}$), intent(inout) :: workspace
+        type(solver_workspace_${s}$_type), intent(inout) :: workspace
         !-------------------------
         integer :: iter
         ${t}$ :: norm_sq, norm_sq0, norm_sq_old
@@ -99,12 +99,12 @@ contains
         integer, intent(in), optional  :: maxiter
         logical, intent(in), optional  :: restart
         integer, intent(in), optional  :: precond 
-        class(linop_${s}$), optional , intent(in), target :: M 
-        type(solver_workspace_${s}$), optional, intent(inout), target :: workspace
+        class(linop_${s}$_type), optional , intent(in), target :: M 
+        type(solver_workspace_${s}$_type), optional, intent(inout), target :: workspace
         !-------------------------
-        type(linop_${s}$) :: op
-        type(linop_${s}$), pointer :: M_ => null()
-        type(solver_workspace_${s}$), pointer :: workspace_
+        type(linop_${s}$_type) :: op
+        type(linop_${s}$_type), pointer :: M_ => null()
+        type(solver_workspace_${s}$_type), pointer :: workspace_
         integer :: n, maxiter_
         ${t}$ :: tol_
         logical :: restart_