! ! ! AMG4PSBLAS version 1.0 ! Algebraic Multigrid Package ! based on PSBLAS (Parallel Sparse BLAS version 3.7) ! ! (C) Copyright 2021 ! ! Salvatore Filippone ! Pasqua D'Ambra ! Fabio Durastante ! ! 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 AMG4PSBLAS 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 AMG4PSBLAS 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: amg_c_gs_solver_mod.f90 ! ! Module: amg_c_gs_solver_mod ! ! This module defines: ! - the amg_c_gs_solver_type data structure containing the ingredients ! for a local Gauss-Seidel iteration. We provide Forward GS (FWGS) and ! backward GS (BWGS). The iterations are local to a process (they operate ! on the block diagonal). Combined with a Jacobi smoother will generate a ! hybrid-Gauss-Seidel solver, i.e. Gauss-Seidel within each process, Jacobi ! among the processes. ! With two objects as pre- and post-smoothers it is possible to build a ! Forward-Backward smoother, suitable for symmetric iterations. ! module amg_c_gs_solver use amg_c_base_solver_mod type, extends(amg_c_base_solver_type) :: amg_c_gs_solver_type type(psb_cspmat_type) :: l, u integer(psb_ipk_) :: sweeps real(psb_spk_) :: eps contains procedure, pass(sv) :: dump => amg_c_gs_solver_dmp procedure, pass(sv) :: check => c_gs_solver_check procedure, pass(sv) :: clone => amg_c_gs_solver_clone procedure, pass(sv) :: clone_settings => amg_c_gs_solver_clone_settings procedure, pass(sv) :: clear_data => amg_c_gs_solver_clear_data procedure, pass(sv) :: build => amg_c_gs_solver_bld procedure, pass(sv) :: cnv => amg_c_gs_solver_cnv procedure, pass(sv) :: apply_v => amg_c_gs_solver_apply_vect procedure, pass(sv) :: apply_a => amg_c_gs_solver_apply procedure, pass(sv) :: free => c_gs_solver_free procedure, pass(sv) :: cseti => c_gs_solver_cseti procedure, pass(sv) :: csetc => c_gs_solver_csetc procedure, pass(sv) :: csetr => c_gs_solver_csetr procedure, pass(sv) :: descr => c_gs_solver_descr procedure, pass(sv) :: default => c_gs_solver_default procedure, pass(sv) :: sizeof => c_gs_solver_sizeof procedure, pass(sv) :: get_nzeros => c_gs_solver_get_nzeros procedure, nopass :: get_wrksz => c_gs_solver_get_wrksize procedure, nopass :: get_fmt => c_gs_solver_get_fmt procedure, nopass :: get_id => c_gs_solver_get_id procedure, nopass :: is_iterative => c_gs_solver_is_iterative end type amg_c_gs_solver_type type, extends(amg_c_gs_solver_type) :: amg_c_bwgs_solver_type contains procedure, pass(sv) :: build => amg_c_bwgs_solver_bld procedure, pass(sv) :: apply_v => amg_c_bwgs_solver_apply_vect procedure, pass(sv) :: apply_a => amg_c_bwgs_solver_apply procedure, nopass :: get_fmt => c_bwgs_solver_get_fmt procedure, nopass :: get_id => c_bwgs_solver_get_id procedure, pass(sv) :: descr => c_bwgs_solver_descr end type amg_c_bwgs_solver_type private :: c_gs_solver_bld, c_gs_solver_apply, & & c_gs_solver_free, & & c_gs_solver_descr, c_gs_solver_sizeof, & & c_gs_solver_default, c_gs_solver_dmp, & & c_gs_solver_apply_vect, c_gs_solver_get_nzeros, & & c_gs_solver_get_fmt, c_gs_solver_check,& & c_gs_solver_is_iterative, & & c_bwgs_solver_get_fmt, c_bwgs_solver_descr, & & c_gs_solver_get_id, c_bwgs_solver_get_id, c_gs_solver_get_wrksize interface subroutine amg_c_gs_solver_apply_vect(alpha,sv,x,beta,y,desc_data,& & trans,work,wv,info,init,initu) import :: psb_desc_type, amg_c_gs_solver_type, psb_c_vect_type, psb_spk_, & & psb_cspmat_type, psb_c_base_sparse_mat, psb_c_base_vect_type, psb_ipk_ implicit none type(psb_desc_type), intent(in) :: desc_data class(amg_c_gs_solver_type), intent(inout) :: sv type(psb_c_vect_type),intent(inout) :: x type(psb_c_vect_type),intent(inout) :: y complex(psb_spk_),intent(in) :: alpha,beta character(len=1),intent(in) :: trans complex(psb_spk_),target, intent(inout) :: work(:) type(psb_c_vect_type),intent(inout) :: wv(:) integer(psb_ipk_), intent(out) :: info character, intent(in), optional :: init type(psb_c_vect_type),intent(inout), optional :: initu end subroutine amg_c_gs_solver_apply_vect subroutine amg_c_bwgs_solver_apply_vect(alpha,sv,x,beta,y,desc_data,& & trans,work,wv,info,init,initu) import :: psb_desc_type, amg_c_bwgs_solver_type, psb_c_vect_type, psb_spk_, & & psb_cspmat_type, psb_c_base_sparse_mat, psb_c_base_vect_type, psb_ipk_ implicit none type(psb_desc_type), intent(in) :: desc_data class(amg_c_bwgs_solver_type), intent(inout) :: sv type(psb_c_vect_type),intent(inout) :: x type(psb_c_vect_type),intent(inout) :: y complex(psb_spk_),intent(in) :: alpha,beta character(len=1),intent(in) :: trans complex(psb_spk_),target, intent(inout) :: work(:) type(psb_c_vect_type),intent(inout) :: wv(:) integer(psb_ipk_), intent(out) :: info character, intent(in), optional :: init type(psb_c_vect_type),intent(inout), optional :: initu end subroutine amg_c_bwgs_solver_apply_vect end interface interface subroutine amg_c_gs_solver_apply(alpha,sv,x,beta,y,desc_data,trans,work,info,init,initu) import :: psb_desc_type, amg_c_gs_solver_type, psb_c_vect_type, psb_spk_, & & psb_cspmat_type, psb_c_base_sparse_mat, psb_c_base_vect_type, psb_ipk_ implicit none type(psb_desc_type), intent(in) :: desc_data class(amg_c_gs_solver_type), intent(inout) :: sv complex(psb_spk_),intent(inout) :: x(:) complex(psb_spk_),intent(inout) :: y(:) complex(psb_spk_),intent(in) :: alpha,beta character(len=1),intent(in) :: trans complex(psb_spk_),target, intent(inout) :: work(:) integer(psb_ipk_), intent(out) :: info character, intent(in), optional :: init complex(psb_spk_),intent(inout), optional :: initu(:) end subroutine amg_c_gs_solver_apply subroutine amg_c_bwgs_solver_apply(alpha,sv,x,beta,y,desc_data,& & trans,work,info,init,initu) import :: psb_desc_type, amg_c_bwgs_solver_type, psb_c_vect_type, psb_spk_, & & psb_cspmat_type, psb_c_base_sparse_mat, psb_c_base_vect_type, psb_ipk_ implicit none type(psb_desc_type), intent(in) :: desc_data class(amg_c_bwgs_solver_type), intent(inout) :: sv complex(psb_spk_),intent(inout) :: x(:) complex(psb_spk_),intent(inout) :: y(:) complex(psb_spk_),intent(in) :: alpha,beta character(len=1),intent(in) :: trans complex(psb_spk_),target, intent(inout) :: work(:) integer(psb_ipk_), intent(out) :: info character, intent(in), optional :: init complex(psb_spk_),intent(inout), optional :: initu(:) end subroutine amg_c_bwgs_solver_apply end interface interface subroutine amg_c_gs_solver_bld(a,desc_a,sv,info,b,amold,vmold,imold) import :: psb_desc_type, amg_c_gs_solver_type, psb_c_vect_type, psb_spk_, & & psb_cspmat_type, psb_c_base_sparse_mat, psb_c_base_vect_type,& & psb_ipk_, psb_i_base_vect_type implicit none type(psb_cspmat_type), intent(in), target :: a Type(psb_desc_type), Intent(inout) :: desc_a class(amg_c_gs_solver_type), intent(inout) :: sv integer(psb_ipk_), intent(out) :: info type(psb_cspmat_type), intent(in), target, optional :: b class(psb_c_base_sparse_mat), intent(in), optional :: amold class(psb_c_base_vect_type), intent(in), optional :: vmold class(psb_i_base_vect_type), intent(in), optional :: imold end subroutine amg_c_gs_solver_bld subroutine amg_c_bwgs_solver_bld(a,desc_a,sv,info,b,amold,vmold,imold) import :: psb_desc_type, amg_c_bwgs_solver_type, psb_c_vect_type, psb_spk_, & & psb_cspmat_type, psb_c_base_sparse_mat, psb_c_base_vect_type,& & psb_ipk_, psb_i_base_vect_type implicit none type(psb_cspmat_type), intent(in), target :: a Type(psb_desc_type), Intent(inout) :: desc_a class(amg_c_bwgs_solver_type), intent(inout) :: sv integer(psb_ipk_), intent(out) :: info type(psb_cspmat_type), intent(in), target, optional :: b class(psb_c_base_sparse_mat), intent(in), optional :: amold class(psb_c_base_vect_type), intent(in), optional :: vmold class(psb_i_base_vect_type), intent(in), optional :: imold end subroutine amg_c_bwgs_solver_bld end interface interface subroutine amg_c_gs_solver_cnv(sv,info,amold,vmold,imold) import :: amg_c_gs_solver_type, psb_spk_, & & psb_c_base_sparse_mat, psb_c_base_vect_type,& & psb_ipk_, psb_i_base_vect_type implicit none class(amg_c_gs_solver_type), intent(inout) :: sv integer(psb_ipk_), intent(out) :: info class(psb_c_base_sparse_mat), intent(in), optional :: amold class(psb_c_base_vect_type), intent(in), optional :: vmold class(psb_i_base_vect_type), intent(in), optional :: imold end subroutine amg_c_gs_solver_cnv end interface interface subroutine amg_c_gs_solver_dmp(sv,desc,level,info,prefix,head,solver,global_num) import :: psb_desc_type, amg_c_gs_solver_type, psb_c_vect_type, psb_spk_, & & psb_cspmat_type, psb_c_base_sparse_mat, psb_c_base_vect_type, & & psb_ipk_ implicit none class(amg_c_gs_solver_type), intent(in) :: sv type(psb_desc_type), intent(in) :: desc integer(psb_ipk_), intent(in) :: level integer(psb_ipk_), intent(out) :: info character(len=*), intent(in), optional :: prefix, head logical, optional, intent(in) :: solver, global_num end subroutine amg_c_gs_solver_dmp end interface interface subroutine amg_c_gs_solver_clone(sv,svout,info) import :: psb_desc_type, psb_cspmat_type, psb_c_base_sparse_mat, & & psb_c_vect_type, psb_c_base_vect_type, psb_spk_, & & amg_c_base_solver_type, amg_c_gs_solver_type, psb_ipk_ Implicit None ! Arguments class(amg_c_gs_solver_type), intent(inout) :: sv class(amg_c_base_solver_type), allocatable, intent(inout) :: svout integer(psb_ipk_), intent(out) :: info end subroutine amg_c_gs_solver_clone end interface interface subroutine amg_c_gs_solver_clone_settings(sv,svout,info) import :: psb_desc_type, psb_cspmat_type, psb_c_base_sparse_mat, & & psb_c_vect_type, psb_c_base_vect_type, psb_spk_, & & amg_c_base_solver_type, amg_c_gs_solver_type, psb_ipk_ Implicit None ! Arguments class(amg_c_gs_solver_type), intent(inout) :: sv class(amg_c_base_solver_type), intent(inout) :: svout integer(psb_ipk_), intent(out) :: info end subroutine amg_c_gs_solver_clone_settings end interface interface subroutine amg_c_gs_solver_clear_data(sv,info) import :: psb_desc_type, psb_cspmat_type, psb_c_base_sparse_mat, & & psb_c_vect_type, psb_c_base_vect_type, psb_spk_, & & amg_c_gs_solver_type, psb_ipk_ Implicit None ! Arguments class(amg_c_gs_solver_type), intent(inout) :: sv integer(psb_ipk_), intent(out) :: info end subroutine amg_c_gs_solver_clear_data end interface contains subroutine c_gs_solver_default(sv) Implicit None ! Arguments class(amg_c_gs_solver_type), intent(inout) :: sv sv%sweeps = ione sv%eps = dzero return end subroutine c_gs_solver_default subroutine c_gs_solver_check(sv,info) Implicit None ! Arguments class(amg_c_gs_solver_type), intent(inout) :: sv integer(psb_ipk_), intent(out) :: info integer(psb_ipk_) :: err_act character(len=20) :: name='c_gs_solver_check' call psb_erractionsave(err_act) info = psb_success_ call amg_check_def(sv%sweeps,& & 'GS Sweeps',ione,is_int_positive) if (info /= psb_success_) goto 9999 call psb_erractionrestore(err_act) return 9999 call psb_error_handler(err_act) return end subroutine c_gs_solver_check subroutine c_gs_solver_cseti(sv,what,val,info,idx) Implicit None ! Arguments class(amg_c_gs_solver_type), intent(inout) :: sv character(len=*), intent(in) :: what integer(psb_ipk_), intent(in) :: val integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), intent(in), optional :: idx integer(psb_ipk_) :: err_act character(len=20) :: name='c_gs_solver_cseti' info = psb_success_ call psb_erractionsave(err_act) select case(psb_toupper(what)) case('SOLVER_SWEEPS') sv%sweeps = val case default call sv%amg_c_base_solver_type%set(what,val,info,idx=idx) end select call psb_erractionrestore(err_act) return 9999 call psb_error_handler(err_act) return end subroutine c_gs_solver_cseti subroutine c_gs_solver_csetc(sv,what,val,info,idx) Implicit None ! Arguments class(amg_c_gs_solver_type), intent(inout) :: sv character(len=*), intent(in) :: what character(len=*), intent(in) :: val integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), intent(in), optional :: idx integer(psb_ipk_) :: err_act, ival character(len=20) :: name='c_gs_solver_csetc' info = psb_success_ call psb_erractionsave(err_act) call sv%amg_c_base_solver_type%set(what,val,info,idx=idx) if (info /= psb_success_) then info = psb_err_from_subroutine_ call psb_errpush(info, name) goto 9999 end if call psb_erractionrestore(err_act) return 9999 call psb_error_handler(err_act) return end subroutine c_gs_solver_csetc subroutine c_gs_solver_csetr(sv,what,val,info,idx) Implicit None ! Arguments class(amg_c_gs_solver_type), intent(inout) :: sv character(len=*), intent(in) :: what real(psb_spk_), intent(in) :: val integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), intent(in), optional :: idx integer(psb_ipk_) :: err_act character(len=20) :: name='c_gs_solver_csetr' call psb_erractionsave(err_act) info = psb_success_ select case(psb_toupper(what)) case('SOLVER_EPS') sv%eps = val case default call sv%amg_c_base_solver_type%set(what,val,info,idx=idx) end select call psb_erractionrestore(err_act) return 9999 call psb_error_handler(err_act) return end subroutine c_gs_solver_csetr subroutine c_gs_solver_free(sv,info) Implicit None ! Arguments class(amg_c_gs_solver_type), intent(inout) :: sv integer(psb_ipk_), intent(out) :: info integer(psb_ipk_) :: err_act character(len=20) :: name='c_gs_solver_free' call psb_erractionsave(err_act) info = psb_success_ call sv%l%free() call sv%u%free() call psb_erractionrestore(err_act) return 9999 call psb_error_handler(err_act) return end subroutine c_gs_solver_free subroutine c_gs_solver_descr(sv,info,iout,coarse) Implicit None ! Arguments class(amg_c_gs_solver_type), intent(in) :: sv integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), intent(in), optional :: iout logical, intent(in), optional :: coarse ! Local variables integer(psb_ipk_) :: err_act character(len=20), parameter :: name='amg_c_gs_solver_descr' integer(psb_ipk_) :: iout_ call psb_erractionsave(err_act) info = psb_success_ if (present(iout)) then iout_ = iout else iout_ = psb_out_unit endif if (sv%eps<=dzero) then write(iout_,*) ' Forward Gauss-Seidel iterative solver with ',& & sv%sweeps,' sweeps' else write(iout_,*) ' Forward Gauss-Seidel iterative solver with tolerance',& & sv%eps,' and maxit', sv%sweeps end if call psb_erractionrestore(err_act) return 9999 call psb_error_handler(err_act) return end subroutine c_gs_solver_descr function c_gs_solver_get_nzeros(sv) result(val) implicit none ! Arguments class(amg_c_gs_solver_type), intent(in) :: sv integer(psb_epk_) :: val integer(psb_ipk_) :: i val = 0 val = val + sv%l%get_nzeros() val = val + sv%u%get_nzeros() return end function c_gs_solver_get_nzeros function c_gs_solver_sizeof(sv) result(val) implicit none ! Arguments class(amg_c_gs_solver_type), intent(in) :: sv integer(psb_epk_) :: val integer(psb_ipk_) :: i val = psb_sizeof_ip val = val + sv%l%sizeof() val = val + sv%u%sizeof() return end function c_gs_solver_sizeof function c_gs_solver_get_fmt() result(val) implicit none character(len=32) :: val val = "Forward Gauss-Seidel solver" end function c_gs_solver_get_fmt function c_gs_solver_get_id() result(val) implicit none integer(psb_ipk_) :: val val = amg_gs_ end function c_gs_solver_get_id ! ! If this is true, then the solver needs a starting ! guess. Currently only handled in JAC smoother. ! function c_gs_solver_is_iterative() result(val) implicit none logical :: val val = .true. end function c_gs_solver_is_iterative subroutine c_bwgs_solver_descr(sv,info,iout,coarse) Implicit None ! Arguments class(amg_c_bwgs_solver_type), intent(in) :: sv integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), intent(in), optional :: iout logical, intent(in), optional :: coarse ! Local variables integer(psb_ipk_) :: err_act character(len=20), parameter :: name='amg_c_bwgs_solver_descr' integer(psb_ipk_) :: iout_ call psb_erractionsave(err_act) info = psb_success_ if (present(iout)) then iout_ = iout else iout_ = psb_out_unit endif if (sv%eps<=dzero) then write(iout_,*) ' Backward Gauss-Seidel iterative solver with ',& & sv%sweeps,' sweeps' else write(iout_,*) ' Backward Gauss-Seidel iterative solver with tolerance',& & sv%eps,' and maxit', sv%sweeps end if call psb_erractionrestore(err_act) return 9999 call psb_error_handler(err_act) return end subroutine c_bwgs_solver_descr function c_bwgs_solver_get_fmt() result(val) implicit none character(len=32) :: val val = "Backward Gauss-Seidel solver" end function c_bwgs_solver_get_fmt function c_bwgs_solver_get_id() result(val) implicit none integer(psb_ipk_) :: val val = amg_bwgs_ end function c_bwgs_solver_get_id function c_gs_solver_get_wrksize() result(val) implicit none integer(psb_ipk_) :: val val = 2 end function c_gs_solver_get_wrksize end module amg_c_gs_solver