PARCEL SYCL v1.2
/
API Reference
User Guide
API Reference
Search
Download
日本語
Contents
Function Index
1
Common Items
1.1
Format of the Entries
1.2
Solvers
1.3
Symbols and Terms
1.4
Input Matrix
1.5
Settings
1.6
Constants
1.7
Results
1.8
Convergence Status
1.9
Settings and MPI
1.10
Precision
2
Convergence by Solver
2.1
pcg
2.2
pbicgstab
2.3
pgmres
2.4
pcagmres
2.5
pcagmres (Q Not Formed)
2.6
power
2.7
inverse_power
2.8
ks_arnoldi
3
PARCEL SYCL Classes
3.1
Mapping to the Common Items
4
PARCEL Data Types
5
parcel::comm
5.1
Constructor
5.2
mpi_rank() / mpi_size() / mpi_comm() / rank() / size()
6
parcel::matrix
6.1
Constructor
6.2
set_crsMat()
6.3
n_local()
7
parcel::vector
7.1
Constructor / resize()
7.2
queue() / size()
7.3
setValue()
7.4
setValue_hi() / setValue_lo()
7.5
getValue()
7.6
getValue_hi() / getValue_lo()
7.7
data() / data_hi() / data_lo()
8
Items Common to All Solvers
8.1
Class Template Arguments (Arithmetic Precision)
8.2
Template Arguments of solver() (Data Precision)
8.3
Handling of Settings and Exceptions
8.4
Constants
9
Common Member Functions
9.1
set_tolerance() / get_tolerance()
9.2
set_max_iteration() / get_max_iteration()
9.3
set_precon_algo() / get_precon_algo()
9.4
set_jacobi() / get_jacobi()
9.5
set_blockjacobi() / get_blockjacobi()
9.6
set_scaling_matrix() / set_scaling_vector() / get_scaling_matrix() / get_scaling_vector()
9.7
get_converged_reason()
9.8
is_converged()
9.9
get_iterations()
9.10
get_residual()
9.11
get_true_residual()
9.12
converged_reason_name()
9.13
version_string() / get_version() / PARCEL_VERSION_*
10
Member Functions Common to the Eigenvalue Solvers
10.1
set_precon_spectrum() / get_precon_spectrum()
10.2
set_linsolve_algo() / get_linsolve_algo()
10.3
set_linsolve_tolerance() / get_linsolve_tolerance()
10.4
set_linsolve_max_iteration() / get_linsolve_max_iteration()
10.5
set_linsolve_restart() / get_linsolve_restart()
10.6
set_linsolve_precon_algo() / set_linsolve_blockjacobi() / set_linsolve_jacobi() / get_linsolve_precon_param()
10.7
set_linsolve_scaling_matrix() / set_linsolve_scaling_vector()
10.8
get_linsolve_failures()
11
parcel::krylov::pcg
11.1
pcg (class)
11.2
solver()
12
parcel::krylov::pbicgstab
12.1
pbicgstab (class)
12.2
solver()
13
parcel::krylov::pgmres
13.1
pgmres (class)
13.2
solver()
13.3
set_restart() / get_restart()
13.4
set_qr_algo() / get_qr_algo()
13.5
set_precon_space_output() / get_precon_space_output()
13.6
set_shift() / get_shift()
14
parcel::krylov::pcagmres
14.1
pcagmres (class)
14.2
solver()
14.3
set_restart() / get_restart_s() / get_restart_t()
14.4
set_qr_algo() / get_qr_algo()
14.5
set_explicit_q() / get_explicit_q()
14.6
CAGMRES_Q_IMPLICIT (without forming Q)
15
parcel::krylov::power
15.1
power (class)
15.2
solver()
16
parcel::krylov::inverse_power
16.1
inverse_power (class)
16.2
solver()
17
parcel::krylov::ks_arnoldi
17.1
ks_arnoldi (class)
17.2
solver()
17.3
set_ks_subspace() / get_ks_m() / get_ks_k_keep() / get_ks_nev()
17.4
set_ks_max_restart() / get_ks_max_restart()
17.5
set_qr_algo() / get_qr_algo()
17.6
set_shift() / disable_shift()
17.7
get_ks_nconv()
17.8
set_shift_linsolve_tolerance() / set_shift_linsolve_max_iteration() / set_shift_linsolve_restart() (deprecated)
18
C API
18.1
Mapping to the Common Items
18.2
Constants
18.3
parcel_options
18.4
parcel_result
18.5
parcel_options_init()
18.6
parcel_solver_from_name()
18.7
parcel_eigen_count()
18.8
parcel_solve_linear()
18.9
parcel_solve_eigen()
18.10
parcel_options_size() / parcel_result_size()
18.11
parcel_get_version() / parcel_version_string()
18.12
run_parcel_sycl_c() (deprecated)
19
Fortran API
19.1
Mapping to the Common Items
19.2
Constants
19.3
parcel_options / parcel_result
19.4
parcel_options_init
19.5
parcel_solve_linear
19.6
parcel_solve_eigen
19.7
parcel_eigen_count
19.8
parcel_options_check() / parcel_result_check()
19.9
parcel_options_size() / parcel_result_size()
19.10
parcel_get_version / parcel_version_string
19.11
run_parcel_sycl_f() (deprecated)
20
Python API
20.1
Mapping to the Common Items
20.2
parcel.DistributedCSR
20.3
DistributedCSR.from_scipy() / DistributedCSR.from_global()
20.4
DistributedCSR.local_slice()
20.5
parcel.solve()
20.6
parcel.eigs()
20.7
parcel.SolveInfo / parcel.EigInfo
20.8
parcel.Comm
20.9
parcel.partition_rows()
20.10
parcel.build_info() / parcel.has_mpi() / parcel.device_name()
20.11
parcel.__version__ / parcel.library_version()
20.12
Exceptions
Function Index →
C++
C
Fortran
Python
PARCEL SYCL v1.2 API Reference
Specifications of the public classes and functions (per function).
Contents
Function Index
1
Common Items
1.1
Format of the Entries
1.2
Solvers
1.3
Symbols and Terms
1.4
Input Matrix
1.5
Settings
1.6
Constants
1.7
Results
1.8
Convergence Status
1.9
Settings and MPI
1.10
Precision
2
Convergence by Solver
2.1
pcg
2.2
pbicgstab
2.3
pgmres
2.4
pcagmres
2.5
pcagmres (Q Not Formed)
2.6
power
2.7
inverse_power
2.8
ks_arnoldi
3
PARCEL SYCL Classes
3.1
Mapping to the Common Items
4
PARCEL Data Types
5
parcel::comm
5.1
Constructor
5.2
mpi_rank() / mpi_size() / mpi_comm() / rank() / size()
6
parcel::matrix
6.1
Constructor
6.2
set_crsMat()
6.3
n_local()
7
parcel::vector
7.1
Constructor / resize()
7.2
queue() / size()
7.3
setValue()
7.4
setValue_hi() / setValue_lo()
7.5
getValue()
7.6
getValue_hi() / getValue_lo()
7.7
data() / data_hi() / data_lo()
8
Items Common to All Solvers
8.1
Class Template Arguments (Arithmetic Precision)
8.2
Template Arguments of solver() (Data Precision)
8.3
Handling of Settings and Exceptions
8.4
Constants
9
Common Member Functions
9.1
set_tolerance() / get_tolerance()
9.2
set_max_iteration() / get_max_iteration()
9.3
set_precon_algo() / get_precon_algo()
9.4
set_jacobi() / get_jacobi()
9.5
set_blockjacobi() / get_blockjacobi()
9.6
set_scaling_matrix() / set_scaling_vector() / get_scaling_matrix() / get_scaling_vector()
9.7
get_converged_reason()
9.8
is_converged()
9.9
get_iterations()
9.10
get_residual()
9.11
get_true_residual()
9.12
converged_reason_name()
9.13
version_string() / get_version() / PARCEL_VERSION_*
10
Member Functions Common to the Eigenvalue Solvers
10.1
set_precon_spectrum() / get_precon_spectrum()
10.2
set_linsolve_algo() / get_linsolve_algo()
10.3
set_linsolve_tolerance() / get_linsolve_tolerance()
10.4
set_linsolve_max_iteration() / get_linsolve_max_iteration()
10.5
set_linsolve_restart() / get_linsolve_restart()
10.6
set_linsolve_precon_algo() / set_linsolve_blockjacobi() / set_linsolve_jacobi() / get_linsolve_precon_param()
10.7
set_linsolve_scaling_matrix() / set_linsolve_scaling_vector()
10.8
get_linsolve_failures()
11
parcel::krylov::pcg
11.1
pcg (class)
11.2
solver()
12
parcel::krylov::pbicgstab
12.1
pbicgstab (class)
12.2
solver()
13
parcel::krylov::pgmres
13.1
pgmres (class)
13.2
solver()
13.3
set_restart() / get_restart()
13.4
set_qr_algo() / get_qr_algo()
13.5
set_precon_space_output() / get_precon_space_output()
13.6
set_shift() / get_shift()
14
parcel::krylov::pcagmres
14.1
pcagmres (class)
14.2
solver()
14.3
set_restart() / get_restart_s() / get_restart_t()
14.4
set_qr_algo() / get_qr_algo()
14.5
set_explicit_q() / get_explicit_q()
14.6
CAGMRES_Q_IMPLICIT (without forming Q)
15
parcel::krylov::power
15.1
power (class)
15.2
solver()
16
parcel::krylov::inverse_power
16.1
inverse_power (class)
16.2
solver()
17
parcel::krylov::ks_arnoldi
17.1
ks_arnoldi (class)
17.2
solver()
17.3
set_ks_subspace() / get_ks_m() / get_ks_k_keep() / get_ks_nev()
17.4
set_ks_max_restart() / get_ks_max_restart()
17.5
set_qr_algo() / get_qr_algo()
17.6
set_shift() / disable_shift()
17.7
get_ks_nconv()
17.8
set_shift_linsolve_tolerance() / set_shift_linsolve_max_iteration() / set_shift_linsolve_restart() (deprecated)
18
C API
18.1
Mapping to the Common Items
18.2
Constants
18.3
parcel_options
18.4
parcel_result
18.5
parcel_options_init()
18.6
parcel_solver_from_name()
18.7
parcel_eigen_count()
18.8
parcel_solve_linear()
18.9
parcel_solve_eigen()
18.10
parcel_options_size() / parcel_result_size()
18.11
parcel_get_version() / parcel_version_string()
18.12
run_parcel_sycl_c() (deprecated)
19
Fortran API
19.1
Mapping to the Common Items
19.2
Constants
19.3
parcel_options / parcel_result
19.4
parcel_options_init
19.5
parcel_solve_linear
19.6
parcel_solve_eigen
19.7
parcel_eigen_count
19.8
parcel_options_check() / parcel_result_check()
19.9
parcel_options_size() / parcel_result_size()
19.10
parcel_get_version / parcel_version_string
19.11
run_parcel_sycl_f() (deprecated)
20
Python API
20.1
Mapping to the Common Items
20.2
parcel.DistributedCSR
20.3
DistributedCSR.from_scipy() / DistributedCSR.from_global()
20.4
DistributedCSR.local_slice()
20.5
parcel.solve()
20.6
parcel.eigs()
20.7
parcel.SolveInfo / parcel.EigInfo
20.8
parcel.Comm
20.9
parcel.partition_rows()
20.10
parcel.build_info() / parcel.has_mpi() / parcel.device_name()
20.11
parcel.__version__ / parcel.library_version()
20.12
Exceptions
Function Index →