!!$ !!$ Parallel Sparse BLAS version 3.0 !!$ (C) Copyright 2006, 2007, 2008, 2009, 2010, 2012 !!$ Salvatore Filippone University of Rome Tor Vergata !!$ Alfredo Buttari CNRS-IRIT, Toulouse !!$ !!$ Redistribution and use in source and binary forms, with or without !!$ modification, are permitted provided that the following conditions !!$ are met: !!$ 1. Redistributions of source code must retain the above copyright !!$ notice, this list of conditions and the following disclaimer. !!$ 2. Redistributions in binary form must reproduce the above copyright !!$ notice, this list of conditions, and the following disclaimer in the !!$ documentation and/or other materials provided with the distribution. !!$ 3. The name of the PSBLAS group or the names of its contributors may !!$ not be used to endorse or promote products derived from this !!$ software without specific written permission. !!$ !!$ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS !!$ ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED !!$ TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR !!$ PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE PSBLAS GROUP OR ITS CONTRIBUTORS !!$ BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR !!$ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF !!$ SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS !!$ INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN !!$ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) !!$ ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE !!$ POSSIBILITY OF SUCH DAMAGE. !!$ !!$ ! ! File: psb_krylov_mod.f90 ! Interfaces for Krylov subspace iterative methods. ! ! ! Subroutine: psb_skrylov ! ! Front-end for the Krylov subspace iterations, realversion ! ! Arguments: ! ! methd - character The specific method; can take the values: ! CG ! CGS ! BICG ! BICGSTAB ! BICGSTABL ! RGMRES ! ! a - type(psb_sspmat_type) Input: sparse matrix containing A. ! prec - class(psb_sprec_type) Input: preconditioner ! b - real,dimension(:) Input: vector containing the ! right hand side B ! x - real,dimension(:) Input/Output: vector containing the ! initial guess and final solution X. ! eps - real Input: Stopping tolerance; the iteration is ! stopped when the error ! estimate |err| <= eps ! ! desc_a - type(psb_desc_type). Input: The communication descriptor. ! info - integer. Output: Return code ! ! itmax - integer(optional) Input: maximum number of iterations to be ! performed. ! iter - integer(optional) Output: how many iterations have been ! performed. ! err - real (optional) Output: error estimate on exit ! itrace - integer(optional) Input: print an informational message ! with the error estimate every itrace ! iterations ! irst - integer(optional) Input: restart parameter for RGMRES and ! BICGSTAB(L) methods ! istop - integer(optional) Input: stopping criterion, or how ! to estimate the error. ! 1: err = |r|/(|a||x|+|b|) ! 2: err = |r|/|b| ! where r is the (preconditioned, recursive ! estimate of) residual ! !!$Subroutine psb_skrylov(method,a,prec,b,x,eps,desc_a,info,itmax,iter,err,itrace,irst,istop) !!$ use psb_base_mod !!$ use psb_prec_mod,only : psb_sprec_type, psb_dprec_type, psb_sprec_type, psb_zprec_type !!$ use psb_krylov_mod, psb_protect_name => psb_skrylov !!$ character(len=*) :: method !!$ Type(psb_sspmat_type), Intent(in) :: a !!$ Type(psb_desc_type), Intent(in) :: desc_a !!$ class(psb_sprec_type), intent(in) :: prec !!$ real(psb_spk_), Intent(in) :: b(:) !!$ real(psb_spk_), Intent(inout) :: x(:) !!$ Real(psb_spk_), Intent(in) :: eps !!$ integer(psb_ipk_), intent(out) :: info !!$ integer(psb_ipk_), Optional, Intent(in) :: itmax, itrace, irst,istop !!$ integer(psb_ipk_), Optional, Intent(out) :: iter !!$ Real(psb_spk_), Optional, Intent(out) :: err !!$ interface !!$ subroutine psb_scg(a,prec,b,x,eps,& !!$ & desc_a,info,itmax,iter,err,itrace,istop) !!$ import :: psb_ipk_, psb_spk_, psb_desc_type, & !!$ & psb_sspmat_type, psb_sprec_type !!$ type(psb_sspmat_type), intent(in) :: a !!$ type(psb_desc_type), intent(in) :: desc_a !!$ real(psb_spk_), intent(in) :: b(:) !!$ real(psb_spk_), intent(inout) :: x(:) !!$ real(psb_spk_), intent(in) :: eps !!$ class(psb_sprec_type), intent(in) :: prec !!$ integer(psb_ipk_), intent(out) :: info !!$ integer(psb_ipk_), optional, intent(in) :: itmax, itrace,istop !!$ integer(psb_ipk_), optional, intent(out) :: iter !!$ real(psb_spk_), optional, intent(out) :: err !!$ end subroutine psb_scg !!$ subroutine psb_sbicg(a,prec,b,x,eps,& !!$ & desc_a,info,itmax,iter,err,itrace,istop) !!$ import :: psb_ipk_, psb_spk_, psb_desc_type, & !!$ & psb_sspmat_type, psb_sprec_type !!$ type(psb_sspmat_type), intent(in) :: a !!$ type(psb_desc_type), intent(in) :: desc_a !!$ real(psb_spk_), intent(in) :: b(:) !!$ real(psb_spk_), intent(inout) :: x(:) !!$ real(psb_spk_), intent(in) :: eps !!$ class(psb_sprec_type), intent(in) :: prec !!$ integer(psb_ipk_), intent(out) :: info !!$ integer(psb_ipk_), optional, intent(in) :: itmax, itrace,istop !!$ integer(psb_ipk_), optional, intent(out) :: iter !!$ real(psb_spk_), optional, intent(out) :: err !!$ end subroutine psb_sbicg !!$ subroutine psb_scgstab(a,prec,b,x,eps,& !!$ & desc_a,info,itmax,iter,err,itrace,istop) !!$ import :: psb_ipk_, psb_spk_, psb_desc_type, & !!$ & psb_sspmat_type, psb_sprec_type !!$ type(psb_sspmat_type), intent(in) :: a !!$ type(psb_desc_type), intent(in) :: desc_a !!$ real(psb_spk_), intent(in) :: b(:) !!$ real(psb_spk_), intent(inout) :: x(:) !!$ real(psb_spk_), intent(in) :: eps !!$ class(psb_sprec_type), intent(in) :: prec !!$ integer(psb_ipk_), intent(out) :: info !!$ integer(psb_ipk_), optional, intent(in) :: itmax, itrace,istop !!$ integer(psb_ipk_), optional, intent(out) :: iter !!$ real(psb_spk_), optional, intent(out) :: err !!$ end subroutine psb_scgstab !!$ Subroutine psb_scgstabl(a,prec,b,x,eps,desc_a,info,& !!$ &itmax,iter,err,itrace,irst,istop) !!$ import :: psb_ipk_, psb_spk_, psb_desc_type, & !!$ & psb_sspmat_type, psb_sprec_type !!$ Type(psb_sspmat_type), Intent(in) :: a !!$ Type(psb_desc_type), Intent(in) :: desc_a !!$ class(psb_sprec_type), intent(in) :: prec !!$ real(psb_spk_), Intent(in) :: b(:) !!$ real(psb_spk_), Intent(inout) :: x(:) !!$ Real(psb_spk_), Intent(in) :: eps !!$ integer(psb_ipk_), intent(out) :: info !!$ integer(psb_ipk_), Optional, Intent(in) :: itmax, itrace, irst,istop !!$ integer(psb_ipk_), Optional, Intent(out) :: iter !!$ Real(psb_spk_), Optional, Intent(out) :: err !!$ end subroutine psb_scgstabl !!$ Subroutine psb_srgmres(a,prec,b,x,eps,desc_a,info,& !!$ &itmax,iter,err,itrace,irst,istop) !!$ import :: psb_ipk_, psb_spk_, psb_desc_type, & !!$ & psb_sspmat_type, psb_sprec_type !!$ Type(psb_sspmat_type), Intent(in) :: a !!$ Type(psb_desc_type), Intent(in) :: desc_a !!$ class(psb_sprec_type), intent(in) :: prec !!$ real(psb_spk_), Intent(in) :: b(:) !!$ real(psb_spk_), Intent(inout) :: x(:) !!$ Real(psb_spk_), Intent(in) :: eps !!$ integer(psb_ipk_), intent(out) :: info !!$ integer(psb_ipk_), Optional, Intent(in) :: itmax, itrace, irst,istop !!$ integer(psb_ipk_), Optional, Intent(out) :: iter !!$ Real(psb_spk_), Optional, Intent(out) :: err !!$ end subroutine psb_srgmres !!$ subroutine psb_scgs(a,prec,b,x,eps,& !!$ & desc_a,info,itmax,iter,err,itrace,istop) !!$ import :: psb_ipk_, psb_spk_, psb_desc_type, & !!$ & psb_sspmat_type, psb_sprec_type !!$ type(psb_sspmat_type), intent(in) :: a !!$ type(psb_desc_type), intent(in) :: desc_a !!$ real(psb_spk_), intent(in) :: b(:) !!$ real(psb_spk_), intent(inout) :: x(:) !!$ real(psb_spk_), intent(in) :: eps !!$ class(psb_sprec_type), intent(in) :: prec !!$ integer(psb_ipk_), intent(out) :: info !!$ integer(psb_ipk_), optional, intent(in) :: itmax, itrace,istop !!$ integer(psb_ipk_), optional, intent(out) :: iter !!$ real(psb_spk_), optional, intent(out) :: err !!$ end subroutine psb_scgs !!$ end interface !!$ !!$ !!$ integer(psb_ipk_) :: ictxt,me,np,err_act !!$ character(len=20) :: name !!$ !!$ info = psb_success_ !!$ name = 'psb_krylov' !!$ call psb_erractionsave(err_act) !!$ !!$ !!$ ictxt=desc_a%get_context() !!$ !!$ call psb_info(ictxt, me, np) !!$ !!$ !!$ select case(psb_toupper(method)) !!$ case('CG') !!$ call psb_scg(a,prec,b,x,eps,desc_a,info,& !!$ &itmax,iter,err,itrace,istop) !!$ case('CGS') !!$ call psb_scgs(a,prec,b,x,eps,desc_a,info,& !!$ &itmax,iter,err,itrace,istop) !!$ case('BICG') !!$ call psb_sbicg(a,prec,b,x,eps,desc_a,info,& !!$ &itmax,iter,err,itrace,istop) !!$ case('BICGSTAB') !!$ call psb_scgstab(a,prec,b,x,eps,desc_a,info,& !!$ & itmax,iter,err,itrace,istop) !!$ case('RGMRES') !!$ call psb_srgmres(a,prec,b,x,eps,desc_a,info,& !!$ & itmax,iter,err,itrace,irst,istop) !!$ case('BICGSTABL') !!$ call psb_scgstabl(a,prec,b,x,eps,desc_a,info,& !!$ &itmax,iter,err,itrace,irst,istop) !!$ case default !!$ if (me == 0) write(psb_err_unit,*) trim(name),': Warning: Unknown method ',method,& !!$ & ', defaulting to BiCGSTAB' !!$ call psb_scgstab(a,prec,b,x,eps,desc_a,info,& !!$ &itmax,iter,err,itrace,istop) !!$ end select !!$ !!$ if(info /= psb_success_) then !!$ call psb_errpush(info,name) !!$ goto 9999 !!$ end if !!$ !!$ call psb_erractionrestore(err_act) !!$ return !!$ !!$9999 continue !!$ call psb_erractionrestore(err_act) !!$ if (err_act == psb_act_abort_) then !!$ call psb_error(ictxt) !!$ return !!$ end if !!$ !!$end subroutine psb_skrylov Subroutine psb_skrylov_vect(method,a,prec,b,x,eps,desc_a,info,& & itmax,iter,err,itrace,irst,istop,cond) use psb_base_mod use psb_prec_mod,only : psb_sprec_type use psb_krylov_mod, psb_protect_name => psb_skrylov_vect character(len=*) :: method Type(psb_sspmat_type), Intent(in) :: a Type(psb_desc_type), Intent(in) :: desc_a class(psb_sprec_type), intent(inout) :: prec type(psb_s_vect_type), Intent(inout) :: b type(psb_s_vect_type), Intent(inout) :: x Real(psb_spk_), Intent(in) :: eps integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), Optional, Intent(in) :: itmax, itrace, irst,istop integer(psb_ipk_), Optional, Intent(out) :: iter Real(psb_spk_), Optional, Intent(out) :: err,cond interface subroutine psb_scg_vect(a,prec,b,x,eps,& & desc_a,info,itmax,iter,err,itrace,istop,cond) import :: psb_ipk_, psb_spk_, psb_desc_type, & & psb_sspmat_type, psb_sprec_type, psb_s_vect_type type(psb_sspmat_type), intent(in) :: a type(psb_desc_type), intent(in) :: desc_a class(psb_sprec_type), intent(inout) :: prec type(psb_s_vect_type), Intent(inout) :: b type(psb_s_vect_type), Intent(inout) :: x real(psb_spk_), intent(in) :: eps integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), optional, intent(in) :: itmax, itrace,istop integer(psb_ipk_), optional, intent(out) :: iter real(psb_spk_), optional, intent(out) :: err,cond end subroutine psb_scg_vect subroutine psb_sbicg_vect(a,prec,b,x,eps,& & desc_a,info,itmax,iter,err,itrace,istop) import :: psb_ipk_, psb_spk_, psb_desc_type, & & psb_sspmat_type, psb_sprec_type, psb_s_vect_type type(psb_sspmat_type), intent(in) :: a type(psb_desc_type), intent(in) :: desc_a class(psb_sprec_type), intent(inout) :: prec type(psb_s_vect_type), Intent(inout) :: b type(psb_s_vect_type), Intent(inout) :: x real(psb_spk_), intent(in) :: eps integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), optional, intent(in) :: itmax, itrace,istop integer(psb_ipk_), optional, intent(out) :: iter real(psb_spk_), optional, intent(out) :: err end subroutine psb_sbicg_vect subroutine psb_scgstab_vect(a,prec,b,x,eps,& & desc_a,info,itmax,iter,err,itrace,istop) import :: psb_ipk_, psb_spk_, psb_desc_type, & & psb_sspmat_type, psb_sprec_type, psb_s_vect_type type(psb_sspmat_type), intent(in) :: a type(psb_desc_type), intent(in) :: desc_a type(psb_s_vect_type), Intent(inout) :: b type(psb_s_vect_type), Intent(inout) :: x real(psb_spk_), intent(in) :: eps class(psb_sprec_type), intent(inout) :: prec integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), optional, intent(in) :: itmax, itrace,istop integer(psb_ipk_), optional, intent(out) :: iter real(psb_spk_), optional, intent(out) :: err end subroutine psb_scgstab_vect Subroutine psb_scgstabl_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err, itrace,irst,istop) import :: psb_ipk_, psb_spk_, psb_desc_type, & & psb_sspmat_type, psb_sprec_type, psb_s_vect_type Type(psb_sspmat_type), Intent(in) :: a Type(psb_desc_type), Intent(in) :: desc_a class(psb_sprec_type), intent(inout) :: prec type(psb_s_vect_type), Intent(inout) :: b type(psb_s_vect_type), Intent(inout) :: x Real(psb_spk_), Intent(in) :: eps integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), Optional, Intent(in) :: itmax, itrace, irst,istop integer(psb_ipk_), Optional, Intent(out) :: iter Real(psb_spk_), Optional, Intent(out) :: err end subroutine psb_scgstabl_vect Subroutine psb_srgmres_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err,itrace,irst,istop) import :: psb_ipk_, psb_spk_, psb_desc_type, & & psb_sspmat_type, psb_sprec_type, psb_s_vect_type Type(psb_sspmat_type), Intent(in) :: a Type(psb_desc_type), Intent(in) :: desc_a class(psb_sprec_type), intent(inout) :: prec type(psb_s_vect_type), Intent(inout) :: b type(psb_s_vect_type), Intent(inout) :: x Real(psb_spk_), Intent(in) :: eps integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), Optional, Intent(in) :: itmax, itrace, irst,istop integer(psb_ipk_), Optional, Intent(out) :: iter Real(psb_spk_), Optional, Intent(out) :: err end subroutine psb_srgmres_vect subroutine psb_scgs_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err,itrace,istop) import :: psb_ipk_, psb_spk_, psb_desc_type, & & psb_sspmat_type, psb_sprec_type, psb_s_vect_type type(psb_sspmat_type), intent(in) :: a type(psb_desc_type), intent(in) :: desc_a class(psb_sprec_type), intent(inout) :: prec type(psb_s_vect_type), Intent(inout) :: b type(psb_s_vect_type), Intent(inout) :: x real(psb_spk_), intent(in) :: eps integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), optional, intent(in) :: itmax, itrace,istop integer(psb_ipk_), optional, intent(out) :: iter real(psb_spk_), optional, intent(out) :: err end subroutine psb_scgs_vect end interface integer(psb_ipk_) :: ictxt,me,np,err_act character(len=20) :: name info = psb_success_ name = 'psb_krylov' call psb_erractionsave(err_act) ictxt=desc_a%get_context() call psb_info(ictxt, me, np) select case(psb_toupper(method)) case('CG') call psb_scg_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err,itrace,istop,cond) case('CGS') call psb_scgs_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err,itrace,istop) case('BICG') call psb_sbicg_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err,itrace,istop) case('BICGSTAB') call psb_scgstab_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err,itrace,istop) case('RGMRES') call psb_srgmres_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err,itrace,irst,istop) case('BICGSTABL') call psb_scgstabl_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err,itrace,irst,istop) case default if (me == 0) write(psb_err_unit,*) trim(name),& & ': Warning: Unknown method ',method,& & ', defaulting to BiCGSTAB' call psb_scgstab_vect(a,prec,b,x,eps,desc_a,info,& &itmax,iter,err,itrace,istop) end select if(info /= psb_success_) then call psb_errpush(info,name) goto 9999 end if call psb_erractionrestore(err_act) return 9999 continue call psb_erractionrestore(err_act) if (err_act == psb_act_abort_) then call psb_error(ictxt) return end if end subroutine psb_skrylov_vect