You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
psblas3/base/modules/psb_const_mod.F90

362 lines
17 KiB
Fortran

!
! Parallel Sparse BLAS version 3.5
! (C) Copyright 2006-2018
! Salvatore Filippone
! Alfredo Buttari
!
! 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.
!
!
module psb_const_mod
#if defined(HAVE_ISO_FORTRAN_ENV)
use iso_fortran_env
! This is a 2-byte integer, just in case
integer, parameter :: psb_i2pk_ = int16
! This is always a 4-byte integer, for MPI-related stuff
integer, parameter :: psb_mpk_ = int32
! This is always an 8-byte integer.
integer, parameter :: psb_epk_ = int64
!
! These must be the kind parameter corresponding to psb_mpi_r_dpk_
! and psb_mpi_r_spk_
!
integer, parameter :: psb_spk_ = real32
integer, parameter :: psb_dpk_ = real64
#else
! This is a 2-byte integer, just in case
integer, parameter :: i2ndig=4
integer, parameter :: psb_i2pk_ = selected_int_kind(i2ndig)
! This is always a 4-byte integer, for MPI-related stuff
integer, parameter :: indig=8
integer, parameter :: psb_mpk_ = selected_int_kind(indig)
! This is always an 8-byte integer.
integer, parameter :: lndig=12
integer, parameter :: psb_epk_ = selected_int_kind(lndig)
!
! These must be the kind parameter corresponding to psb_mpi_r_dpk_
! and psb_mpi_r_spk_
!
integer, parameter :: psb_spk_p_ = 6
integer, parameter :: psb_spk_r_ = 37
integer, parameter :: psb_spk_ = selected_real_kind(psb_spk_p_,psb_spk_r_)
integer, parameter :: psb_dpk_p_ = 15
integer, parameter :: psb_dpk_r_ = 307
integer, parameter :: psb_dpk_ = selected_real_kind(psb_dpk_p_,psb_dpk_r_)
#endif
! Now for the choices:
! IPK = integer kind for "local" indices and sizes.
! Can be 4 or 8 bytes.
! LPK = integer kind for "global" indices and sizes.
! Can be 4 or 8 bytes.
! Size must be >= size of IPK
!
! Additional rules:
! 1. MPI related stuff is always MPK
! 2. ctxt,IAM,NP: should we have two versions of everything,
! one with MPK the other with EPK?
! 3. INFO, ERR_ACT, IERR etc are always IPK
! 4. For the array version of things, where it makes sense
! e.g. realloc, snd/receive, define as MPK,EPK and the
! compiler will later pick up the correct version according
! to what IPK/LPK are mapped onto.
!
#if defined(IPK4) && defined(LPK4)
integer, parameter :: psb_ipk_ = psb_mpk_
integer, parameter :: psb_lpk_ = psb_mpk_
#elif defined(IPK4) && defined(LPK8)
integer, parameter :: psb_ipk_ = psb_mpk_
integer, parameter :: psb_lpk_ = psb_epk_
#elif defined(IPK8) && defined(LPK8)
integer, parameter :: psb_ipk_ = psb_epk_
integer, parameter :: psb_lpk_ = psb_epk_
#else
! Unsupported combination, compilation will stop later on
integer, parameter :: psb_ipk_ = -1
integer, parameter :: psb_lpk_ = -1
#endif
integer(psb_mpk_), save :: psb_sizeof_sp
integer(psb_mpk_), save :: psb_sizeof_dp
integer(psb_mpk_), save :: psb_sizeof_i2p = 2
integer(psb_mpk_), save :: psb_sizeof_mp = 4
integer(psb_mpk_), save :: psb_sizeof_ep = 8
#if defined(IPK4) && defined(LPK4)
integer(psb_mpk_), save :: psb_sizeof_ip = 4
integer(psb_mpk_), save :: psb_sizeof_lp = 4
#elif defined(IPK4) && defined(LPK8)
integer(psb_mpk_), save :: psb_sizeof_ip = 4
integer(psb_mpk_), save :: psb_sizeof_lp = 8
#elif defined(IPK8) && defined(LPK8)
integer(psb_mpk_), save :: psb_sizeof_ip = 8
integer(psb_mpk_), save :: psb_sizeof_lp = 8
#else
integer(psb_mpk_), save :: psb_sizeof_ip = -1
integer(psb_mpk_), save :: psb_sizeof_lp = -1
#endif
!
! Integer type identifiers for MPI operations.
!
integer(psb_mpk_), save :: psb_mpi_i2pk_
integer(psb_mpk_), save :: psb_mpi_epk_
integer(psb_mpk_), save :: psb_mpi_mpk_
integer(psb_mpk_), save :: psb_mpi_ipk_
integer(psb_mpk_), save :: psb_mpi_lpk_
integer(psb_mpk_), save :: psb_mpi_r_spk_
integer(psb_mpk_), save :: psb_mpi_r_dpk_
integer(psb_mpk_), save :: psb_mpi_c_spk_
integer(psb_mpk_), save :: psb_mpi_c_dpk_
!
! Version
!
character(len=*), parameter :: psb_version_string_ = "3.9.0"
integer(psb_ipk_), parameter :: psb_version_major_ = 3
integer(psb_ipk_), parameter :: psb_version_minor_ = 9
integer(psb_ipk_), parameter :: psb_patchlevel_ = 0
!
! Handy & miscellaneous constants
!
integer(psb_epk_), parameter :: ezero=0, eone=1
integer(psb_epk_), parameter :: etwo=2, ethree=3, emone=-1
integer(psb_mpk_), parameter :: mzero=0, mone=1
integer(psb_mpk_), parameter :: mtwo=2, mthree=3, mmone=-1
integer(psb_lpk_), parameter :: lzero=0, lone=1
integer(psb_lpk_), parameter :: ltwo=2, lthree=3, lmone=-1
integer(psb_ipk_), parameter :: izero=0, ione=1
integer(psb_ipk_), parameter :: itwo=2, ithree=3, imone=-1
integer(psb_i2pk_), parameter :: i2zero=0, i2one=1
integer(psb_i2pk_), parameter :: i2two=2, i2three=3, i2mone=-1
integer(psb_ipk_), parameter :: psb_root_=0
real(psb_spk_), parameter :: szero=0.0_psb_spk_, sone=1.0_psb_spk_
real(psb_dpk_), parameter :: dzero=0.0_psb_dpk_, done=1.0_psb_dpk_
complex(psb_spk_), parameter :: czero=(0.0_psb_spk_,0.0_psb_spk_)
complex(psb_spk_), parameter :: cone=(1.0_psb_spk_,0.0_psb_spk_)
complex(psb_dpk_), parameter :: zzero=(0.0_psb_dpk_,0.0_psb_dpk_)
complex(psb_dpk_), parameter :: zone=(1.0_psb_dpk_,0.0_psb_dpk_)
real(psb_dpk_), parameter :: d_epstol=1.1e-16_psb_dpk_ ! Unit roundoff.
real(psb_spk_), parameter :: s_epstol=5.e-8_psb_spk_ ! Is this right?
character, parameter :: psb_all_='A', psb_topdef_=' '
logical, parameter :: psb_m_is_complex_ = .false.
logical, parameter :: psb_e_is_complex_ = .false.
logical, parameter :: psb_i_is_complex_ = .false.
logical, parameter :: psb_l_is_complex_ = .false.
logical, parameter :: psb_s_is_complex_ = .false.
logical, parameter :: psb_d_is_complex_ = .false.
logical, parameter :: psb_c_is_complex_ = .true.
logical, parameter :: psb_z_is_complex_ = .true.
logical, parameter :: psb_ls_is_complex_ = .false.
logical, parameter :: psb_ld_is_complex_ = .false.
logical, parameter :: psb_lc_is_complex_ = .true.
logical, parameter :: psb_lz_is_complex_ = .true.
!
! Sort routines constants
!
!
! The up/down constant are defined in pairs having
! opposite values. We make use of this fact in the heapsort routine.
!
integer(psb_ipk_), parameter :: psb_sort_up_ = 1, psb_sort_down_ = -1
integer(psb_ipk_), parameter :: psb_lsort_up_ = 2, psb_lsort_down_ = -2
integer(psb_ipk_), parameter :: psb_asort_up_ = 3, psb_asort_down_ = -3
integer(psb_ipk_), parameter :: psb_alsort_up_ = 4, psb_alsort_down_ = -4
integer(psb_ipk_), parameter :: psb_sort_ovw_idx_ = 0, psb_sort_keep_idx_ = 1
integer(psb_ipk_), parameter :: psb_heap_resize = 200
integer(psb_ipk_), parameter :: psb_find_any_ = 0
integer(psb_ipk_), parameter :: psb_find_first_ge_ = 1
integer(psb_ipk_), parameter :: psb_find_last_le_ = 2
!
! Sparse matrix constants
!
!
! State of matrices.
!
integer(psb_ipk_), parameter :: psb_invalid_ = -1
integer(psb_ipk_), parameter :: psb_spmat_null_=0, psb_spmat_bld_=1
integer(psb_ipk_), parameter :: psb_spmat_asb_=2, psb_spmat_upd_=4
integer(psb_ipk_), parameter :: psb_matbld_noremote_=0, psb_matbld_remote_=1
integer(psb_ipk_), parameter :: psb_ireg_flgs_=10, psb_ip2_=0
integer(psb_ipk_), parameter :: psb_iflag_=2, psb_ichk_=3
integer(psb_ipk_), parameter :: psb_nnzt_=4, psb_zero_=5,psb_ipc_=6
integer(psb_ipk_), parameter :: psb_unsorted_ = 0
integer(psb_ipk_), parameter :: psb_row_major_ = 1
integer(psb_ipk_), parameter :: psb_col_major_ = 2
! Duplicate coefficients handling
! These are usually set while calling spcnv as one of its
! optional arugments.
integer(psb_ipk_), parameter :: psb_dupl_add_ = 0
integer(psb_ipk_), parameter :: psb_dupl_ovwrt_ = 1
integer(psb_ipk_), parameter :: psb_dupl_err_ = 2
integer(psb_ipk_), parameter :: psb_dupl_def_ = psb_dupl_add_
! Matrix update mode
integer(psb_ipk_), parameter :: psb_upd_srch_ = 98764
integer(psb_ipk_), parameter :: psb_upd_perm_ = 98765
integer(psb_ipk_), parameter :: psb_upd_dflt_ = psb_upd_srch_
#if defined(HAVE_ISO_FORTRAN_ENV)
integer(psb_ipk_), save :: psb_err_unit = error_unit
integer(psb_ipk_), save :: psb_inp_unit = input_unit
integer(psb_ipk_), save :: psb_out_unit = output_unit
#else
integer(psb_ipk_), save :: psb_err_unit = 0
integer(psb_ipk_), save :: psb_inp_unit = 5
integer(psb_ipk_), save :: psb_out_unit = 6
#endif
!
!
! Error constants
integer(psb_ipk_), parameter, public :: psb_success_=0
integer(psb_ipk_), parameter, public :: psb_err_pivot_too_small_=2
integer(psb_ipk_), parameter, public :: psb_err_invalid_ovr_num_=3
integer(psb_ipk_), parameter, public :: psb_err_invalid_input_=5
integer(psb_ipk_), parameter, public :: psb_err_iarg_neg_=10
integer(psb_ipk_), parameter, public :: psb_err_iarg_pos_=20
integer(psb_ipk_), parameter, public :: psb_err_input_value_invalid_i_=30
integer(psb_ipk_), parameter, public :: psb_err_input_asize_invalid_i_=35
integer(psb_ipk_), parameter, public :: psb_err_input_asize_small_i_=36
integer(psb_ipk_), parameter, public :: psb_err_iarg_invalid_i_=40
integer(psb_ipk_), parameter, public :: psb_err_iarg_not_gtia_ii_=50
integer(psb_ipk_), parameter, public :: psb_err_iarg_not_gteia_ii_=60
integer(psb_ipk_), parameter, public :: psb_err_iarg_invalid_value_=70
integer(psb_ipk_), parameter, public :: psb_err_asb_nrc_error_=71
integer(psb_ipk_), parameter, public :: psb_err_iarg2_neg_=80
integer(psb_ipk_), parameter, public :: psb_err_ia2_not_increasing_=90
integer(psb_ipk_), parameter, public :: psb_err_ia1_not_increasing_=91
integer(psb_ipk_), parameter, public :: psb_err_ia1_badindices_=100
integer(psb_ipk_), parameter, public :: psb_err_invalid_args_combination_=110
integer(psb_ipk_), parameter, public :: psb_err_invalid_pid_arg_=115
integer(psb_ipk_), parameter, public :: psb_err_iarg_n_mbgtian_=120
integer(psb_ipk_), parameter, public :: psb_err_dupl_cd_vl=123
integer(psb_ipk_), parameter, public :: psb_err_duplicate_coo=130
integer(psb_ipk_), parameter, public :: psb_err_invalid_input_format_=134
integer(psb_ipk_), parameter, public :: psb_err_unsupported_format_=135
integer(psb_ipk_), parameter, public :: psb_err_format_unknown_=136
integer(psb_ipk_), parameter, public :: psb_err_iarray_outside_bounds_=140
integer(psb_ipk_), parameter, public :: psb_err_iarray_outside_process_=150
integer(psb_ipk_), parameter, public :: psb_err_forgot_geall_=290
integer(psb_ipk_), parameter, public :: psb_err_forgot_spall_=295
integer(psb_ipk_), parameter, public :: psb_err_wrong_ins_=298
integer(psb_ipk_), parameter, public :: psb_err_iarg_mbeeiarra_i_=300
integer(psb_ipk_), parameter, public :: psb_err_bad_int_cnv_=301
integer(psb_ipk_), parameter, public :: psb_err_mpi_int_ovflw_=302
integer(psb_ipk_), parameter, public :: psb_err_mpi_error_=400
integer(psb_ipk_), parameter, public :: psb_err_parm_differs_among_procs_=550
integer(psb_ipk_), parameter, public :: psb_err_entry_out_of_bounds_=551
integer(psb_ipk_), parameter, public :: psb_err_inconsistent_index_lists_=552
integer(psb_ipk_), parameter, public :: psb_err_partfunc_toomuchprocs_=570
integer(psb_ipk_), parameter, public :: psb_err_partfunc_toofewprocs_=575
integer(psb_ipk_), parameter, public :: psb_err_partfunc_wrong_pid_=580
integer(psb_ipk_), parameter, public :: psb_err_no_optional_arg_=581
integer(psb_ipk_), parameter, public :: psb_err_arg_m_required_=582
integer(psb_ipk_), parameter, public :: psb_err_many_optional_arg_=583
integer(psb_ipk_), parameter, public :: psb_err_optional_arg_pair_=584
integer(psb_ipk_), parameter, public :: psb_err_missing_override_method_=700
integer(psb_ipk_), parameter, public :: psb_err_invalid_dynamic_type_=701
integer(psb_ipk_), parameter, public :: psb_err_invalid_matrix_sizes_=1119
integer(psb_ipk_), parameter, public :: psb_err_rectangular_mat_unsupported_=1120
integer(psb_ipk_), parameter, public :: psb_err_invalid_mat_state_=1121
integer(psb_ipk_), parameter, public :: psb_err_invalid_cd_state_=1122
integer(psb_ipk_), parameter, public :: psb_err_invalid_a_and_cd_state_=1123
integer(psb_ipk_), parameter, public :: psb_err_invalid_vect_state_=1124
integer(psb_ipk_), parameter, public :: psb_err_context_error_=2010
integer(psb_ipk_), parameter, public :: psb_err_initerror_neugh_procs_=2011
integer(psb_ipk_), parameter, public :: psb_err_invalid_matrix_input_state_=2231
integer(psb_ipk_), parameter, public :: psb_err_input_no_regen_=2232
integer(psb_ipk_), parameter, public :: psb_err_lld_case_not_implemented_=3010
integer(psb_ipk_), parameter, public :: psb_err_transpose_unsupported_=3015
integer(psb_ipk_), parameter, public :: psb_err_transpose_c_unsupported_=3020
integer(psb_ipk_), parameter, public :: psb_err_transpose_not_n_unsupported_=3021
integer(psb_ipk_), parameter, public :: psb_err_only_unit_diag_=3022
integer(psb_ipk_), parameter, public :: psb_err_ja_nix_ia_niy_unsupported_=3030
integer(psb_ipk_), parameter, public :: psb_err_ix_n1_iy_n1_unsupported_=3040
integer(psb_ipk_), parameter, public :: psb_err_input_matrix_unassembled_=3110
integer(psb_ipk_), parameter, public :: psb_err_missing_aux_lib_=3999
integer(psb_ipk_), parameter, public :: psb_err_alloc_dealloc_=4000
integer(psb_ipk_), parameter, public :: psb_err_internal_error_=4001
integer(psb_ipk_), parameter, public :: psb_err_from_subroutine_=4010
integer(psb_ipk_), parameter, public :: psb_err_from_subroutine_i_=4012
integer(psb_ipk_), parameter, public :: psb_err_from_subroutine_ai_=4013
integer(psb_ipk_), parameter, public :: psb_err_alloc_request_=4025
integer(psb_ipk_), parameter, public :: psb_err_from_subroutine_non_=4011
integer(psb_ipk_), parameter, public :: psb_err_invalid_istop_=5001
integer(psb_ipk_), parameter, public :: psb_err_invalid_irst_ =5002
integer(psb_ipk_), parameter, public :: psb_err_invalid_preci_=5003
integer(psb_ipk_), parameter, public :: psb_err_invalid_preca_=5004
type :: psb_ctxt_type
integer(psb_mpk_), allocatable :: ctxt
contains
procedure, pass(ctxt) :: get_i_ctxt => psb_get_i_ctxt
end type psb_ctxt_type
contains
function psb_cmp_ctxt(ctxt1, ctxt2) result(res)
type(psb_ctxt_type), intent(in) :: ctxt1, ctxt2
logical :: res
res = .false.
if (.not.allocated(ctxt1%ctxt).and.(.not.allocated(ctxt2%ctxt))) &
& res = .true.
if (allocated(ctxt1%ctxt).and.allocated(ctxt2%ctxt)) &
& res = (ctxt1%ctxt == ctxt2%ctxt)
end function psb_cmp_ctxt
subroutine psb_get_i_ctxt(ctxt,ictxt,info)
class(psb_ctxt_type), intent(in) :: ctxt
integer(psb_mpk_), intent(out) :: ictxt
integer(psb_ipk_), intent(out) :: info
if (.not.allocated(ctxt%ctxt)) then
ictxt = -1_psb_ipk_
info = psb_err_mpi_error_
else
ictxt = ctxt%ctxt
info = psb_success_
end if
end subroutine psb_get_i_ctxt
end module psb_const_mod