! ! ! 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_z_as_smoother_mod.f90 ! ! Module: amg_z_as_smoother_mod ! ! This module defines: ! the amg_z_as_smoother_type data structure containing the ! smoother for an Additive Schwarz smoother. ! ! To begin with, the build procedure constructs the extended ! matrix A and its corresponding descriptor (this has multiple ! halo layers duplicated across different processes); it then ! stores in ND the block off-diagonal matrix, and builds the solver ! on the (extended) block diagonal matrix. ! ! The code allows for the variations of Additive Schwartz, Restricted ! Additive Schwartz and Additive Schwartz with Harmonic Extensions. ! From an implementation point of view, these are handled by ! combining application/non-application of the prolongator/restrictor ! operators. ! module amg_z_as_smoother use amg_z_base_smoother_mod type, extends(amg_z_base_smoother_type) :: amg_z_as_smoother_type ! The local solver component is inherited from the ! parent type. ! class(amg_z_base_solver_type), allocatable :: sv ! type(psb_zspmat_type) :: nd type(psb_desc_type) :: desc_data integer(psb_ipk_) :: novr, restr, prol integer(psb_lpk_) :: nd_nnz_tot contains procedure, pass(sm) :: apply_v => amg_z_as_smoother_apply_vect procedure, pass(sm) :: apply_a => amg_z_as_smoother_apply procedure, pass(sm) :: check => amg_z_as_smoother_check procedure, pass(sm) :: dump => amg_z_as_smoother_dmp procedure, pass(sm) :: build => amg_z_as_smoother_bld procedure, pass(sm) :: cnv => amg_z_as_smoother_cnv procedure, pass(sm) :: clone => amg_z_as_smoother_clone procedure, pass(sm) :: clone_settings => amg_z_as_smoother_clone_settings procedure, pass(sm) :: clear_data => amg_z_as_smoother_clear_data procedure, pass(sm) :: restr_a => amg_z_as_smoother_restr_a procedure, pass(sm) :: prol_a => amg_z_as_smoother_prol_a procedure, pass(sm) :: restr_v => amg_z_as_smoother_restr_v procedure, pass(sm) :: prol_v => amg_z_as_smoother_prol_v generic, public :: apply_restr => restr_v, restr_a generic, public :: apply_prol => prol_v, prol_a procedure, pass(sm) :: free => amg_z_as_smoother_free procedure, pass(sm) :: cseti => amg_z_as_smoother_cseti procedure, pass(sm) :: csetc => amg_z_as_smoother_csetc procedure, pass(sm) :: descr => z_as_smoother_descr procedure, pass(sm) :: sizeof => z_as_smoother_sizeof procedure, pass(sm) :: default => z_as_smoother_default procedure, pass(sm) :: get_nzeros => z_as_smoother_get_nzeros procedure, pass(sm) :: get_wrksz => z_as_smoother_get_wrksize procedure, nopass :: get_fmt => z_as_smoother_get_fmt procedure, nopass :: get_id => z_as_smoother_get_id end type amg_z_as_smoother_type private :: z_as_smoother_descr, z_as_smoother_sizeof, & & z_as_smoother_default, z_as_smoother_get_nzeros, & & z_as_smoother_get_fmt, z_as_smoother_get_id, & & z_as_smoother_get_wrksize character(len=6), parameter, private :: & & restrict_names(0:4)=(/'none ','halo ',' ',' ',' '/) character(len=12), parameter, private :: & & prolong_names(0:3)=(/'none ','sum ','average ','square root'/) interface subroutine amg_z_as_smoother_check(sm,info) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, psb_desc_type, psb_ipk_ implicit none class(amg_z_as_smoother_type), intent(inout) :: sm integer(psb_ipk_), intent(out) :: info end subroutine amg_z_as_smoother_check end interface interface subroutine amg_z_as_smoother_restr_v(sm,x,trans,work,info,data) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, & & psb_desc_type, psb_ipk_ implicit none class(amg_z_as_smoother_type), intent(inout) :: sm type(psb_z_vect_type),intent(inout) :: x character(len=1),intent(in) :: trans complex(psb_dpk_),target, intent(inout) :: work(:) integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), optional, intent(in) :: data end subroutine amg_z_as_smoother_restr_v end interface interface subroutine amg_z_as_smoother_restr_a(sm,x,trans,work,info,data) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, & & psb_desc_type, psb_ipk_ implicit none class(amg_z_as_smoother_type), intent(inout) :: sm complex(psb_dpk_), intent(inout) :: x(:) character(len=1),intent(in) :: trans complex(psb_dpk_),target, intent(inout) :: work(:) integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), optional, intent(in) :: data end subroutine amg_z_as_smoother_restr_a end interface interface subroutine amg_z_as_smoother_prol_v(sm,x,trans,work,info,data) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, & & psb_desc_type, psb_ipk_ implicit none class(amg_z_as_smoother_type), intent(inout) :: sm type(psb_z_vect_type),intent(inout) :: x character(len=1),intent(in) :: trans complex(psb_dpk_),target, intent(inout) :: work(:) integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), optional, intent(in) :: data end subroutine amg_z_as_smoother_prol_v end interface interface subroutine amg_z_as_smoother_prol_a(sm,x,trans,work,info,data) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, & & psb_desc_type, psb_ipk_ implicit none class(amg_z_as_smoother_type), intent(inout) :: sm complex(psb_dpk_), intent(inout) :: x(:) character(len=1),intent(in) :: trans complex(psb_dpk_),target, intent(inout) :: work(:) integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), optional, intent(in) :: data end subroutine amg_z_as_smoother_prol_a end interface interface subroutine amg_z_as_smoother_apply_vect(alpha,sm,x,beta,y,desc_data,& & trans,sweeps,work,wv,info,init,initu) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, & & psb_desc_type, psb_ipk_ implicit none type(psb_desc_type), intent(in) :: desc_data class(amg_z_as_smoother_type), intent(inout) :: sm type(psb_z_vect_type),intent(inout) :: x type(psb_z_vect_type),intent(inout) :: y complex(psb_dpk_),intent(in) :: alpha,beta character(len=1),intent(in) :: trans integer(psb_ipk_), intent(in) :: sweeps complex(psb_dpk_),target, intent(inout) :: work(:) type(psb_z_vect_type),intent(inout) :: wv(:) integer(psb_ipk_), intent(out) :: info character, intent(in), optional :: init type(psb_z_vect_type),intent(inout), optional :: initu end subroutine amg_z_as_smoother_apply_vect end interface interface subroutine amg_z_as_smoother_apply(alpha,sm,x,beta,y,desc_data,& & trans,sweeps,work,info,init,initu) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_,& & psb_desc_type, psb_ipk_ implicit none type(psb_desc_type), intent(in) :: desc_data class(amg_z_as_smoother_type), intent(inout) :: sm complex(psb_dpk_),intent(inout) :: x(:) complex(psb_dpk_),intent(inout) :: y(:) complex(psb_dpk_),intent(in) :: alpha,beta character(len=1),intent(in) :: trans integer(psb_ipk_), intent(in) :: sweeps complex(psb_dpk_),target, intent(inout) :: work(:) integer(psb_ipk_), intent(out) :: info character, intent(in), optional :: init complex(psb_dpk_),intent(inout), optional :: initu(:) end subroutine amg_z_as_smoother_apply end interface interface subroutine amg_z_as_smoother_bld(a,desc_a,sm,info,amold,vmold,imold) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, & & psb_desc_type, psb_z_base_sparse_mat, psb_ipk_,& & psb_i_base_vect_type implicit none type(psb_zspmat_type), intent(in), target :: a Type(psb_desc_type), Intent(inout) :: desc_a class(amg_z_as_smoother_type), intent(inout) :: sm integer(psb_ipk_), intent(out) :: info class(psb_z_base_sparse_mat), intent(in), optional :: amold class(psb_z_base_vect_type), intent(in), optional :: vmold class(psb_i_base_vect_type), intent(in), optional :: imold end subroutine amg_z_as_smoother_bld end interface interface subroutine amg_z_as_smoother_cnv(sm,info,amold,vmold,imold) import :: psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, & & psb_z_base_sparse_mat, psb_ipk_, psb_i_base_vect_type implicit none class(amg_z_as_smoother_type), intent(inout) :: sm integer(psb_ipk_), intent(out) :: info class(psb_z_base_sparse_mat), intent(in), optional :: amold class(psb_z_base_vect_type), intent(in), optional :: vmold class(psb_i_base_vect_type), intent(in), optional :: imold end subroutine amg_z_as_smoother_cnv end interface interface subroutine amg_z_as_smoother_cseti(sm,what,val,info,idx) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, psb_desc_type, psb_ipk_ implicit none class(amg_z_as_smoother_type), intent(inout) :: sm character(len=*), intent(in) :: what integer(psb_ipk_), intent(in) :: val integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), intent(in), optional :: idx end subroutine amg_z_as_smoother_cseti end interface interface subroutine amg_z_as_smoother_csetc(sm,what,val,info,idx) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, psb_desc_type, psb_ipk_ implicit none class(amg_z_as_smoother_type), intent(inout) :: sm character(len=*), intent(in) :: what character(len=*), intent(in) :: val integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), intent(in), optional :: idx end subroutine amg_z_as_smoother_csetc end interface interface subroutine amg_z_as_smoother_free(sm,info) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, psb_desc_type, psb_ipk_ implicit none class(amg_z_as_smoother_type), intent(inout) :: sm integer(psb_ipk_), intent(out) :: info end subroutine amg_z_as_smoother_free end interface interface subroutine amg_z_as_smoother_dmp(sm,desc,level,info,prefix,head,smoother,solver,global_num) import :: psb_zspmat_type, psb_z_vect_type, psb_z_base_vect_type, & & psb_dpk_, amg_z_as_smoother_type, psb_epk_, psb_desc_type, & & psb_ipk_ implicit none class(amg_z_as_smoother_type), intent(in) :: sm 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) :: smoother, solver, global_num end subroutine amg_z_as_smoother_dmp end interface interface subroutine amg_z_as_smoother_clone(sm,smout,info) import :: amg_z_as_smoother_type, psb_dpk_, & & amg_z_base_smoother_type, psb_ipk_ class(amg_z_as_smoother_type), intent(inout) :: sm class(amg_z_base_smoother_type), allocatable, intent(inout) :: smout integer(psb_ipk_), intent(out) :: info end subroutine amg_z_as_smoother_clone end interface interface subroutine amg_z_as_smoother_clone_settings(sm,smout,info) import :: psb_desc_type, psb_zspmat_type, psb_z_base_sparse_mat, & & psb_z_vect_type, psb_z_base_vect_type, psb_dpk_, & & amg_z_base_smoother_type, amg_z_as_smoother_type, psb_ipk_ Implicit None ! Arguments class(amg_z_as_smoother_type), intent(inout) :: sm class(amg_z_base_smoother_type), intent(inout) :: smout integer(psb_ipk_), intent(out) :: info end subroutine amg_z_as_smoother_clone_settings end interface interface subroutine amg_z_as_smoother_clear_data(sm,info) import :: psb_desc_type, psb_zspmat_type, psb_z_base_sparse_mat, & & psb_z_vect_type, psb_z_base_vect_type, psb_dpk_, & & amg_z_as_smoother_type, psb_ipk_ Implicit None ! Arguments class(amg_z_as_smoother_type), intent(inout) :: sm integer(psb_ipk_), intent(out) :: info end subroutine amg_z_as_smoother_clear_data end interface contains function z_as_smoother_sizeof(sm) result(val) implicit none ! Arguments class(amg_z_as_smoother_type), intent(in) :: sm integer(psb_epk_) :: val integer(psb_ipk_) :: i val = 3*psb_sizeof_ip + psb_sizeof_lp if (allocated(sm%sv)) val = val + sm%sv%sizeof() val = val + sm%nd%sizeof() return end function z_as_smoother_sizeof function z_as_smoother_get_nzeros(sm) result(val) implicit none class(amg_z_as_smoother_type), intent(in) :: sm integer(psb_epk_) :: val integer(psb_ipk_) :: i val = 0 if (allocated(sm%sv)) & & val = sm%sv%get_nzeros() val = val + sm%nd%get_nzeros() end function z_as_smoother_get_nzeros subroutine z_as_smoother_default(sm) use psb_base_mod, only : psb_halo_, psb_none_ Implicit None ! Arguments class(amg_z_as_smoother_type), intent(inout) :: sm ! ! Default: AS with 1 overlap layer ! sm%restr = psb_halo_ sm%prol = psb_sum_ sm%novr = 1 if (allocated(sm%sv)) then call sm%sv%default() end if return end subroutine z_as_smoother_default subroutine z_as_smoother_descr(sm,info,iout,coarse,prefix) Implicit None ! Arguments class(amg_z_as_smoother_type), intent(in) :: sm integer(psb_ipk_), intent(out) :: info integer(psb_ipk_), intent(in), optional :: iout logical, intent(in), optional :: coarse character(len=*), intent(in), optional :: prefix ! Local variables integer(psb_ipk_) :: err_act character(len=20), parameter :: name='amg_z_as_smoother_descr' integer(psb_ipk_) :: iout_ logical :: coarse_ character(1024) :: prefix_ call psb_erractionsave(err_act) info = psb_success_ if (present(coarse)) then coarse_ = coarse else coarse_ = .false. end if if (present(iout)) then iout_ = iout else iout_ = psb_out_unit endif if (present(prefix)) then prefix_ = prefix else prefix_ = "" end if if (.not.coarse_) then write(iout_,*) trim(prefix_), ' Additive Schwarz with ',& & sm%novr, ' overlap layers.' write(iout_,*) trim(prefix_), ' Restrictor: ',restrict_names(sm%restr) write(iout_,*) trim(prefix_), ' Prolongator: ',prolong_names(sm%prol) write(iout_,*) trim(prefix_), ' Local solver:' endif if (allocated(sm%sv)) then call sm%sv%descr(info,iout_,coarse=coarse,prefix=prefix) end if call psb_erractionrestore(err_act) return 9999 call psb_error_handler(err_act) return end subroutine z_as_smoother_descr function z_as_smoother_get_wrksize(sm) result(val) implicit none class(amg_z_as_smoother_type), intent(inout) :: sm integer(psb_ipk_) :: val val = 3 if (allocated(sm%sv)) val = val + sm%sv%get_wrksz() end function z_as_smoother_get_wrksize function z_as_smoother_get_fmt() result(val) implicit none character(len=32) :: val val = "Additive Schwarz" end function z_as_smoother_get_fmt function z_as_smoother_get_id() result(val) implicit none integer(psb_ipk_) :: val val = amg_as_ end function z_as_smoother_get_id end module amg_z_as_smoother