PARCEL SYCL v1.2 / API Reference User Guide API Reference Search Download 日本語

3 PARCEL SYCL Classes

This part presents the C++ API. This chapter and the following ones up to parcel::krylov::ks_arnoldi are the C++ chapters. Items that do not depend on the language (meaning and defaults of the settings, meaning of the constants, results, convergence states, handling under MPI) are given in Common Items and Convergence by Solver; the C++ chapters give the names, declarations, exceptions and the choice of precision in C++. Each entry has the fields described in Format of the Entries, and the Synopsis field gives the C++ declaration (including the default values of template arguments).

All classes belong to the namespace parcel, and the solvers belong to parcel::krylov (the aliases of the data types are in the global namespace; PARCEL Data Types). Including the header file Include/parcel_sycl.hpp makes all classes available. Public members not described in this reference (parcel::comm::setQueue(), barrier(), parcel::matrix::queue(), comm(), default constructors, *_is_set() of precon_param, etc.) are for internal use.

The setting functions and the entry of solver() check the main values and throw std::invalid_argument on violation. The Requirements field gives the type of the exception thrown. The checked values and the exceptions are listed in “Handling of Settings and Exceptions”.

3.1 Mapping to the Common Items

The settings of Common Items correspond to the C++ setting functions as follows. The defaults and meanings are those of the common items.

Common result C++ function
Convergence state get_converged_reason(), is_converged(), converged_reason_name()
Iteration count get_iterations()
Residual get_residual()
True residual get_true_residual()
Number of converged eigenpairs get_ks_nconv()
Number of inner solver failures get_linsolve_failures()

The C++ names of the common constants are given in Constants. Features available only in C++ and not in the common items are the choice of precision (PARCEL Data Types, template arguments) and the mode of pgmres that returns the solution in the preconditioned space.